rwlogo

Rogue Wave Views
Gadgets Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

List of all members | Public Member Functions | Static Public Member Functions
IlvDockingHandlePane Class Reference

Class that represents a pane handle. More...

#include <ilviews/gadgets/dockpane.h>

Inheritance diagram for IlvDockingHandlePane:
IlvGraphicPane IlvPane

Public Member Functions

virtual void moveResize (const IlvRect &)
 Moves and resizes the pane. 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 setContainer (IlvPanedContainer *cont)
 Is called when the container of the pane changes. 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, 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...
 

Static Public Member Functions

static void UseDefaultHandlePanes (IlBoolean smallSize)
 Uses Views 4.0 pane handles. More...
 
static void UseTitledHandlePanes (IlBoolean smallSize)
 Uses pane handles showing the pane title. More...
 

Additional Inherited Members

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

Detailed Description

Class that represents a pane handle.

Library: ilvadvgdt

Instances of the class IlvDockingHandlePane are created when calling IlvDockableContainer::addDockingPane.

See Also
IlvDockableContainer, IlvPane.

Member Function Documentation

virtual void IlvDockingHandlePane::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.

static void IlvDockingHandlePane::UseDefaultHandlePanes ( IlBoolean  smallSize)
static

Uses Views 4.0 pane handles.

After calling this method, the pane handles created by calling IlvDockableContainer::addDockingPane will show relief bars and two buttons: the expand/contract button and the hide button.

Parameters
smallSizeA Boolean value indicating whether this setting may be applied to small handles (for toolbars) or to other handles.
static void IlvDockingHandlePane::UseTitledHandlePanes ( IlBoolean  smallSize)
static

Uses pane handles showing the pane title.

After calling this method, the pane handles created by calling IlvDockableContainer::addDockingPane will show the title of the corresponding dockable pane.

Parameters
smallSizeA Boolean value indicating whether this setting may be applied to small handles (for toolbars) or to other handles.

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