IlvDockingConfiguration Class Reference

Dockable utility class. More...

#include <ilviews/gadgets/dockutil.h>

Public Member Functions
	IlvDockingConfiguration ()
	Constructor. More...
void	addLocation (const IlvDockingPaneLocation *loc)
	Adds the specified pane location to this configuration. More...
void	clean ()
	Removes and deletes all the pane location of this configuration. More...
IlUInt	getCardinal () const
	Returns the number of pane locations this configuration has. More...
const IlvDockingPaneLocation *	getLocation (const char *name) const
	Returns the pane location whose name is specified. More...
const IlvDockingPaneLocation *	getLocation (IlUInt index) const
	Returns the pane location whose index is specified. More...

Detailed Description

Dockable utility class.

Library: ilvadvgdt

The IlvDockingConfiguration class is a collection of IlvDockingPaneLocation objects. It is used by the IlvDockingConfigurationHandler class to switch from one docking configuration to another.

See also

IlvDockableMainWindow, IlvDockingPaneLocation, IlvDockingConfigurationHandler.

Constructor & Destructor Documentation

IlvDockingConfiguration()

IlvDockingConfiguration::IlvDockingConfiguration

(

)

Constructor.

Initializes a new instance of the IlvDockingConfiguration class.

Member Function Documentation

addLocation()

void IlvDockingConfiguration::addLocation

(

const IlvDockingPaneLocation *

loc

)

Adds the specified pane location to this configuration.

Parameters

loc	The pane location.

See also

clean().

clean()

void IlvDockingConfiguration::clean

(

)

Removes and deletes all the pane location of this configuration.

See also

addLocation().

getCardinal()

IlUInt IlvDockingConfiguration::getCardinal

(

)

const

Returns the number of pane locations this configuration has.

Returns

The number of pane locations this configuration has.

getLocation() [1/2]

const IlvDockingPaneLocation* IlvDockingConfiguration::getLocation

(

const char *

name

)

const

Returns the pane location whose name is specified.

Parameters

name	The name of the pane location.

Returns

The pane location whose name is name. Returns 0 if no pane location has the name name in this configuration.

getLocation() [2/2]

const IlvDockingPaneLocation* IlvDockingConfiguration::getLocation

(

IlUInt

index

)

const

Returns the pane location whose index is specified.

Parameters

index

The index of the pane location.

Returns

The pane location of index index.