IlvDockingConfigurationHandler Class Reference

Dockable utility class. More...

#include <ilviews/gadgets/dockutil.h>

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

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::IlvDockingConfigurationHandler

(

)

Constructor.

Initializes a new instance of the IlvDockingConfigurationHandler class.

Member Function Documentation

getCurrentDockingConfiguration()

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().

getDockingPane()

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.

getDockingPanesCount()

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.

getMainWindow()

virtual IlvDockableMainWindow* IlvDockingConfigurationHandler::getMainWindow ( ) const

pure virtual

Returns the IlvDockableMainWindow object this handler points to.

This is a pure virtual method. It needs to be redefined in subclasses.

Returns

The IlvDockableMainWindow object this handler points to.

setCurrentDockingConfiguration()

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().