rwlogo
Rogue Wave Views 5.6

Rogue Wave Views
Studio Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

IlvStIMainEditor Class Reference

Inspector class. More...

#include <ivstudio/inspectors/mainedt.h>

Inheritance diagram for IlvStIMainEditor:
IlvStIEditorSet IlvStIEditor IlvStNamedObject

List of all members.

Public Member Functions

 IlvStIMainEditor (const char *applyGadgetName=0, const char *resetGadgetName=0, const char *name=0, NotificationMode mode=Default)
 Initializes an instance of IlvStIMainEditor.
virtual void addEditor (IlvStIEditor *absEditor)
 Adds the editor to the list of editors.
virtual IlBoolean connectHolder (IlvGraphicHolder *)
 Connects the specified holder with the editor.
virtual IlBoolean initialize ()
 Initializes the editor.
virtual IlBoolean isModified () const
 Returns IlTrue if the editor is modified.
virtual void setModified (IlBoolean=IlTrue)
 Sets the modification state of the editor.

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 ( const char *  applyGadgetName = 0,
const char *  resetGadgetName = 0,
const char *  name = 0,
NotificationMode  mode = Default 
)

Initializes an instance of IlvStIMainEditor.

Parameters:
applyGadgetName The name of the Apply button.
resetGadgetName The name of the Reset button.
name The editor name.
mode The notification mode.

Member Function Documentation

virtual void IlvStIMainEditor::addEditor ( IlvStIEditor editor  )  [virtual]

Adds the editor to the list of editors.

Parameters:
editor The editor.

Reimplemented from IlvStIEditorSet.

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

Reimplemented from IlvStIEditorSet.

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.

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.

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:
modified The new modification state of the editor.

Reimplemented from IlvStIEditor.

 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

© Copyright 2012, 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.