Rogue Wave Views
Studio Package API Reference Guide
Product Documentation:

Rogue Wave Views
Documentation Home
List of all members | Public Member Functions | Protected Member Functions
IlvStClickAddObject Class Referenceabstract

Command class. More...

#include <ivstudio/edit.h>

Inheritance diagram for IlvStClickAddObject:
IlvStCommand

Public Member Functions

virtual IlvStErrordoIt (IlvStudio *, IlAny)
 

Protected Member Functions

virtual IlvStErrormakeObject (IlvGraphic *&g, IlvStudio *editor, IlAny arg)=0
 Returns the object which must be added. More...
 

Detailed Description

Command class.

Library: ivstudio

This class is used to define the code of a Rogue Wave Views Studio command which is used to add a new object to the current buffer.

See also
IlvStudio,IlvStCommand.

Member Function Documentation

§ doIt()

virtual IlvStError* IlvStClickAddObject::doIt ( IlvStudio editor,
IlAny  arg 
)
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.

Implements IlvStCommand.

§ makeObject()

virtual IlvStError* IlvStClickAddObject::makeObject ( IlvGraphic *&  g,
IlvStudio editor,
IlAny  arg 
)
protectedpure virtual

Returns the object which must be added.

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

© Copyright 2017, 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.