Rogue Wave Views Studio Package API Reference Guide |
Rogue Wave Views Documentation Home |
Inspector class. More...
#include <ivstudio/inspectors/listedt.h>
Public Member Functions | |
IlvStIPropertyTreeEditor (IlvStIPropertyTreeAccessor *accessor=0, const char *name=0) | |
Initializes a new instance of IlvStIPropertyTreeEditor . More... | |
virtual IlBoolean | connectHolder (IlvGraphicHolder *) |
Connects the specified holder with the editor. More... | |
void | declareGadgets (const char *treeName, const char *addAfterName=0, const char *removeName=0, const char *addChildName=0, const char *addBeforeName=0, const char *cleanName=0) |
Declares the gadgets name to be used by the editor. More... | |
virtual void | empty () |
Empties the editor. More... | |
IlvTreeGadget * | getTreeGadget () const |
Returns the tree gadget used by the editor. More... | |
virtual void | setState (State=Active, IlBoolean=IlTrue) |
Sets the state of the editor. More... | |
Public Member Functions inherited from IlvStIPropertiesEditor | |
IlvStIPropertiesEditor (IlvStIPropertiesAccessor *accessor=0, const char *name=0) | |
Initializes a new instance of IlvStIPropertiesEditor . More... | |
virtual IlBoolean | initialize () |
Initializes the editor. More... | |
virtual void | setModified (IlBoolean=IlTrue) |
Sets the modification state of the editor. More... | |
Protected Member Functions | |
virtual IlvGadgetItem * | createGadgetItem (const IlvStIProperty *property) const |
Creates a tree gadget item that corresponds to the property. More... | |
virtual void | fillGadget () |
Called when the editor is initialized to fill the gadget. More... | |
virtual void | refreshSelection () |
Rebuilds the selected gadget item. More... | |
virtual void | treeItemSelected (IlvTreeGadgetItem *item, const IlvStIProperty *property, const IlvStIProperty *parent) |
Called when the selection changes. More... | |
Inspector class.
Library: ivstudio
This class defines a tree editor. It handles a number of gadgets that are used when editing a tree. These gadgets are the following:
The use of these various gadgets causes the methods of the class IlvStIPropertyTreeAccessor
to be called.
IlvStIPropertyTreeAccessor
. IlvStIPropertyTreeEditor::IlvStIPropertyTreeEditor | ( | IlvStIPropertyTreeAccessor * | accessor = 0 , |
const char * | name = 0 |
||
) |
Initializes a new instance of IlvStIPropertyTreeEditor
.
accessor | The tree accessor. |
name | The editor name. |
|
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 IlvStIPropertiesEditor.
|
protectedvirtual |
Creates a tree gadget item that corresponds to the property.
property | The property. |
void IlvStIPropertyTreeEditor::declareGadgets | ( | const char * | treeName, |
const char * | addAfterName = 0 , |
||
const char * | removeName = 0 , |
||
const char * | addChildName = 0 , |
||
const char * | addBeforeName = 0 , |
||
const char * | cleanName = 0 |
||
) |
Declares the gadgets name to be used by the editor.
Declares the names of the various gadgets to be used by the editor to modify the tree.
treeName | The name of the tree gadget. |
addAfterName | The name of the button used to add an item. |
removeName | The name of the button used to remove an item. |
addChildName | The name of the button used to add a child tree item. |
addBeforeName | The name of the button used to insert an item. |
cleanName | The name of the button used to clean the list. |
|
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.
|
protectedvirtual |
Called when the editor is initialized to fill the gadget.
Is called when the editor is initialized to fill the list (or tree) gadget with items corresponding to the edited property list (or tree).
Implements IlvStIPropertiesEditor.
IlvTreeGadget* IlvStIPropertyTreeEditor::getTreeGadget | ( | ) | const |
Returns the tree gadget used by the editor.
|
protectedvirtual |
Rebuilds the selected gadget item.
Rebuilds the selected gadget item to reflect modifications made to the accessor.
Implements IlvStIPropertiesEditor.
|
virtual |
Sets the state of the editor.
state | The new state. |
redraw | If IlTrue , the editor will be redrawn. |
Reimplemented from IlvStIPropertiesEditor.
|
protectedvirtual |
Called when the selection changes.
For example, this method can be redefined to disable the button used to delete an item when the root of the tree is selected.
item | The tree gadget item that is selected. |
property | The property that corresponds to the tree gadget item. |
parent | The parent of the property that corresponds to the tree gadget item. |
© 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.