Rogue Wave Views
Gadgets Package API Reference Guide
Product Documentation:

Rogue Wave Views
Documentation Home
List of all members | Public Types | Public Member Functions
IlvPane Class Referenceabstract

Pane class. More...

#include <ilviews/gadgets/panecont.h>

Inheritance diagram for IlvPane:
IlvGraphicPane IlvViewPane IlvAbstractBarPane IlvDockingHandlePane IlvSeparatorPane IlvSliderPane

Public Types

enum  ResizeMode { Fixed, Resizable, Elastic }
 This enumeration defines the possible values for a resize mode of an IlvPane object. More...
 

Public Member Functions

 IlvPane (const char *name)
 Constructor. More...
 
void addListener (IlvPaneListener *listener)
 Adds a listener to the pane. More...
 
virtual void boundingBox (IlvRect &rect) const =0
 Returns the size and position of the pane. More...
 
IlUShort getBottomMargin () const
 Returns the bottom margin of the pane. More...
 
IlvPanedContainergetContainer () const
 Returns the paned container to which the pane belongs. More...
 
IlUShort getLeftMargin () const
 Returns the left margin of the pane. More...
 
IlvPaneListener *const * getListeners (IlUInt &count) const
 Returns an array of all the pane listeners. More...
 
IlvDim getMinimumSize (IlvDirection direction) const
 Returns the minimum size of the pane. More...
 
const char * getName () const
 Returns the name of the pane. More...
 
IlvNamedPropertygetNamedProperty (const IlSymbol *name) const
 Returns the property whose name is specified. More...
 
IlAny getProperty (const IlSymbol *key) const
 Returns the specified object property. More...
 
int getResizeMode (IlvDirection direction) const
 Returns the resize mode of the pane for the specified direction. More...
 
IlUShort getRightMargin () const
 Returns the right margin of the pane. More...
 
IlUShort getTopMargin () const
 Returns the top margin of the pane. More...
 
IlBoolean hasProperty (const IlSymbol *key) const
 Specifies whether the object has the specified property. More...
 
virtual void hide ()
 Hides the pane. More...
 
IlBoolean isVisible () const
 Specifies whether the pane is visible. More...
 
virtual void moveResize (const IlvRect &rect)
 Moves and resizes the pane. More...
 
void paneBBox (IlvRect &rect) const
 Returns the size and position of the pane, including margins. More...
 
void removeListener (IlvPaneListener *listener)
 Disconnects a listener from the pane. More...
 
IlvNamedPropertyremoveNamedProperty (IlSymbol *name)
 Removes the specified named property from the object. More...
 
IlBoolean removeProperty (const IlSymbol *key)
 Removes the specified object property. More...
 
void setBottomMargin (IlUShort margin)
 Sets the bottom margin of the pane. More...
 
virtual void setContainer (IlvPanedContainer *container)
 Is called when the container of the pane changes. More...
 
virtual void setFocus (IlvEvent *event=0)=0
 Gives the focus to the pane. More...
 
void setLeftMargin (IlUShort margin)
 Sets the left margin of the pane. More...
 
void setMargin (IlUShort margin)
 Sets all the margins of the pane. More...
 
void setMinimumSize (IlvDirection dir, IlvDim size)
 Sets the minimum size of the pane. More...
 
void setMinimumSize (IlvDim size)
 Sets the minimum sizes of the pane in all directions. More...
 
void setName (const char *name)
 Sets the name of the pane. More...
 
IlvNamedPropertysetNamedProperty (IlvNamedProperty *property)
 Sets the property whose name is specified. More...
 
void setProperty (const IlSymbol *key, IlAny value)
 Sets the specified property to the object. More...
 
void setResizeMode (IlvDirection direction, int mode)
 Sets the resize mode of the pane for the specified direction. More...
 
void setResizeMode (int mode)
 Sets the resize mode of the pane both vertically and horizontally. More...
 
