IlvStIDefaultEditorBuilder Class Reference

Inspector class. More...

#include <ivstudio/inspectors/genedt.h>

Inheritance diagram for IlvStIDefaultEditorBuilder:

Public Member Functions
	IlvStIDefaultEditorBuilder (const char *name=0, IlvStIPropertyAccessor *accessor=0, NotificationMode mode=AsOwner)
	Constructor. More...
virtual IlBoolean	connectHolder (IlvGraphicHolder *holder)
	Connects the specified holder with the editor. More...
virtual IlBoolean	initialize ()
	Initializes the editor. More...
Public Member Functions inherited from IlvStIPropertyEditorSet
	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...
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 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...

Protected Member Functions
virtual const char *	getGraphicName () const

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

Detailed Description

Inspector class.

Library: ivstudio

The class IlvStIDefaultEditorBuilder defines an editor that is associated with a gadget in a panel. When this editor initializes, it creates another editor whose type corresponds to the type of the associated gadget. For example, if the gadget is of type IlvTextField, the editor builder creates an editor that interfaces with text fields. The new editor is added as a child of the editor builder so that it is initialized when the editor builder is initialized.

See Also

IlvStIPropertyEditorSet.

Constructor & Destructor Documentation

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

Constructor.

Parameters

name	The gadget name with which the editor interfaces. The gadget does not have to be held directly by the inspector panel. For example, it can belong to any page of a notebook, or any container rectangle, inside the inspector panel.
accessor	The associated accessor. It provides the initial value used to initialize the editor and it is notified when the user modifies the editor.
mode	Determines when the accessor is notified.

Member Function Documentation

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

virtual const char* IlvStIDefaultEditorBuilder::getGraphicName ( ) const

protectedvirtual

Short Returns the name of the gadget with which the editor interfaces.

Returns

The name of the gadget with which the editor interfaces. By default, the name returned is the name of the editor.

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