IlvStIPropertyListEditor Class Reference

Inspector class. More...

#include <ivstudio/inspectors/listedt.h>

Inheritance diagram for IlvStIPropertyListEditor:

Public Member Functions
	IlvStIPropertyListEditor (IlvStIPropertyListAccessor *accessor=0, const char *name=0)
	Initializes a new instance of IlvStIPropertyListEditor. More...
virtual IlBoolean	connectHolder (IlvGraphicHolder *)
	Connects the specified holder with the editor. More...
void	declareGadgets (const char *listName, const char *addAfterName=0, const char *removeName=0, const char *addBeforeName=0, const char *cleanName=0, const char *moveUpName=0, const char *moveDownName=0)
	Declares the gadgets name to be used by the editor. More...
virtual void	empty ()
	Empties the editor. More...
IlvListGadgetItemHolder *	getListGadgetItemHolder () const
	Returns the list gadget used by 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...
virtual void	setState (State=Active, IlBoolean=IlTrue)
	Sets the state of the editor. More...

Protected Member Functions
virtual IlvGadgetItem *	createGadgetItem (const IlvStIProperty *property) const
	Creates a 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...

Detailed Description

Inspector class.

Library: ivstudio

This class defines a list editor. It handles a number of gadgets that are used when editing a list. These gadgets are the following:

• A list gadget, showing the list that is being edited.
• A button that adds an item after the current selection when pressed.
• A button that inserts an item before the current selection when pressed.
• A button that removes the current selection when pressed.
• A button that cleans the edited list.

The use of these various gadgets causes the methods of the class IlvStIPropertyListAccessor to be called.

See also

IlvStIPropertyListAccessor.

Constructor & Destructor Documentation

IlvStIPropertyListEditor()

IlvStIPropertyListEditor::IlvStIPropertyListEditor	(	IlvStIPropertyListAccessor *	accessor = 0,
		const char *	name = 0
	)

Initializes a new instance of IlvStIPropertyListEditor.

Parameters

accessor	The list accessor.
name	The editor name.

Member Function Documentation

connectHolder()

virtual IlBoolean IlvStIPropertyListEditor::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

holder

The holder.

Returns

IlTrue if the operation succeeds otherwise returns IlFalse.

Reimplemented from IlvStIPropertiesEditor.

createGadgetItem()

virtual IlvGadgetItem* IlvStIPropertyListEditor::createGadgetItem ( const IlvStIProperty *  property ) const

protectedvirtual

Creates a gadget item that corresponds to the property.

Parameters

property

The property.

Returns

The gadget item.

declareGadgets()

void IlvStIPropertyListEditor::declareGadgets	(	const char *	listName,
		const char *	addAfterName = 0,
		const char *	removeName = 0,
		const char *	addBeforeName = 0,
		const char *	cleanName = 0,
		const char *	moveUpName = 0,
		const char *	moveDownName = 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 list.

Parameters

listName	The name of the gadget, which can be of the following types: IlvStringList, IlvOptionMenu, IlvComboBox, and so on.
addAfterName	The name of the button used to add an item.
removeName	The name of the button used to remove an item.
addBeforeName	The name of the button used to insert an item.
cleanName	The name of the button used to clean the list.
moveUpName	The name of the button used to move up the seleted item.
moveDownName	The name of the button used to move down the seleted item.

empty()

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

fillGadget()

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

getListGadgetItemHolder()

IlvListGadgetItemHolder* IlvStIPropertyListEditor::getListGadgetItemHolder

(

)

const

Returns the list gadget used by the editor.

Returns

The list gadget used by the editor.

refreshSelection()

virtual void IlvStIPropertyListEditor::refreshSelection ( )

protectedvirtual

Rebuilds the selected gadget item.

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

Implements IlvStIPropertiesEditor.