IlvDockingConfigurationHandler Class Reference

Dockable utility class. More...

#include <ilviews/gadgets/dockutil.h>

List of all members.

Public Member Functions
	IlvDockingConfigurationHandler ()
	Constructor.
void	getCurrentDockingConfiguration (IlvDockingConfiguration &conf) const
	Returns the current docking configuration.
virtual IlvPane *	getDockingPane (IlUInt index) const =0
	Returns the pane whose index is specified.
virtual IlUInt	getDockingPanesCount () const =0
	Returns the total number of panes managed by this handler.
virtual IlvDockableMainWindow *	getMainWindow () const =0
	Returns the IlvDockableMainWindow object this handler points to.
void	setCurrentDockingConfiguration (const IlvDockingConfiguration &conf, IlBoolean update=IlTrue)
	Sets the specified docking configuration as the current one.

---

Detailed Description

Dockable utility class.

Library: ilvadvgdt

The IlvDockingConfigurationHandler class handles the switching between one docking configuration and another docking configuration in a IlvDockableMainWindow container. It is an abstract class and, therefore, needs to be subclassed.

See also:

IlvDockableMainWindow, IlvDockingPaneLocation, IlvDockingConfiguration

---

Constructor & Destructor Documentation

IlvDockingConfigurationHandler::IlvDockingConfigurationHandler

(

)

Constructor.

Initializes a new instance of the IlvDockingConfigurationHandler class.

---

Member Function Documentation

void IlvDockingConfigurationHandler::getCurrentDockingConfiguration

(

IlvDockingConfiguration &

conf

)

const

Returns the current docking configuration.

This method fills conf with the current docking configuration.

Parameters:

conf

The returned docking configuration.

See also:

setCurrentDockingConfiguration

virtual IlvPane* IlvDockingConfigurationHandler::getDockingPane

(

IlUInt

index

)

const [pure virtual]

Returns the pane whose index is specified.

This method is pure and, therefore, needs to be redefined in subclasses.

Parameters:

index

The index of the pane.

Returns:

The pane of index index.

virtual IlUInt IlvDockingConfigurationHandler::getDockingPanesCount

(

)

const [pure virtual]

Returns the total number of panes managed by this handler.

This method is pure and, therefore, needs to be redefined in subclasses.

Returns:

The total number of panes managed by this handler.

virtual IlvDockableMainWindow* IlvDockingConfigurationHandler::getMainWindow

(

)

const [pure virtual]

Returns the IlvDockableMainWindow object this handler points to.

This method is pure and, therefore, needs to be redefined in subclasses.

Returns:

The IlvDockableMainWindow object this handler points to.

void IlvDockingConfigurationHandler::setCurrentDockingConfiguration	(	const IlvDockingConfiguration &	conf,
		IlBoolean	update = IlTrue
	)

Sets the specified docking configuration as the current one.

This method moves the panes to match the configuration specified by conf.

Parameters:

	conf	The new docking configuration.
	update	A Boolean value specifying whether the modified panes should be redrawn or not.

See also:

getCurrentDockingConfiguration