void setRightMargin (IlUShort margin)
 Sets the right margin of the pane. More...
 
void setTopMargin (IlUShort margin)
 Sets the top margin of the pane. More...
 
virtual void show ()
 Shows the pane. More...
 

Detailed Description

Pane class.

Library: ilvadvgdt

The class IlvPane is an abstract class that defines a graphic component, called a pane, which can be added to a container of the type IlvPanedContainer. It has two subclasses: IlvGraphicPane, which encapsulates an IlvGraphic object, and IlvViewPane, which encapsulates an IlvView object. A pane can be fixed, elastic, be resizable, and can have a minimum size.

See also
IlvGraphicPane, IlvPanedContainer, IlvSeparatorPane, IlvSliderPane, IlvViewPane, IlvDockable.

Member Enumeration Documentation

§ ResizeMode

This enumeration defines the possible values for a resize mode of an IlvPane object.

See also
IlvPane::setResizeMode().
Enumerator
Fixed 

Fixed panes are never resized.

Resizable 

Resizable panes are resized only if their container does not have elastic panes.

Elastic 

Elastic panes are always resized.

Constructor & Destructor Documentation

§ IlvPane()

IlvPane::IlvPane ( const char *  name)

Constructor.

Initializes a new instance of the IlvPane class. Creates a new pane with the specified name. The minimum size of the created pane is 1, both vertically and horizontally. Its resize mode is IlvPane::Fixed in both directions, which means that it cannot be resized. The left, right, top, and bottom margins of the pane are set to 0.

Parameters
nameThe name of the pane.

Member Function Documentation

§ addListener()

void IlvPane::addListener ( IlvPaneListener listener)

Adds a listener to the pane.

Each pane maintains a list of listeners for the class IlvPaneListener. The pane listeners are notified when a specific method is invoked for the pane. For more details, see the IlvPaneListener.

Parameters
listenerThe pane listener.
See also
IlvPaneListener, removeListener(), getListeners().

§ boundingBox()

virtual void IlvPane::boundingBox ( IlvRect rect) const
pure virtual

Returns the size and position of the pane.

Puts in rect the size and position of the pane.

Parameters
rectThe returned size and position of the pane.
See also
moveResize().

Implemented in IlvGraphicPane, and IlvViewPane.

§ getBottomMargin()

IlUShort IlvPane::getBottomMargin ( ) const

Returns the bottom margin of the pane.

Returns
The bottom margin of the pane.
See also
setBottomMargin().

§ getContainer()

IlvPanedContainer* IlvPane::getContainer ( ) const

Returns the paned container to which the pane belongs.

Returns
The paned container to which the pane belongs or 0 if it does not belong to any paned container.
See also
setContainer().

§ getLeftMargin()

IlUShort IlvPane::getLeftMargin ( ) const

Returns the left margin of the pane.

Returns
The left margin of the pane.
See also
setLeftMargin().

§ getListeners()

IlvPaneListener* const* IlvPane::getListeners ( IlUInt count) const

Returns an array of all the pane listeners.

Parameters
countReturn value holding the number of elements in the array returned by the method.
Returns
An array of count elements containing pointers to the pane listeners. The returned array should never be modified nor deleted.
See also
IlvPaneListener, addListener(), removeListeners().

§ getMinimumSize()

IlvDim IlvPane::getMinimumSize ( IlvDirection  direction) const

Returns the minimum size of the pane.

Parameters
directionThe direction for which the minimum size is requested. Valid values are: IlvHorizontal and IlvVertical.
Returns
The minimum size of the pane for the specified direction.
See also
setMinimumSize().

§ getName()

const char* IlvPane::getName ( ) const

Returns the name of the pane.

Returns
The name of the pane or 0 if the pane has no name.
See also
setName(), IlvPanedContainer::getPane().

§ getNamedProperty()

IlvNamedProperty* IlvPane::getNamedProperty ( const IlSymbol name) const

Returns the property whose name is specified.

