IlvStIEditorSet Class Reference

Inspector class. More...

#include <ivstudio/inspectors/genedt.h>

Inheritance diagram for IlvStIEditorSet:

List of all members.

Public Member Functions
	IlvStIEditorSet (const char *name=0, NotificationMode mode=AsOwner)
	Initializes an instance of IlvStIEditorSet.
virtual void	addEditor (IlvStIEditor *editor)
	Adds the editor to the list of editors.
virtual IlBoolean	connectHolder (IlvGraphicHolder *holder)
	Connects the specified holder with the editor.
virtual void	empty ()
	Empties the editor.
IlvStIEditor *const *	getEditors (IlUInt &count) const
	Returns the editors that the editor contains.
virtual IlBoolean	initialize ()
	Initializes the editor.
virtual IlBoolean	isModified () const
	Returns IlTrue if the editor is modified.
virtual IlBoolean	isVisible () const
	Returns the editor visibility.
IlvStIEditor *	link (const char *gadgetName, IlvStIPropertyAccessor *accessor, IlvStIEditor::NotificationMode mode=IlvStIEditor::AsOwner)
	Creates an editor which is associated with a gadget.
IlvStIEditor *	link (const char *gadgetName, IlvStIPropertyAccessor *graphicAccessor, const IlSymbol *valueName, IlvStIEditor::NotificationMode mode=IlvStIEditor::AsOwner)
	Creates an editor which is associated with a gadget.
virtual IlBoolean	removeEditor (IlvStIEditor *editor, IlBoolean del=IlTrue)
	Removes the editor from the list of editors.
virtual IlBoolean	removeEditor (const char *name, IlBoolean del=IlTrue)
	Removes the editor from the list of editors.
virtual void	setFocus (IlBoolean bFocus=IlTrue)
	Sets the focus on the editor.
virtual void	setState (State=Active, IlBoolean bRedraw=IlTrue)
	Sets the state of the editor.
virtual void	setVisible (IlBoolean=IlTrue)
	Sets the editor as visible.

---

Detailed Description

Inspector class.

Library: ivstudio

This class defines an editor that contains a set of editors.

See also:

IlvStIEditor

---

Constructor & Destructor Documentation

IlvStIEditorSet::IlvStIEditorSet	(	const char *	name = 0,
		NotificationMode	mode = AsOwner
	)

Initializes an instance of IlvStIEditorSet.

Parameters:

	name	The identifier of the editor. Using this name, an inspector can retrieve an editor and set the focus to it.
	mode	The notification mode of the editor.

---

Member Function Documentation

virtual void IlvStIEditorSet::addEditor

(

IlvStIEditor *

editor

)

[virtual]

Adds the editor to the list of editors.

Parameters:

editor

The editor.

Reimplemented in IlvStIMainEditor.

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

Reimplemented in IlvStIDefaultEditorBuilder, and IlvStIMainEditor.

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

IlvStIEditor* const* IlvStIEditorSet::getEditors

(

IlUInt &

count

)

const

Returns the editors that the editor contains.

Parameters:

count

Contains the editor count.

Returns:

the editors that the editor contains.

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

Reimplemented in IlvStIPropertyEditorSet, IlvStIDefaultEditorBuilder, and IlvStIMainEditor.

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

Reimplemented in IlvStIPropertyEditorSet, and IlvStIMainEditor.

virtual IlBoolean IlvStIEditorSet::isVisible

(

)

const [virtual]

Returns the editor visibility.

Returns:

IlTrue if the editor is visible, IlFalse otherwise. For example, a gadget editor returns the visible state of the associated gadget.

Reimplemented from IlvStIEditor.

IlvStIEditor* IlvStIEditorSet::link	(	const char *	gadgetName,
		IlvStIPropertyAccessor *	accessor,
		IlvStIEditor::NotificationMode	mode = IlvStIEditor::AsOwner
	)

Creates an editor which is associated with a gadget.

Creates an editor with the notification mode specified and associates it with the gadget. Then it adds the created editor to the specified accessor. For example, to link a text field gadget named textField to an object name returned by an accessor, type the following:
link("textField", accessor);
The text field is initialized with the value returned by the accessor. When the text field is modified, it notifies the accessor of this change automatically.

Parameters:

	gadgetName	The gadget name.
	accessor	The accessor to access to graphic object.
	mode	The notification mode of the editor.

Returns:

The created editor.

IlvStIEditor* IlvStIEditorSet::link	(	const char *	gadgetName,
		IlvStIPropertyAccessor *	graphicAccessor,
		const IlSymbol *	valueName,
		IlvStIEditor::NotificationMode	mode = IlvStIEditor::AsOwner
	)

Creates an editor which is associated with a gadget.

Creates an editor with the notification mode specified and associates it with a gadget. It also creates an accessor that accesses the property of the graphic object, and adds the created editor to the created accessor. For example, to link a toggle gadget named toggle to the frame property of a button returned by an accessor, type the following:
link("toggle", accessor, IlvButton::_viewFrame);
The toggle is initialized with the value of the _viewFrame property of the object. When the toggle is modified, it notifies the accessor of this change automatically.

Parameters:

	gadgetName	The gadget name.
	graphicAccessor	The accessor to access to graphic object.
	valueName	The property name of the graphic object.
	mode	The notification mode of the editor.

Returns:

The created editor.

virtual IlBoolean IlvStIEditorSet::removeEditor	(	IlvStIEditor *	editor,
		IlBoolean	del = IlTrue
	)			[virtual]

Removes the editor from the list of editors.

Parameters:

	name	The editor which is removed from the list of editors.
	del	If IlTrue, the found editor is deleted.

Returns:

IlTrue if successfull.

virtual IlBoolean IlvStIEditorSet::removeEditor	(	const char *	name,
		IlBoolean	del = IlTrue
	)			[virtual]

Removes the editor from the list of editors.

Parameters:

	name	The editor name which is removed from the list of editors.
	del	If IlTrue, the found editor is deleted.

Returns:

IlTrue if successfull.

virtual void IlvStIEditorSet::setFocus

(

IlBoolean

focus = IlTrue

)

[virtual]

Sets the focus on the editor.

Sets the focus on the editor. For example, a gadget editor will set the focus on the associated gadget.

Parameters:

focus

If IlTrue the editor get the focus.

Reimplemented from IlvStIEditor.

virtual void IlvStIEditorSet::setState	(	State	state = Active,
		IlBoolean	redraw = IlTrue
	)			[virtual]

Sets the state of the editor.

Parameters:

	state	The new state.
	redraw	If IlTrue, the editor will be redrawn.

Reimplemented from IlvStIEditor.

virtual void IlvStIEditorSet::setVisible

(

IlBoolean

visible = IlTrue

)

[virtual]

Sets the editor as visible.

Sets the editor as visible. For example, a gadget editor will set the associated gadget as visible.

Parameters:

visible

If IlTrue the editor becomes visible.

Reimplemented from IlvStIEditor.