Rogue Wave Views
Studio Package API Reference Guide
Product Documentation:

Rogue Wave Views
Documentation Home
List of all members | Public Member Functions | Protected Member Functions
IlvStIPropertyTreeEditor Class Reference

Inspector class. More...

#include <ivstudio/inspectors/listedt.h>

Inheritance diagram for IlvStIPropertyTreeEditor:
IlvStIPropertiesEditor

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

Detailed Description

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.

See also
IlvStIPropertyTreeAccessor.

Constructor & Destructor Documentation

IlvStIPropertyTreeEditor::IlvStIPropertyTreeEditor ( IlvStIPropertyTreeAccessor accessor = 0,
const char *  name = 0 
)

Initializes a new instance of IlvStIPropertyTreeEditor.

Parameters
accessorThe tree accessor.
nameThe editor name.

Member Function Documentation

virtual IlBoolean IlvStIPropertyTreeEditor::connectHolder ( IlvGraphicHolder holder)
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.

Parameters
holderThe holder.
Returns
IlTrue if the operation succeeds otherwise returns IlFalse.

Reimplemented from IlvStIPropertiesEditor.

virtual IlvGadgetItem* IlvStIPropertyTreeEditor::createGadgetItem ( const IlvStIProperty property) const
protectedvirtual

Creates a tree gadget item that corresponds to the property.

Parameters
propertyThe property.
Returns
The tree item gadget.
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.

Parameters
treeNameThe name of the tree gadget.
addAfterNameThe name of the button used to add an item.
removeNameThe name of the button used to remove an item.
addChildNameThe name of the button used to add a child tree item.
addBeforeNameThe name of the button used to insert an item.
cleanNameThe name of the button used to clean the list.
virtual void IlvStIPropertyTreeEditor::empty ( )
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.

virtual void IlvStIPropertyTreeEditor::fillGadget ( )
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.

Returns
The tree gadget used by the editor.
virtual void IlvStIPropertyTreeEditor::refreshSelection ( )
protectedvirtual

Rebuilds the selected gadget item.

Rebuilds the selected gadget item to reflect modifications made to the accessor.

Implements IlvStIPropertiesEditor.

virtual void IlvStIPropertyTreeEditor::setState ( State  state = Active,
IlBoolean  redraw = IlTrue 
)
virtual

Sets the state of the editor.

Parameters
stateThe new state.
redrawIf IlTrue, the editor will be redrawn.

Reimplemented from IlvStIPropertiesEditor.

virtual void IlvStIPropertyTreeEditor::treeItemSelected ( IlvTreeGadgetItem *  item,
const IlvStIProperty property,
const IlvStIProperty parent 
)
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.

Parameters
itemThe tree gadget item that is selected.
propertyThe property that corresponds to the tree gadget item.
parentThe 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.