Parameters
nameThe property name.
Returns
A pointer to property object specified by name. It returns 0 if no named property matches name.
See also
setNamedProperty(), removeNamedProperty().

§ getProperty()

IlAny IlvPane::getProperty ( const IlSymbol key) const

Returns the specified object property.

Parameters
keyThe symbol representing the property.
Returns
The specified property value when it can be found. It returns 0 when no property name matches the key parameter.
See also
setProperty(), removeProperty(), hasProperty().

§ getResizeMode()

int IlvPane::getResizeMode ( IlvDirection  direction) const

Returns the resize mode of the pane for the specified direction.

Parameters
directionThe direction.
Returns
The resize mode of the pane for the specified direction.
See also
setResizeMode(), ResizeMode.

§ getRightMargin()

IlUShort IlvPane::getRightMargin ( ) const

Returns the right margin of the pane.

Returns
The right margin of the pane.
See also
setRightMargin().

§ getTopMargin()

IlUShort IlvPane::getTopMargin ( ) const

Returns the top margin of the pane.

Returns
The top margin of the pane.
See also
setTopMargin().

§ hasProperty()

IlBoolean IlvPane::hasProperty ( const IlSymbol key) const

Specifies whether the object has the specified property.

Parameters
keyThe symbol representing the property.
Returns
IlTrue if the key property was found and IlFalse if not.
See also
setProperty(), removeProperty(), getProperty().

§ hide()

virtual void IlvPane::hide ( )
virtual

Hides the pane.

After calling this method, you have to call the IlvPanedContainer::updatePanes() method to see the modifications.

See also
show().

§ isVisible()

IlBoolean IlvPane::isVisible ( ) const

Specifies whether the pane is visible.

Returns
IlTrue if the pane is visible.
See also
show(), hide().

§ moveResize()

virtual void IlvPane::moveResize ( const IlvRect rect)
virtual

Moves and resizes the pane.

Parameters
rectThe new size and position of the pane.
See also
boundingBox().

Reimplemented in IlvGraphicPane, IlvViewPane, IlvAbstractBarPane, and IlvDockingHandlePane.

§ paneBBox()

void IlvPane::paneBBox ( IlvRect rect) const

Returns the size and position of the pane, including margins.

Puts in rect the size and position of the pane, including margins.

Parameters
rectThe returned size and position of the pane, including margins.
See also
boundingBox().

§ removeListener()

void IlvPane::removeListener ( IlvPaneListener listener)

Disconnects a listener from the pane.

The pane listener is not deleted.

Parameters
listenerThe pane listener.
See also
IlvPaneListener, addListener(), getListeners().

§ removeNamedProperty()

IlvNamedProperty* IlvPane::removeNamedProperty ( IlSymbol name)

Removes the specified named property from the object.

Parameters
nameThe property name.
Returns
The named property with the same name that was previously associated with this object. You can delete it or keep it for further handling. If no named property with the same name was previously associated with this object, this member function returns 0.
See also
getNamedProperty(), setNamedProperty().

§ removeProperty()

IlBoolean IlvPane::removeProperty ( const IlSymbol key)

Removes the specified object property.

Parameters
keyThe symbol representing the property.
Returns
IlTrue if the key property was found and IlFalse if not.
See also
setProperty(), getProperty(), hasProperty().

§ setBottomMargin()

void IlvPane::setBottomMargin ( IlUShort  margin)

Sets the bottom margin of the pane.

Parameters
marginThe new bottom margin.
See also
getBottomMargin().

§ setContainer()

virtual void IlvPane::setContainer ( IlvPanedContainer container)
virtual

Is called when the container of the pane changes.

Parameters
containerThe new pane container.
See also
IlvPanedContainer::addPane(), IlvPanedContainer::removePane().

Reimplemented in IlvGraphicPane, IlvViewPane, and IlvAbstractBarPane.

§ setFocus()

