Rogue Wave Views
Studio Package API Reference Guide
Product Documentation:

Rogue Wave Views
Documentation Home
List of all members | Public Member Functions
IlvStIMainEditor Class Reference

Inspector class. More...

#include <ivstudio/inspectors/mainedt.h>

Inheritance diagram for IlvStIMainEditor:
IlvStIEditorSet IlvStIEditor IlvStNamedObject

Public Member Functions

 IlvStIMainEditor (const char *applyGadgetName=0, const char *resetGadgetName=0, const char *name=0, NotificationMode mode=Default)
 Initializes a new instance of IlvStIMainEditor. More...
 
virtual void addEditor (IlvStIEditor *)
 Adds the editor to the list of editors. More...
 
virtual IlBoolean connectHolder (IlvGraphicHolder *)
 Connects the specified holder with the editor. More...
 
virtual IlBoolean initialize ()
 Initializes the editor. More...
 
virtual IlBoolean isModified () const
 Returns IlTrue if the editor is modified. More...
 
virtual void setModified (IlBoolean=IlTrue)
 Sets the modification state of the editor. More...
 
- Public Member Functions inherited from IlvStIEditorSet
 IlvStIEditorSet (const char *name=0, NotificationMode mode=AsOwner)
 Initializes an instance of IlvStIEditorSet. 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...
 
IlvStIEditorlink (const char *gadgetName, IlvStIPropertyAccessor *graphicAccessor, const IlSymbol *valueName, IlvStIEditor::NotificationMode mode=IlvStIEditor::AsOwner)
 Creates an editor which is associated with a gadget. More...
 
IlvStIEditorlink (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 IlvStIEditorfindEditor (const char *name) const
 Searches an editor in the editors tree that are owned by this editor. More...
 
IlvStIEditorfindEditor (const char *name)
 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...
 
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

An inspector panel does not directly handle the Apply and Reset buttons, editors, and accessors. These are actually managed by an instance of the IlvStIMainEditor class. For example, when you add an accessor or an editor to an inspector panel, it is added to the instance of IlvStIMainEditor that is held by the inspector.

See also
IlvStInspectorPanel, IlvStIEditor.

Constructor & Destructor Documentation

§ IlvStIMainEditor()

IlvStIMainEditor::IlvStIMainEditor ( const char *  applyGadgetName = 0,
const char *  resetGadgetName = 0,
const char *  name = 0,
NotificationMode  mode = Default 
)

Initializes a new instance of IlvStIMainEditor.

Parameters
applyGadgetNameThe name of the Apply button.
resetGadgetNameThe name of the Reset button.
nameThe editor name.
modeThe notification mode.

Member Function Documentation

§ addEditor()

virtual void IlvStIMainEditor::addEditor ( IlvStIEditor editor)
virtual

Adds the editor to the list of editors.

Parameters
editorThe editor.

Reimplemented from IlvStIEditorSet.

§ connectHolder()

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

§ initialize()

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

§ isModified()

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

§ setModified()

virtual void IlvStIMainEditor::setModified ( IlBoolean  modified = IlTrue)
virtual

Sets the modification state of the editor.

Sets the modification state of the editor. By default, it sets the modification state of the associated accessor.

Parameters
modifiedThe new modification state of the editor.

Reimplemented from IlvStIEditor.


© Copyright 2017, Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave is a registered trademark of Rogue Wave Software, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.