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
IlvStIPropertiesEditor Class Referenceabstract

Inspector class. More...

#include <ivstudio/inspectors/listedt.h>

Inheritance diagram for IlvStIPropertiesEditor:
IlvStIPropertyListEditor IlvStIPropertyTreeEditor

Public Member Functions

 IlvStIPropertiesEditor (IlvStIPropertiesAccessor *accessor=0, const char *name=0)
 Initializes a new instance of IlvStIPropertiesEditor. More...
 
virtual IlBoolean connectHolder (IlvGraphicHolder *)
 Connects the specified holder with the editor. More...
 
virtual IlBoolean initialize ()
 Initializes the editor. More...
 
virtual void setModified (IlBoolean=IlTrue)
 Sets the modification state of the editor. More...
 
virtual void setState (State=Active, IlBoolean=IlTrue)
 Sets the state of the editor. More...
 

Protected Member Functions

virtual void fillGadget ()=0
 Called when the editor is initialized to fill the gadget. More...
 
virtual void refreshSelection ()=0
 Rebuilds the selected gadget item. More...
 

Detailed Description

Inspector class.

Library: ivstudio

This class defines an editor for a set of several gadgets.

See also
IlvStIPropertiesAccessor.

Constructor & Destructor Documentation

IlvStIPropertiesEditor::IlvStIPropertiesEditor ( IlvStIPropertiesAccessor accessor = 0,
const char *  name = 0 
)

Initializes a new instance of IlvStIPropertiesEditor.

Parameters
accessorThe accessor for the set.
nameThe editor name.

Member Function Documentation

virtual IlBoolean IlvStIPropertiesEditor::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 IlvStIEditor.

Reimplemented in IlvStIPropertyTreeEditor, and IlvStIPropertyListEditor.

virtual void IlvStIPropertiesEditor::fillGadget ( )
protectedpure virtual

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

Implemented in IlvStIPropertyTreeEditor, and IlvStIPropertyListEditor.

virtual IlBoolean IlvStIPropertiesEditor::initialize ( )
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.

Returns
IlTrue if the operation succeeds otherwise returns IlFalse.

Implements IlvStIEditor.

virtual void IlvStIPropertiesEditor::refreshSelection ( )
protectedpure virtual

Rebuilds the selected gadget item.

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

Implemented in IlvStIPropertyTreeEditor, and IlvStIPropertyListEditor.

virtual void IlvStIPropertiesEditor::setModified ( IlBoolean  modified = IlTrue)
virtual

Sets the modification state of the editor.

Sets the modification state of the editor. By default, it sets the modification state of the associated accessor.

Parameters
modifiedThe new modification state of the editor.

Reimplemented from IlvStIEditor.

virtual void IlvStIPropertiesEditor::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 IlvStIEditor.

Reimplemented in IlvStIPropertyTreeEditor.


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