rwlogo

Rogue Wave Views
Studio Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

 All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros
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
 

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

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

Short Called to execute the command.

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

Implemented in IlvStShowPanel, IlvStSetMode, and IlvStClickAddObject.


© Copyright 2015, Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave is a registered trademark of Rogue Wave Software, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.