Rogue Wave Views
Gadgets Package API Reference Guide
Product Documentation:

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

Docking Pane class. More...

#include <ilviews/gadgets/dockpane.h>

Inheritance diagram for IlvAbstractBarPane:
IlvGraphicPane IlvPane

Public Member Functions

 IlvAbstractBarPane (const char *name, IlvAbstractBar *bar)
 Constructor. More...
 
virtual void geometryChanged ()
 Called when the geometry of the encapsulated bar has changed. More...
 
IlvAbstractBargetBar () const
 Returns the IlvAbstractBar object managed by this pane. More...
 
virtual void moveResize (const IlvRect &)
 Moves and resizes the pane. More...
 
virtual void orientationChanged ()
 Called when the orientation of the encapsulated bar has changed. More...
 
virtual void setContainer (IlvPanedContainer *)
 Is called when the container of the pane changes. More...
 
- Public Member Functions inherited from IlvGraphicPane
 IlvGraphicPane (const char *name, IlvGraphic *graphic, IlUShort margin=2, IlBoolean owner=IlTrue)
 Constructor. More...
 
virtual void boundingBox (IlvRect &) const
 Returns the size and position of the pane. More...
 
IlvGraphicgetObject () const
 Returns the graphic object encapsulated by the pane. More...
 
IlBoolean isDoubleBuffering () const
 Tests the pane double buffering setting. More...
 
virtual void setDoubleBuffering (IlBoolean value)
 Sets double buffering. More...
 
virtual void setFocus (IlvEvent *event=0)
 Gives the focus to the pane. More...
 
void setObject (IlvGraphic *obj, IlBoolean owner=IlTrue)
 Sets the graphic object encapsulated by the pane. More...
 
- Public Member Functions inherited from IlvPane
 IlvPane (const char *name)
 Constructor. More...
 
void addListener (IlvPaneListener *listener)
 Adds a listener to 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...
 
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...
 
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...
 

Additional Inherited Members

- Public Types inherited from IlvPane

Detailed Description

Docking Pane class.

Library: ilvadvgdt

An IlvAbstractBarPane object is a special graphic pane that handles IlvAbstractBar objects, such as IlvMenuBar or IlvToolBar objects. It computes the orientation of the managed bar using its geometry: if the bar width is greater than its height, the bar is horizontal. Otherwise it is vertical.

See also
IlvAbstractBar, IlvDockableContainer.

Constructor & Destructor Documentation

IlvAbstractBarPane::IlvAbstractBarPane ( const char *  name,
IlvAbstractBar bar 
)

Constructor.

Creates a new pane using the provided name and bar parameters.

Parameters
nameThe name of the pane.
barA pointer to the IlvAbstractBar object managed by this pane.

Member Function Documentation

virtual void IlvAbstractBarPane::geometryChanged ( )
virtual

Called when the geometry of the encapsulated bar has changed.

See also
IlvAbstractBar::geometryChanged
IlvAbstractBar* IlvAbstractBarPane::getBar ( ) const

Returns the IlvAbstractBar object managed by this pane.

Returns
The IlvAbstractBar object managed by this pane.
virtual void IlvAbstractBarPane::moveResize ( const IlvRect rect)
virtual

Moves and resizes the pane.

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

Reimplemented from IlvGraphicPane.

virtual void IlvAbstractBarPane::orientationChanged ( )
virtual

Called when the orientation of the encapsulated bar has changed.

See also
geometryChanged
virtual void IlvAbstractBarPane::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 from IlvGraphicPane.


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