IlvDockableContainer Class Reference

Dockable container class. More...

#include <ilviews/gadgets/dockpane.h>

Inheritance diagram for IlvDockableContainer:

List of all members.

Public Member Functions
	IlvDockableContainer (IlvDisplay *display, IlvSystemView window, IlvDirection direction)
	Constructor.
	IlvDockableContainer (IlvDisplay *display, IlvSystemView parent, const IlvRect &rect, IlvDirection direction, IlBoolean visible=IlTrue)
	Constructor.
	IlvDockableContainer (IlvAbstractView *parent, const IlvRect &rect, IlvDirection direction, IlBoolean visible=IlTrue)
	Constructor.
	IlvDockableContainer (IlvDisplay *display, const char *name, const char *title, const IlvRect &rect, IlvDirection direction, IlUInt properties=0, IlBoolean visible=IlTrue, IlvSystemView transientFor=0)
	Constructor.
virtual IlBoolean	acceptDocking (const IlvPane *pane, IlUInt index) const
	Indicates whether the dockable container allows that the specified pane be docked.
IlvDockable *	addDockingPane (IlvPane *pane, IlUInt index=(IlUInt)-1)
	Adds a docking pane to the dockable container.
virtual IlvDockable *	createDockable (IlvPane *pane) const
	Returns a new instance of the IlvDockable class.
void	createOrthogonalDockableContainer (IlBoolean enable)
	Specifies whether an orthogonal dockable container should be created before docking a pane.
IlBoolean	createOrthogonalDockableContainer () const
	Indicates whether an orthogonal dockable container is created before a pane is docked.
IlvPane *const *	getAllDockingPanes (IlUInt &count, IlBoolean visible=IlTrue, int mode=-1) const
	Returns an array of the panes docked to the dockable container.
IlvPane *const *	getDockingPanes (IlUInt &count, IlBoolean visible=IlTrue, int mode=-1) const
	Returns an array of the panes docked to the dockable container.
IlBoolean	isDockable () const
	Indicates whether the dockable container allows docking.
virtual void	removePane (IlUInt rank, IlBoolean destroy=IlFalse)
	Removes the pane whose index is specified from the paned container.
void	setDockable (IlBoolean enable)
	Specifies whether the dockable container should allow docking.

---

Detailed Description

Dockable container class.

Library: ilvadvgdt

The IlvDockableContainer class is a subclass of IlvPanedContainer for managing docking panes. A docking pane is a pane that can be moved to any dockable area in an interactive way.

See also:

IlvDockable, IlvPane.

---

Constructor & Destructor Documentation

IlvDockableContainer::IlvDockableContainer	(	IlvDisplay *	display,
		const char *	name,
		const char *	title,
		const IlvRect &	rect,
		IlvDirection	direction,
		IlUInt	properties = 0,
		IlBoolean	visible = IlTrue,
		IlvSystemView	transientFor = 0
	)

Constructor.

Initializes a new instance of the IlvDockableContainer class as a top view.

Parameters:

	display	The connection to the display.
	name	The name of the dockable container.
	title	The title of the dockable container.
	rect	The size and position of the dockable container.
	direction	The direction of the dockable container. For details, see the IlvPanedContainer constructors.
	properties	The properties of the dockable container. For details, see the IlvView constructors.
	visible	A Boolean value specifying whether the dockable container is visible.
	transientFor	The system view for which the dockable container is transient. For more details, see the IlvView constructors.

IlvDockableContainer::IlvDockableContainer	(	IlvAbstractView *	parent,
		const IlvRect &	rect,
		IlvDirection	direction,
		IlBoolean	visible = IlTrue
	)

Constructor.

Initializes a new instance of the IlvDockableContainer class as a child view of parent.

Parameters:

	parent	Parent view of the dockable container.
	rect	Size and position of the dockable container.
	direction	The direction of the dockable container. For details, see the IlvPanedContainer constructors.
	visible	A Boolean value specifying whether the dockable container is visible.

IlvDockableContainer::IlvDockableContainer	(	IlvDisplay *	display,
		IlvSystemView	parent,
		const IlvRect &	rect,
		IlvDirection	direction,
		IlBoolean	visible = IlTrue
	)

Constructor.

Initializes a new instance of the IlvDockableContainer class as a child view of the system view specified by parent.

Parameters:

	display	Connection to the display.
	parent	Parent view of the dockable container.
	rect	Size and position of the dockable container.
	direction	Direction of the dockable container. For more details, see the IlvPanedContainer constructors.
	visible	A Boolean value specifying whether the dockable container is visible.

IlvDockableContainer::IlvDockableContainer	(	IlvDisplay *	display,
		IlvSystemView	window,
		IlvDirection	direction
	)

Constructor.

Initializes a new instance of the IlvDockableContainer class mapped to the existing system view specified by parent.

Parameters:

	display	Connection to the display.
	window	System view to which the dockable container will be mapped.
	direction	Direction of the dockable container. For more details, see the IlvPanedContainer constructors.

---

Member Function Documentation

virtual IlBoolean IlvDockableContainer::acceptDocking	(	const IlvPane *	pane,
		IlUInt	index
	)			const [virtual]

Indicates whether the dockable container allows that the specified pane be docked.

