rwlogo
Rogue Wave Views 5.6

Rogue Wave Views
Gadgets Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

List of all members | Public Types | Public Member Functions
IlvDockingPaneLocation Class Reference

Dockable utility class. More...

#include <ilviews/gadgets/dockutil.h>

Public Types

enum  DockedState
 This enumeration defines the possible values for the dockable state of an IlvDockingPaneLocation object.
 

Public Member Functions

 IlvDockingPaneLocation (const char *paneName, const char *relativePaneName, IlvPosition relativePosition, int dockedState=Docked, IlBoolean visible=IlTrue, const IlvRect *horDockedRect=0, const IlvRect *verDockedRect=0, const IlvRect *unDockedRect=0)
 Constructor. More...
 
int getDockedState () const
 Returns the docked state of this location. More...
 
const IlvRectgetPaneGeometry (int state) const
 Returns the geometry of the pane using the specified docked state. More...
 
const char * getPaneName () const
 Returns the name of the pane this location refers to. More...
 
const char * getRelativePaneName () const
 Returns the name of the pane this location is relative to. More...
 
IlvPosition getRelativePosition () const
 Returns the position of this location relative to its relative pane. More...
 
IlBoolean isVisible () const
 Returns the visible state of this location. More...
 

Detailed Description

Dockable utility class.

Library: ilvadvgdt

The IlvDockablePaneLocation class stores the location of a pane relative to another pane. It is used by the IlvDockingConfiguration class.

See Also
IlvDockableMainWindow, IlvDockingConfiguration, IlvDockingConfigurationHandler

Constructor & Destructor Documentation

IlvDockingPaneLocation::IlvDockingPaneLocation ( const char *  paneName,
const char *  relativePaneName,
IlvPosition  relativePosition,
int  dockedState = Docked,
IlBoolean  visible = IlTrue,
const IlvRect horDockedRect = 0,
const IlvRect verDockedRect = 0,
const IlvRect unDockedRect = 0 
)

Constructor.

Initializes a new instance of the IlvDockingPaneLocation class.

Parameters
paneNameThe name of the pane this location refers to.
relativePaneNameThe name of the pane this location is relative to.
relativePositionThe position of the pane paneName relative to the pane relativePaneName. Valid values are: IlvLeft, IlvRight, IlvTop, IlvBottom.
dockedStateThe dockable state of the pane. Valid values are defined in the DockedState enumeration.
visibleA Boolean value specifying whether the pane is visible or not.
horDockedRectA pointer to an IlvRect that represents the size of the pane when it is docked horizontally.
verDockedRectA pointer to an IlvRect that represents the size of the pane when it is docked vertically.
horDockedRectA pointer to an IlvRect that represents the size of the pane when it is undocked.

Member Function Documentation

int IlvDockingPaneLocation::getDockedState ( ) const

Returns the docked state of this location.

Returns
The docked state of this location.
const IlvRect& IlvDockingPaneLocation::getPaneGeometry ( int  state) const

Returns the geometry of the pane using the specified docked state.

Returns
The geometry of the pane using the specified docked state.
const char* IlvDockingPaneLocation::getPaneName ( ) const

Returns the name of the pane this location refers to.

Returns
The name of the pane this location refers to.
const char* IlvDockingPaneLocation::getRelativePaneName ( ) const

Returns the name of the pane this location is relative to.

Returns
The name of the pane this location is relative to.
IlvPosition IlvDockingPaneLocation::getRelativePosition ( ) const

Returns the position of this location relative to its relative pane.

Returns
The position of this location relative to its relative pane.
IlBoolean IlvDockingPaneLocation::isVisible ( ) const

Returns the visible state of this location.

Returns
The visible state of this location.

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