rwlogo
Rogue Wave Views 5.6

Rogue Wave Views
Studio Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

IlvStIDefaultEditorBuilder Class Reference

Inspector class. More...

#include <ivstudio/inspectors/genedt.h>

Inheritance diagram for IlvStIDefaultEditorBuilder:
IlvStIPropertyEditorSet IlvStIEditorSet IlvStIEditor IlvStNamedObject

List of all members.

Public Member Functions

 IlvStIDefaultEditorBuilder (const char *name=0, IlvStIPropertyAccessor *accessor=0, NotificationMode mode=AsOwner)
 Constructor.
virtual IlBoolean connectHolder (IlvGraphicHolder *holder)
 Connects the specified holder with the editor.
virtual IlBoolean initialize ()
 Initializes the editor.

Protected Member Functions

virtual const char * getGraphicName () const

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 [protected, virtual]

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.

 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.