virtual void IlvPane::setFocus ( IlvEvent event = 0)
pure virtual

Gives the focus to the pane.

Parameters
eventA pointer to the event that triggered the call to this method.

Implemented in IlvGraphicPane, and IlvViewPane.

§ setLeftMargin()

void IlvPane::setLeftMargin ( IlUShort  margin)

Sets the left margin of the pane.

Parameters
marginThe new left margin.
See also
getLeftMargin().

§ setMargin()

void IlvPane::setMargin ( IlUShort  margin)

Sets all the margins of the pane.

This method sets the left, right, top, and bottom margins to margin.

Parameters
marginThe new margins of the pane.
See also
getLeftMargin(), getRightMargin(), getTopMargin(), getBottomMargin().

§ setMinimumSize() [1/2]

void IlvPane::setMinimumSize ( IlvDirection  dir,
IlvDim  size 
)

Sets the minimum size of the pane.

Parameters
dirThe direction for which the minimum size is set. Valid values are: IlvHorizontal and IlvVertical.
sizeThe new minimum size.
See also
getMinimumSize().

§ setMinimumSize() [2/2]

void IlvPane::setMinimumSize ( IlvDim  size)

Sets the minimum sizes of the pane in all directions.

Parameters
sizeThe new minimum size.
See also
getMinimumSize().

§ setName()

void IlvPane::setName ( const char *  name)

Sets the name of the pane.

Parameters
nameThe new name of the pane.
See also
getName(), IlvPanedContainer::getPane().

§ setNamedProperty()

IlvNamedProperty* IlvPane::setNamedProperty ( IlvNamedProperty property)

Sets the property whose name is specified.

Parameters
propertyThe named property.
Returns
The named property with the same name that was previously associated with the object. You can delete it or keep it for further handling. If no named property with the same name was associated with this object, this member function returns 0.
See also
getNamedProperty(), removeNamedProperty().

§ setProperty()

void IlvPane::setProperty ( const IlSymbol key,
IlAny  value 
)

Sets the specified property to the object.

Parameters
keyThe symbol representing the property.
valueThe new value of the property. If value equals 0, the property is removed.
See also
removeProperty(), getProperty(), hasProperty().

§ setResizeMode() [1/2]

void IlvPane::setResizeMode ( IlvDirection  direction,
int  mode 
)

Sets the resize mode of the pane for the specified direction.

The container of a pane uses the resize mode in effect when its size changes to determine whether the pane should be resized. A pane is resized depending on its type:

  • A fixed pane is never resized.

  • A resizable pane is resized only if its container does not have an elastic pane.

  • An elastic pane is always resized.

Typically, an application contains a few fixed panes, many resizable panes, and only one elastic pane that serves as the "working area". See the IlvDockableMainWindow class for details.

Parameters
directionThe direction of the pane. Valid values are: IlvVertical and IlvHorizontal.
modeThe new resize mode. Valid values are: IlvPane::Fixed, IlvPane::Resizable and IlvPane::Elastic.
See also
getResizeMode(), ResizeMode.

§ setResizeMode() [2/2]

void IlvPane::setResizeMode ( int  mode)

Sets the resize mode of the pane both vertically and horizontally.

Parameters
modeThe new resize mode. Valid values are: IlvPane::Fixed, IlvPane::Resizable and IlvPane::Elastic.
See also
getResizeMode(), ResizeMode.

§ setRightMargin()

void IlvPane::setRightMargin ( IlUShort  margin)

Sets the right margin of the pane.

Parameters
marginThe new right margin.
See also
getRightMargin().

§ setTopMargin()

void IlvPane::setTopMargin ( IlUShort  margin)

Sets the top margin of the pane.

Parameters
marginThe new top margin.
See also
getTopMargin().

§ show()

virtual void IlvPane::show ( )
virtual

Shows the pane.

After calling this method, you have to call the IlvPanedContainer::updatePanes() method to see the modifications.

See also
hide().

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