rwlogo
Rogue Wave Views 5.6

Rogue Wave Views
Studio Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

IlvStClickAddObject Class Reference

Command class. More...

#include <ivstudio/edit.h>

Inheritance diagram for IlvStClickAddObject:
IlvStCommand

List of all members.

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.

Detailed Description

Command class.

Library: ivstudio

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

See also:
IlvStudio,IlvStCommand.

Member Function Documentation

virtual IlvStError* IlvStClickAddObject::doIt ( IlvStudio editor,
IlAny  arg 
) [virtual]

Short Called to execute the command.

Parameters:
editor The editor which calls the command.
arg Internal Using.
Returns:
null if successful, otherwise returns an instance of IlvStError.

Implements IlvStCommand.

virtual IlvStError* IlvStClickAddObject::makeObject ( IlvGraphic *&  g,
IlvStudio editor,
IlAny  arg 
) [protected, pure virtual]

Returns the object which must be added.

Parameters:
g Contains the created object.
editor The editor which calls the command.
arg Internal using.
Returns:
null if successful, otherwise returns an instance of IlvStError.
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

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