Rogue Wave Views
Studio Package API Reference Guide
Product Documentation:

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

Inspector class. More...

#include <ivstudio/inspectors/gadpnl.h>

Inheritance diagram for IlvStIGadgetInspectorPanel:
IlvStIGraphicInspectorPanel IlvStInspectorPanel

Public Member Functions

 IlvStIGadgetInspectorPanel (IlvDisplay *display, const char *title, const char *filename=0, IlvSystemView transientFor=0, IlvStIAccessor::UpdateMode mode=IlvStIAccessor::OnApply)
 Initializes a new instance of IlvStIGadgetInspectorPanel. More...
 
virtual void applyChange (IlvGraphic *)
 Called to apply the modifications to the graphic object. More...
 
virtual void initFrom (IlvGraphic *)
 Called to initialize the editors with the graphic object. More...
 
virtual void initializeEditors ()
 Called to initialize the editors. More...
 
- Public Member Functions inherited from IlvStIGraphicInspectorPanel
 IlvStIGraphicInspectorPanel (IlvDisplay *display, const char *title, const char *filename=0, IlvSystemView transientFor=0, IlvStIAccessor::UpdateMode mode=IlvStIAccessor::OnApply)
 Initializes a new instance of IlvStIGraphicInspectorPanel. More...
 
- Public Member Functions inherited from IlvStInspectorPanel
 IlvStInspectorPanel (IlvDisplay *display, const char *title, const char *filename=0, IlvSystemView transientFor=0, IlvStIAccessor::UpdateMode mode=IlvStIAccessor::OnApply)
 Initializes a new instance of IlvStInspectorPanel. More...
 
void addAccessor (IlvStIAccessor *acc)
 Adds the accessor to the main editor of the inspector panel. More...
 
void addEditor (IlvStIEditor *editor)
 Adds the editor to the list of editors. More...
 
IlvNotebookPage * addPage (const char *title, const char *filename, IlUShort idx=(IlUShort) -1, IlvBitmap *bitmap=0, IlBoolean transparent=IlTrue)
 Creates a notebook page. More...
 
IlvStIPropertyAccessorbuildPropertyAccessor (const char *name)
 Creates an accessor to the property of the inspected object. More...
 
IlvStIAccessorfindAccessor (const char *name)
 Searches for the accessor in the tree of accessors. More...
 
const IlvStIAccessorfindAccessor (const char *name) const
 Searches for the accessor in the tree of accessors. More...
 
IlvStIEditorfindEditor (const char *name)
 Searches for an editor. More...
 
const IlvStIEditorfindEditor (const char *name) const
 Searches for an editor. More...
 
IlvNotebook * getGenericNotebook () const
 Returns the generic notebook of the inspector panel. More...
 
IlvStIInspectedObjectAccessorgetInspectedGraphicAccessor () const
 Returns the accessor to the inspected object. More...
 
IlvGraphicgetInspectedObject ()
 Returns the current inspected object. More...
 
IlvStIAccessor ** getInspectedObjectAccessors (IlUInt &count) const
 Returns the array of accessors to the inspected object. More...
 
IlvStIMainEditorgetMainEditor ()
 Returns the main editor. More...
 
const IlvStIMainEditorgetMainEditor () const
 Returns the main editor. More...
 
IlvGraphicgetPanelObject (const char *name) const
 Returns a graphic object in the inspector panel. More...
 
IlvStIEditorlink (const char *gadgetName, 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...
 
IlBoolean removeAccessor (IlvStIAccessor *acc)
 Removes the accessor from the main editor of the inspector panel. More...
 
IlBoolean removeEditor (const char *name)
 Removes an editor. More...
 
IlBoolean removeEditor (IlvStIEditor *editor)
 Removes an editor. More...
 
IlBoolean removePage (IlUShort idx)
 Removes a notebook page from the generic notebook. More...
 

Detailed Description

Inspector class.

Library: ivstudio

This class defines an inspector panel for gadgets.

Constructor & Destructor Documentation

§ IlvStIGadgetInspectorPanel()

IlvStIGadgetInspectorPanel::IlvStIGadgetInspectorPanel ( IlvDisplay display,
const char *  title,
const char *  filename = 0,
IlvSystemView  transientFor = 0,
IlvStIAccessor::UpdateMode  mode = IlvStIAccessor::OnApply 
)

Initializes a new instance of IlvStIGadgetInspectorPanel.

Parameters
displayThe display used to create the inspector panel.
titleThe title of the inspector panel.
filenameThe path to the .ilv file that loads the inspector.
transientForThe view system for which the inspector is transient.
modeSpecifies when the modifications are applied to the inspected object. By default, modifications are performed when the user presses the Apply button.

Member Function Documentation

§ applyChange()

virtual void IlvStIGadgetInspectorPanel::applyChange ( IlvGraphic obj)
virtual

Called to apply the modifications to the graphic object.

Parameters
objThe graphic object.

Reimplemented from IlvStIGraphicInspectorPanel.

§ initFrom()

virtual void IlvStIGadgetInspectorPanel::initFrom ( IlvGraphic obj)
virtual

Called to initialize the editors with the graphic object.

Parameters
objThe graphic object.

Reimplemented from IlvStIGraphicInspectorPanel.

§ initializeEditors()

virtual void IlvStIGadgetInspectorPanel::initializeEditors ( )
virtual

Called to initialize the editors.

Adds or removes notebook pages from the inspector panel and creates all the editors and accessors of the inspector panel. Pages should be added to the inspector panel before adding the editors that are associated with the gadgets in these pages.

Reimplemented from IlvStIGraphicInspectorPanel.


© 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.