Rogue Wave Views Studio Package API Reference Guide |
Rogue Wave Views Documentation Home |
Editing mode class. More...
#include <ivstudio/mode.h>
Public Member Functions | |
IlvStMode (IlvStudio *editor, const char *name, const char *cmdname, IlvManagerViewInteractor *inter, IlBoolean inspectable=IlTrue, IlBoolean editable=IlTrue) | |
Initializes an instance of IlvStMode . More... | |
const char * | getCommandName () const |
Returns the command name. More... | |
IlvStudio * | getEditor () const |
Returns the Rogue Wave Views Studio editor. More... | |
IlvManagerViewInteractor * | getInteractor () const |
Returns the interactor that is encapsulated. More... | |
virtual IlBoolean | isDefault () const |
Returns IlTrue if the mode is a default mode. More... | |
IlBoolean | isEditable () const |
Returns IlTrue if the mode is editable. More... | |
IlBoolean | isInspectable () const |
Returns IlTrue if the mode is inspectable. More... | |
virtual void | selected () |
Called when the mode is selected. | |
virtual void | unSelected () |
Called when the mode is deselected. | |
Public Member Functions inherited from IlvStNamedObject | |
const char * | getName () const |
Returns the name of the object. More... | |
virtual void | setName (const char *name) |
Sets the name of the object. More... | |
Editing mode class.
Library: ivstudio
An editing mode is an IlvStMode
object that encapsulates an object of type IlvManagerViewInteractor
.
Once the editing mode has been created, you can associate it with a bitmap and add it to the toolbar to the left of the Main Window of Rogue Wave Views Studio.
IlvStMode::IlvStMode | ( | IlvStudio * | editor, |
const char * | name, | ||
const char * | cmdname, | ||
IlvManagerViewInteractor * | inter, | ||
IlBoolean | inspectable = IlTrue , |
||
IlBoolean | editable = IlTrue |
||
) |
Initializes an instance of IlvStMode
.
editor | The Rogue Wave Views Studio editor. |
name | The name of the mode. Give a name that is not already being use. This name lets you get the mode back from the Rogue Wave Views Studio mode delegate. |
cmdname | The name of the command that selects the mode. In Rogue Wave Views Studio, the command that selects the mode Xxx is called SelectXxxMode . The state of this command is set or unset when the mode is selected or deselected. |
inter | The interactor that the mode encapsulates. |
inspectable | Specifies whether the inspector panel can be called when the mode is selected. |
editable | Specifies whether editing commands, such as the command to delete an object, are allowed or not. |
const char* IlvStMode::getCommandName | ( | ) | const |
Returns the command name.
IlvStudio* IlvStMode::getEditor | ( | ) | const |
Returns the Rogue Wave Views Studio editor.
IlvManagerViewInteractor* IlvStMode::getInteractor | ( | ) | const |
Returns the interactor that is encapsulated.
|
virtual |
Returns IlTrue
if the mode is a default mode.
IlTrue
if the mode is a default mode. By default this function returns IlFalse
. IlBoolean IlvStMode::isEditable | ( | ) | const |
Returns IlTrue
if the mode is editable.
IlTrue
if the mode is editable. A mode is editable if the editing commands (for example: delete an object) are allowed when the mode is selected. IlBoolean IlvStMode::isInspectable | ( | ) | const |
Returns IlTrue
if the mode is inspectable.
IlTrue
if the mode is inspectable. A mode is inspectable if the objects can be inspected when the mode is selected. © Copyright 2016, 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.