Rogue Wave Views
Studio Package API Reference Guide
Product Documentation:

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

Panel class. More...

#include <ivstudio/panel.h>

Inheritance diagram for IlvStPanelHandler:
IlvStPropertySet IlvStProperty IlvStDialog

Public Member Functions

 IlvStPanelHandler (IlvStudio *editor, const char *name, IlvGadgetContainer *cont=0)
 Initializes an instance of IlvStPanelHandler. More...
 
virtual void apply ()
 Called when an apply of the panel is required.
 
virtual void cancel ()
 Called when a cancel of the panel is required.
 
virtual void connect ()
 Initializes the panel. More...
 
IlvGadgetContainer & container () const
 Returns the gadget container which contains the graphic objects. More...
 
IlvStudiogetEditor () const
 Returns the Rogue Wave Views Studio editor. More...
 
const char * getName () const
 Returns the property name. More...
 
virtual void hide ()
 Hides a Rogue Wave Views Studio panel. More...
 
virtual void reset ()
 Called when a reset of the panel is required.
 
virtual void show ()
 Shows a Rogue Wave Views Studio panel. More...
 
- Public Member Functions inherited from IlvStPropertySet
 IlvStPropertySet (const IlSymbol *name)
 Initializes an instance of IlvStPropertySet. More...
 
 IlvStPropertySet (const char *name)
 Initializes an instance of IlvStPropertySet. More...
 
virtual IlBoolean getPropertyValue (const IlSymbol *name, IlvValue &value)
 Returns the value from a property. More...
 
virtual void setName (const char *str)
 Sets the property name. More...
 
virtual IlBoolean setPropertyValue (const IlSymbol *name, const IlvValue &value)
 Sets the value of one property. More...
 
- Public Member Functions inherited from IlvStProperty
virtual const IlSymbolgetNameSymbol () const
 Returns the property name. More...
 
virtual IlvValuegetValue (IlvValue &value) const
 Returns the property value. More...
 
virtual void setNameSymbol (const IlSymbol *str)
 Sets the property name. More...
 
virtual void setValue (const IlvValue &value)
 Sets the property value. More...
 

Friends

class IlvStudio
 

Detailed Description

Panel class.

Library: ivstudio

The Rogue Wave Views Studio interface is composed of several panels. Panels are instances of a subclass of IlvStPanelHandler. This class is not a gadget container class, but rather a handle to the actual graphic panels that are instances of IlvGadgetContainer. It allows you to keep the graphic aspect of the panel completely separate from its behavior within Rogue Wave Views Studio.

See also
IlvStudio, IlvStCommand, IlvStShowPanel.

Constructor & Destructor Documentation

§ IlvStPanelHandler()

IlvStPanelHandler::IlvStPanelHandler ( IlvStudio editor,
const char *  name,
IlvGadgetContainer *  cont = 0 
)

Initializes an instance of IlvStPanelHandler.

Parameters
editorThe editor.
nameThe container name.
contThe gadget container which contains the graphic objects.

Member Function Documentation

§ connect()

virtual void IlvStPanelHandler::connect ( )
virtual

Initializes the panel.

This method is usually called after the panel has been created. It is meant to separate the constructor from initialization.

§ container()

IlvGadgetContainer& IlvStPanelHandler::container ( ) const

Returns the gadget container which contains the graphic objects.

Returns
The gadget container which contains the graphic objects.

§ getEditor()

IlvStudio* IlvStPanelHandler::getEditor ( ) const

Returns the Rogue Wave Views Studio editor.

Returns
The Rogue Wave Views Studio editor.

§ getName()

const char* IlvStPanelHandler::getName ( ) const
virtual

Returns the property name.

Returns
The property name.

Reimplemented from IlvStPropertySet.

§ hide()

virtual void IlvStPanelHandler::hide ( )
virtual

Hides a Rogue Wave Views Studio panel.

You must not directly hide the handled gadget container.

§ show()

virtual void IlvStPanelHandler::show ( )
virtual

Shows a Rogue Wave Views Studio panel.

You must not directly show the handled gadget container.


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