IlvDockableMainWindow Class Reference

Dockable container class. More...

#include <ilviews/gadgets/dockutil.h>

Inheritance diagram for IlvDockableMainWindow:

List of all members.

Public Member Functions
	IlvDockableMainWindow (IlvDisplay *display, IlvSystemView window)
	Constructor.
	IlvDockableMainWindow (IlvDisplay *display, IlvSystemView parent, const IlvRect &rect, IlBoolean visible=IlTrue)
	Constructor.
	IlvDockableMainWindow (IlvAbstractView *parent, const IlvRect &rect, IlBoolean visible=IlTrue)
	Constructor.
	IlvDockableMainWindow (IlvDisplay *display, const char *name, const char *title, const IlvRect &rect, IlUInt properties=0, IlBoolean visible=IlTrue, IlvSystemView transientFor=0)
	Constructor.
IlvDockable *	addRelativeDockingPane (IlvPane *pane, const char *relativePaneName, IlvPosition relativePanePosition)
	Adds the specified pane to the dockable container using a position relative to another pane.
IlvViewPane *	getMainWorkspaceViewPane () const
	Returns the main workspace view pane.

---

Detailed Description

Dockable container class.

Library: ilvadvgdt

The IlvDockableMainWindow class is a subclass of IlvDockableContainer for managing the main window of a standard application that use docking panes. An IlvDockableMainWindow object is a vertical dockable container that defines a default layout that makes it possible to add docking panes by specifying a position relative to other docking panes. Using this class, you don't have to know the complete hierarchy of the dockable containers, which can be complex to understand and manage. Instead, you can think of your application main window as a simple list of docking panes.

- Layout of an IlvDockableMainWindow object -

See also:

IlvDockable, addRelativeDockingPane

---

Constructor & Destructor Documentation

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

Constructor.

Initializes a new instance of the IlvDockableMainWindow class.

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

IlvDockableMainWindow::IlvDockableMainWindow	(	IlvAbstractView *	parent,
		const IlvRect &	rect,
		IlBoolean	visible = IlTrue
	)

Constructor.

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

Parameters:

	parent	Parent view of the dockable container.
	rect	Size and position of the dockable container.
	visible	A Boolean value specifying whether the dockable container is visible.

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

Constructor.

Initializes a new instance of the IlvDockableMainWindow 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.
	visible	A Boolean value specifying whether the dockable container is visible.

IlvDockableMainWindow::IlvDockableMainWindow	(	IlvDisplay *	display,
		IlvSystemView	window
	)

Constructor.

Initializes a new instance of the IlvDockableMainWindow 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.

---

Member Function Documentation

IlvDockable* IlvDockableMainWindow::addRelativeDockingPane	(	IlvPane *	pane,
		const char *	relativePaneName,
		IlvPosition	relativePanePosition
	)

Adds the specified pane to the dockable container using a position relative to another pane.

This methods use relativePaneName and relativePanePosition to find the dockable container and the index in this container where pane must be added. Then it calls IlvDockableContainer::addDockingPane on this container.

Parameters:

	pane	The pane to be added.
	relativePaneName	The name of the pane to which pane will be relative.
	relativePanePosition	The relative position of pane compared to the pane whose name is given by relativePaneName. Valid values are: IlvLeft, IlvRight, IlvBottom, IlvTop.

Returns:

The instance of IlvDockable connected to pane.

See also:

getMainWorkspaceViewPane, getRelativePane

IlvViewPane* IlvDockableMainWindow::getMainWorkspaceViewPane

(

)

const

Returns the main workspace view pane.

This view pane is created by the constructor of IlvDockableMainWindow and should never be removed nor deleted. On the other hand, you can change the view managed by this view pane using the IlvViewPane::setView method. The main feature of this view pane is that it's elastic (see IlvPane::getResizeMode).

Returns:

The main workspace view pane.

See also:

IlvViewPane::setView, IlvPane::getResizeMode, addRelativeDockingPane