IlvDockingPaneLocation Class Reference

Dockable utility class. More...

#include <ilviews/gadgets/dockutil.h>

List of all members.

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.
int	getDockedState () const
	Returns the docked state of this location.
const IlvRect &	getPaneGeometry (int state) const
	Returns the geometry of the pane using the specified docked state.
const char *	getPaneName () const
	Returns the name of the pane this location refers to.
const char *	getRelativePaneName () const
	Returns the name of the pane this location is relative to.
IlvPosition	getRelativePosition () const
	Returns the position of this location relative to its relative pane.
IlBoolean	isVisible () const
	Returns the visible state of this location.

---

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:

	paneName	The name of the pane this location refers to.
	relativePaneName	The name of the pane this location is relative to.
	relativePosition	The position of the pane paneName relative to the pane relativePaneName. Valid values are: IlvLeft, IlvRight, IlvTop, IlvBottom.
	dockedState	The dockable state of the pane. Valid values are defined in the DockedState enumeration.
	visible	A Boolean value specifying whether the pane is visible or not.
	horDockedRect	A pointer to an IlvRect that represents the size of the pane when it is docked horizontally.
	verDockedRect	A pointer to an IlvRect that represents the size of the pane when it is docked vertically.
	horDockedRect	A 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.