Views
Studio Package API Reference Guide
Product Documentation:
Views Documentation Home
List of all members | Public Member Functions
IlvStCommand Class Referenceabstract

Command class. More...

#include <ivstudio/command.h>

Inheritance diagram for IlvStCommand:
IlvStClickAddObject IlvStSetMode IlvStShowPanel

Public Member Functions

virtual IlvStErrordoIt (IlvStudio *editor, IlAny arg)=0
 Executes the command. More...
 

Detailed Description

Command class.

Library: ivstudio

This class is used to define the code of a Rogue Wave Views Studio command.

The command description (label, prompt, and so on) must be included in a command file (.cmd), the predefined commands are declared in studio.cmd.

See also
IlvStudio,IlvStError.

Member Function Documentation

◆ doIt()

virtual IlvStError* IlvStCommand::doIt ( IlvStudio editor,
IlAny  arg 
)
pure virtual

Executes the command.

Parameters
editorThe editor which calls the command.
argInternal use.
Returns
null if successful, otherwise returns an instance of IlvStError.

Implemented in IlvStSetMode, IlvStShowPanel, and IlvStClickAddObject.