Rogue Wave Views Studio Package API Reference Guide |
Rogue Wave Views Documentation Home |
Inspector class. More...
#include <ivstudio/inspectors/genedt.h>
Public Member Functions | |
IlvStIEditorSet (const char *name=0, NotificationMode mode=AsOwner) | |
Initializes an instance of IlvStIEditorSet . More... | |
virtual void | addEditor (IlvStIEditor *editor) |
Adds the editor to the list of editors. More... | |
virtual IlBoolean | connectHolder (IlvGraphicHolder *holder) |
Connects the specified holder with the editor. More... | |
virtual void | empty () |
Empties the editor. More... | |
IlvStIEditor *const * | getEditors (IlUInt &count) const |
Returns the editors that the editor contains. More... | |
virtual IlBoolean | initialize () |
Initializes the editor. More... | |
virtual IlBoolean | isModified () const |
Returns IlTrue if the editor is modified. More... | |
virtual IlBoolean | isVisible () const |
Returns the editor visibility. More... | |
IlvStIEditor * | link (const char *gadgetName, IlvStIPropertyAccessor *graphicAccessor, const IlSymbol *valueName, IlvStIEditor::NotificationMode mode=IlvStIEditor::AsOwner) |
Creates an editor which is associated with a gadget. More... | |
IlvStIEditor * | link (const char *gadgetName, IlvStIPropertyAccessor *accessor, IlvStIEditor::NotificationMode mode=IlvStIEditor::AsOwner) |
Creates an editor which is associated with a gadget. More... | |
virtual IlBoolean | removeEditor (const char *name, IlBoolean del=IlTrue) |
Removes the editor from the list of editors. More... | |
virtual IlBoolean | removeEditor (IlvStIEditor *editor, IlBoolean del=IlTrue) |
Removes the editor from the list of editors. More... | |
virtual void | setFocus (IlBoolean bFocus=IlTrue) |
Sets the focus on the editor. More... | |
virtual void | setState (State=Active, IlBoolean bRedraw=IlTrue) |
Sets the state of the editor. More... | |
virtual void | setVisible (IlBoolean=IlTrue) |
Sets the editor as visible. More... | |
Public Member Functions inherited from IlvStIEditor | |
void | addProperty (const IlSymbol *name, IlAny property) |
Adds a property to a properties list. More... | |
const IlvStIEditor * | findEditor (const char *name) const |
Searches an editor in the editors tree that are owned by this editor. More... | |
IlvStIEditor * | findEditor (const char *name) |
Searches an editor in the editors tree that are owned by this editor. More... | |
virtual IlvStIPropertyAccessor * | getAccessor () const |
Returns the accessor associated with the editor. More... | |
NotificationMode | getNotificationMode () const |
Returns the notification mode of the editor. More... | |
IlvStIEditor * | getOwner () const |
Returns the owner of the editor. More... | |
IlAny * | getProperties (const IlSymbol *name, IlUInt &count) const |
Returns an array of properties. More... | |
IlAny | getProperty (const IlSymbol *name) const |
Returns a property. More... | |
IlBoolean | removeProperties (const IlSymbol *name) |
Removes some properties. More... | |
virtual void | setModified (IlBoolean modified=IlTrue) |
Sets the modification state of the editor. More... | |
void | setNotificationMode (NotificationMode mode) |
Sets the notification mode of the editor. More... | |
void | setOwner (IlvStIEditor *editor) |
Sets the owner of the editor. More... | |
void | setProperty (const IlSymbol *name, IlAny property) |
Replaces all the properties by another property. More... | |
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... | |
Additional Inherited Members | |
Public Types inherited from IlvStIEditor | |
Protected Member Functions inherited from IlvStIEditor | |
IlvStIEditor (const char *name=0, NotificationMode mode=AsOwner) | |
Constructor from a name and a notification mode. More... | |
Inspector class.
Library: ivstudio
This class defines an editor that contains a set of editors.
IlvStIEditor
IlvStIEditorSet::IlvStIEditorSet | ( | const char * | name = 0 , |
NotificationMode | mode = AsOwner |
||
) |
Initializes an instance of IlvStIEditorSet
.
name | The identifier of the editor. Using this name, an inspector can retrieve an editor and set the focus to it. |
mode | The notification mode of the editor. |
|
virtual |
Adds the editor to the list of editors.
editor | The editor. |
Reimplemented in IlvStIMainEditor.
|
virtual |
Connects the specified holder with the editor.
Connects the specified holder with the editor. For example, a gadget editor finds the gadget inside the holder and adds a callback to it.
holder | The holder. |
IlTrue
if the operation succeeds otherwise returns IlFalse
. Reimplemented from IlvStIEditor.
Reimplemented in IlvStIDefaultEditorBuilder, and IlvStIMainEditor.
|
virtual |
Empties the editor.
It is called when the editor cannot be initialized with a value. For example, in the case of a list editor, the list is cleared.
Reimplemented from IlvStIEditor.
IlvStIEditor* const* IlvStIEditorSet::getEditors | ( | IlUInt & | count | ) | const |
Returns the editors that the editor contains.
count | Contains the editor count. |
|
virtual |
Initializes the editor.
In the case of gadget editors, this method gets an initialization value from the accessor and sets this value to the gadget.
IlTrue
if the operation succeeds otherwise returns IlFalse
. Implements IlvStIEditor.
Reimplemented in IlvStIDefaultEditorBuilder, IlvStIPropertyEditorSet, and IlvStIMainEditor.
|
virtual |
Returns IlTrue
if the editor is modified.
IlTrue
if the editor is modified, IlFalse
otherwise. By default, it returns the modification state of the associated accessor. Reimplemented from IlvStIEditor.
Reimplemented in IlvStIPropertyEditorSet, and IlvStIMainEditor.
|
virtual |
Returns the editor visibility.
IlTrue
if the editor is visible, IlFalse
otherwise. For example, a gadget editor returns the visible state of the associated gadget. Reimplemented from IlvStIEditor.
IlvStIEditor* IlvStIEditorSet::link | ( | const char * | gadgetName, |
IlvStIPropertyAccessor * | graphicAccessor, | ||
const IlSymbol * | valueName, | ||
IlvStIEditor::NotificationMode | mode = IlvStIEditor::AsOwner |
||
) |
Creates an editor which is associated with a gadget.
Creates an editor with the notification mode specified and associates it with a gadget. It also creates an accessor that accesses the property of the graphic object, and adds the created editor to the created accessor. For example, to link a toggle gadget named "toggle"
to the frame property of a button returned by an accessor, type the following:
The toggle is initialized with the value of the _viewFrame
property of the object. When the toggle is modified, it notifies the accessor of this change automatically.
gadgetName | The gadget name. |
graphicAccessor | The accessor to access to graphic object. |
valueName | The property name of the graphic object. |
mode | The notification mode of the editor. |
IlvStIEditor* IlvStIEditorSet::link | ( | const char * | gadgetName, |
IlvStIPropertyAccessor * | accessor, | ||
IlvStIEditor::NotificationMode | mode = IlvStIEditor::AsOwner |
||
) |
Creates an editor which is associated with a gadget.
Creates an editor with the notification mode specified and associates it with the gadget. Then it adds the created editor to the specified accessor. For example, to link a text field gadget named "textField"
to an object name returned by an accessor, type the following:
The text field is initialized with the value returned by the accessor. When the text field is modified, it notifies the accessor of this change automatically.
gadgetName | The gadget name. |
accessor | The accessor to access to graphic object. |
mode | The notification mode of the editor. |
|
virtual |
Removes the editor from the list of editors.
name | The editor name which is removed from the list of editors. |
del | If IlTrue , the found editor is deleted. |
IlTrue
if successfull.
|
virtual |
Removes the editor from the list of editors.
editor | The editor which is removed from the list of editors. |
del | If IlTrue , the found editor is deleted. |
IlTrue
if successfull. Sets the focus on the editor.
Sets the focus on the editor. For example, a gadget editor will set the focus on the associated gadget.
focus | If IlTrue the editor get the focus. |
Reimplemented from IlvStIEditor.
Sets the state of the editor.
state | The new state. |
redraw | If IlTrue , the editor will be redrawn. |
Reimplemented from IlvStIEditor.
Sets the editor as visible.
Sets the editor as visible. For example, a gadget editor will set the associated gadget as visible.
visible | If IlTrue the editor becomes visible. |
Reimplemented from IlvStIEditor.
© 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.