rwlogo
Rogue Wave Views 5.6

Rogue Wave Views
Studio Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

List of all members | Public Member Functions
IlvStMode Class Reference

Editing mode class. More...

#include <ivstudio/mode.h>

Inheritance diagram for IlvStMode:
IlvStNamedObject

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...
 
IlvStudiogetEditor () 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...
 

Detailed Description

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.

See Also
IlvStudio,IlvStModes.

Constructor & Destructor Documentation

IlvStMode::IlvStMode ( IlvStudio editor,
const char *  name,
const char *  cmdname,
IlvManagerViewInteractor *  inter,
IlBoolean  inspectable = IlTrue,
IlBoolean  editable = IlTrue 
)

Initializes an instance of IlvStMode.

Parameters
editorThe Rogue Wave Views Studio editor.
nameThe 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.
cmdnameThe 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.
interThe interactor that the mode encapsulates.
inspectableSpecifies whether the inspector panel can be called when the mode is selected.
editableSpecifies whether editing commands, such as the command to delete an object, are allowed or not.

Member Function Documentation

const char* IlvStMode::getCommandName ( ) const

Returns the command name.

Returns
The name of the command that is called to select the mode.
IlvStudio* IlvStMode::getEditor ( ) const

Returns the Rogue Wave Views Studio editor.

Returns
The Rogue Wave Views Studio editor.
IlvManagerViewInteractor* IlvStMode::getInteractor ( ) const

Returns the interactor that is encapsulated.

Returns
The interactor that is encapsulated.
virtual IlBoolean IlvStMode::isDefault ( ) const
virtual

Returns IlTrue if the mode is a default mode.

Returns
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.

Returns
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.

Returns
IlTrue if the mode is inspectable. A mode is inspectable if the objects can be inspected when the mode is selected.

© 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.