The default implementation simply calls the IlvDockableContainer::isDockable method. If you want to filter the docking of panes, you can override this method in subclasses of IlvDockableContainer.

Parameters:

	pane	The pane to be docked.
	index	The position where pane will be docked.

Returns:

A Boolean value specifying whether docking is allowed for pane at index.

See also:

isDockable.

IlvDockable* IlvDockableContainer::addDockingPane	(	IlvPane *	pane,
		IlUInt	index = (IlUInt)-1
	)

Adds a docking pane to the dockable container.

Inserts the specified pane at the index +1 position. A handle pane will be inserted at the position specified by index to allow interactive docking. When the method IlvDockableContainer::createOrthogonalDockableContainer returns IlTrue, the pane is not directly inserted into the dockable container but is added to a new dockable container, which is orthogonal to the one where the pane was initially to be docked. The new container is then encapsulated in a view pane using the IlvViewPane class, and the view pane is added to the dockable container at the specified index.
If no instance of the IlvDockable class was connected to pane, a new instance of IlvDockable is created and automatically connected to pane.

Parameters:

	pane	The pane to be docked.
	index	The position where pane will be docked.

Returns:

The instance of the IlvDockable class connected to pane.

See also:

IlvDockable

virtual IlvDockable* IlvDockableContainer::createDockable

(

IlvPane *

pane

)

const [virtual]

Returns a new instance of the IlvDockable class.

This method is called by the addDockingPane method when the added pane is not already connected to an instance of the IlvDockable class. You may override this method if you want to create your own subclass of the IlvDockable class.

Parameters:

pane

The pane for which the instance of the IlvDockable class is asked.

Returns:

A new instance of the IlvDockable class connected to pane.

See also:

addDockingPane

void IlvDockableContainer::createOrthogonalDockableContainer

(

IlBoolean

enable

)

Specifies whether an orthogonal dockable container should be created before docking a pane.

For details, see the method IlvDockableContainer::addDockingPane.

Parameters:

enable

A Boolean value specifying whether an orthogonal dockable container should be created before docking a pane (IlTrue) or not (IlFalse).

See also:

addDockingPane

IlBoolean IlvDockableContainer::createOrthogonalDockableContainer

(

)

const

Indicates whether an orthogonal dockable container is created before a pane is docked.

Returns:

IlTrue if the dockable container automatically creates an orthogonal dockable container before docking a pane.

See also:

addDockingPane

IlvPane* const* IlvDockableContainer::getAllDockingPanes	(	IlUInt &	count,
		IlBoolean	visible = IlTrue,
		int	mode = -1
	)			const

Returns an array of the panes docked to the dockable container.

This method is the same as getDockingPanes, except that it is recursive.

Parameters:

	count	The number of docking panes in the returned array.
	visible	A Boolean value specifying whether only the visible docking panes (IlTrue), or all the docking panes (IlFalse) should be retrieved.
	mode	An integer that specify the resize mode that docking must match. If mode is -1, or is omitted, then no resize mode is used when finding docking panes. Valid values for this parameter are: -1, IlvPane::Resizable, IlvPane::Elastic, or IlvPane::Fixed.

Returns:

An array of the docking panes of the dockable container. The returned array should never be modified nor deleted.

See also:

getDockingPanes

IlvPane* const* IlvDockableContainer::getDockingPanes	(	IlUInt &	count,
		IlBoolean	visible = IlTrue,
		int	mode = -1
	)			const

Returns an array of the panes docked to the dockable container.

This method returns an array that contains the docking panes that match the specified parameters visible and mode. A docking pane is a pane that has an IlvDockable instance connected to it. This method is not recursive. Use the member function getAllDockingPanes to obtain all the docking panes of a dockable container.

Parameters:

	count	The number of docking panes in the returned array.
	visible	A Boolean value specifying whether only the visible docking panes (IlTrue) or all the docking panes (IlFalse) should be retrieved.
	mode	An integer that specify the resize mode that docking must match. If the mode is -1, or is omitted, then no resize mode is used when finding docking panes. Valid values for this parameter are: -1, IlvPane::Resizable, IlvPane::Elastic, or IlvPane::Fixed.

Returns:

An array of the docking panes of the dockable container. The returned array should never be modified nor deleted.

See also:

addDockingPane

IlBoolean IlvDockableContainer::isDockable

(

)

const

Indicates whether the dockable container allows docking.

Returns:

IlTrue if the dockable container allows the docking of panes.

See also:

setDockable, acceptDocking

virtual void IlvDockableContainer::removePane	(	IlUInt	index,
		IlBoolean	destroy = IlFalse
	)			[virtual]

Removes the pane whose index is specified from the paned container.

Parameters:

	index	The index of the pane to be removed.
	destroy	A Boolean value specifying whether the removed pane should be destroyed.

See also:

addPane, getPane

Reimplemented from IlvPanedContainer.

void IlvDockableContainer::setDockable

(

IlBoolean

enable

)

Specifies whether the dockable container should allow docking.

Specifies whether the docking of panes is allowed (IlTrue) or not (IlFalse). If docking is not allowed for a dockable container, it will not be possible to dock a pane to it.

Parameters:

enable

A Boolean value specifying whether this dockable container allows docking.

See also:

isDockable, acceptDocking