Views
Studio Package API Reference Guide
Product Documentation:
Views Documentation Home
List of all members | Public Member Functions
IlvStIEditorSet Class Reference

Inspector class. More...

#include <ivstudio/inspectors/genedt.h>

Inheritance diagram for IlvStIEditorSet:
IlvStIEditor IlvStNamedObject IlvStIMainEditor IlvStIPropertyEditorSet IlvStIDefaultEditorBuilder

Public Member Functions

 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 initialize ()
 Initializes the editor. More...
 
virtual IlBoolean isModified () const
 Returns IlTrue if the editor is modified. More...
 
virtual IlBoolean isVisible () const
 Returns the editor visibility. More...
 
IlvStIEditorlink (const char *gadgetName, IlvStIPropertyAccessor *accessor, IlvStIEditor::NotificationMode mode=IlvStIEditor::AsOwner)
 Creates an editor which is associated with a gadget. More...
 
IlvStIEditorlink (const char *gadgetName, IlvStIPropertyAccessor *graphicAccessor, const IlSymbol *valueName, 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...
 
IlvStIEditorfindEditor (const char *name)
 Searches an editor in the editors tree that are owned by this editor. More...
 
const IlvStIEditorfindEditor (const char *name) const
 Searches an editor in the editors tree that are owned by this editor. More...
 
virtual IlvStIPropertyAccessorgetAccessor () const
 Returns the accessor associated with the editor. More...
 
NotificationMode getNotificationMode () const
 Returns the notification mode of the editor. More...
 
IlvStIEditorgetOwner () const
 Returns the owner of the editor. More...
 
IlAnygetProperties (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 that contains a set of editors.

See also
IlvStIEditor

Constructor & Destructor Documentation

◆ IlvStIEditorSet()

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

Initializes an instance of IlvStIEditorSet.

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

Member Function Documentation

◆ addEditor()

virtual void IlvStIEditorSet::addEditor ( IlvStIEditor editor)
virtual

Adds the editor to the list of editors.

Parameters
editorThe editor.

Reimplemented in IlvStIMainEditor.

◆ connectHolder()

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
holderThe holder.
Returns
IlTrue if the operation succeeds otherwise returns IlFalse.

Reimplemented from IlvStIEditor.

Reimplemented in IlvStIDefaultEditorBuilder, and IlvStIMainEditor.

◆ empty()

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.

◆ getEditors()

IlvStIEditor* const* IlvStIEditorSet::getEditors ( IlUInt count) const

Returns the editors that the editor contains.

Parameters
countContains the editor count.
Returns
the editors that the editor contains.

◆ initialize()

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 IlvStIMainEditor, IlvStIDefaultEditorBuilder, and IlvStIPropertyEditorSet.

◆ isModified()

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 IlvStIMainEditor, and IlvStIPropertyEditorSet.

◆ isVisible()

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.

◆ link() [1/2]

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
gadgetNameThe gadget name.
accessorThe accessor to access to graphic object.
modeThe notification mode of the editor.
Returns
The created editor.

◆ link() [2/2]

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
gadgetNameThe gadget name.
graphicAccessorThe accessor to access to graphic object.
valueNameThe property name of the graphic object.
modeThe notification mode of the editor.
Returns
The created editor.

◆ removeEditor() [1/2]

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

Removes the editor from the list of editors.

Parameters
nameThe editor name which is removed from the list of editors.
delIf IlTrue, the found editor is deleted.
Returns
IlTrue if successfull.

◆ removeEditor() [2/2]

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

Removes the editor from the list of editors.

Parameters
editorThe editor which is removed from the list of editors.
delIf IlTrue, the found editor is deleted.
Returns
IlTrue if successfull.

◆ setFocus()

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
focusIf IlTrue the editor get the focus.

Reimplemented from IlvStIEditor.

◆ setState()

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

◆ setVisible()

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
visibleIf IlTrue the editor becomes visible.

Reimplemented from IlvStIEditor.

IlvStIEditorSet::link
IlvStIEditor * link(const char *gadgetName, IlvStIPropertyAccessor *graphicAccessor, const IlSymbol *valueName, IlvStIEditor::NotificationMode mode=IlvStIEditor::AsOwner)
Creates an editor which is associated with a gadget.