IlvStIPropertyEditorSet Class Reference

Inspector class. More...

#include <ivstudio/inspectors/genedt.h>

Inheritance diagram for IlvStIPropertyEditorSet:

Public Member Functions
	IlvStIPropertyEditorSet (const char *name=0, IlvStIPropertyAccessor *accessor=0, NotificationMode mode=AsOwner)
	Initializes an instance of IlvStIPropertyEditorSet. More...
virtual IlvStIPropertyAccessor *	getAccessor () const
	Returns the accessor associated with the editor. More...
virtual IlBoolean	initialize ()
	Initializes the editor. More...
IlBoolean	isModified () const
	Returns IlTrue if the editor is modified. More...
Public Member Functions inherited from IlvStIEditorSet
	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	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...
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
enum	NotificationMode { AsOwner, Default, Immediate }
	This enumeration type specifies when the editor notifies an accessor about a user modification. More...
enum	State { Active, Unactive, Unsensitive }
	This enumeration type defines the editor state. More...
Protected Member Functions inherited from IlvStIEditor
	IlvStIEditor (const char *name=0, NotificationMode mode=AsOwner)
	Constructor from a name and a notification mode. More...

Detailed Description

Inspector class.

Library: ivstudio

This class defines an editor set that contains an accessor. It locks the accessor in the constructor and unlocks it in the destructor.

See also

IlvStIDefaultEditorBuilder, IlvStIMainEditor.

Constructor & Destructor Documentation

IlvStIPropertyEditorSet()

IlvStIPropertyEditorSet::IlvStIPropertyEditorSet	(	const char *	name = 0,
		IlvStIPropertyAccessor *	accessor = 0,
		NotificationMode	mode = AsOwner
	)

Initializes an instance of IlvStIPropertyEditorSet.

Parameters

name	The name of the editor set.
accessor	The accessor managed by the editor.
mode	The notification mode of the editor.

Member Function Documentation

getAccessor()

virtual IlvStIPropertyAccessor* IlvStIPropertyEditorSet::getAccessor ( ) const

virtual

Returns the accessor associated with the editor.

Returns

The accessor associated with the editor, if any. By default, it returns 0. When the editor is added to the inspector panel, this latter calls this method to know whether the editor is associated with an accessor. If it is, the editor is initialized via the associated accessor. Otherwise, the stand-alone editor is initialized by the inspector panel and its apply() method is invoked to apply the changes.

Reimplemented from IlvStIEditor.

initialize()

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

Reimplemented from IlvStIEditorSet.

Reimplemented in IlvStIDefaultEditorBuilder.

isModified()

IlBoolean IlvStIPropertyEditorSet::isModified ( ) const

virtual

Returns IlTrue if the editor is modified.

Returns

IlTrue if the editor is modified, IlFalse otherwise. By default, it returns the modification state of the associated accessor.

Reimplemented from IlvStIEditorSet.