Inheritance diagram for iWidgetDockingManager:

Detailed Description

Widget docking manager.

Remarks: The docking manager is a normal widget that implements iWidgetSink.

Main
virtual tBool	SetFlags (tWidgetDockingManagerFlags aFlags)=0
	Set the docking manager's flags. {Property}. More...

virtual tWidgetDockingManagerFlags	GetFlags () const =0
	Get the docking manager's flags. {Property}. More...

Management
virtual tU32	GetDockAreaFromPageName (const achar *aaszName) const =0
	Get the first dock area that contains a tab page with the specified name. {Property}. More...

virtual tU32	GetDockAreaHovered (sVec2f avPos) const =0
	Get the dock area that is hovered by the specified absolute cursor position. {Property}. More...

virtual tBool	DockWidget (tU32 anDock, iWidget *apWidget)=0
	Dock the specified widget inside the specified dock area. More...

virtual tBool	UndockWidget (iWidget *apWidget)=0
	Undock the specified widget. More...

virtual tU32	GetNumDockedWidgets () const =0
	Get the number of widgets docked. {Property}. More...

virtual iWidget *	GetDockedWidget (tU32 anIndex) const =0
	Get the docked widget at the specified index. {Property}. More...

virtual tU32	GetNumDockAreas () const =0
	Get the number of dock area. {Property}. More...

virtual iWidget *	GetDockArea (tU32 anIndex) const =0
	Get the dock area at the specified index. {Property}. More...

virtual tBool	SetDockAreaTabContextMenu (iWidget *apMenu)=0
	Set the context menu of the dock areas tabs. {Property}. More...

virtual iWidget *	GetDockAreaTabContextMenu () const =0
	Get the context menu of the dock areas tabs. {Property}. More...

virtual tU32	AddDockArea (tU32 anParent, tU32 aPos, sRectf aRect, tBool abLocal)=0
	Add a new empty dock area. More...

virtual void	ClearDockAreas ()=0
	Remove all dock areas. More...

virtual void	CleanDockAreas ()=0
	Clean all invalid/empty dock areas. More...

Additional Inherited Members
Public Member Functions inherited from iUnknown
virtual tBool	IsOK () const =0
	Check if the object is valid. More...

virtual tI32	AddRef ()=0
	Signal that one more reference of the object has been created. More...

virtual tI32	Release ()=0
	Release a reference of the object. More...

virtual void	DeleteThis ()=0
	Bypass any reference counting and delete this object. More...

virtual void	Invalidate ()=0
	Invalidate the object. More...

virtual iUnknown *	QueryInterface (const tUUID &aIID)=0
	Query an interface. More...

virtual void	ListInterfaces (iMutableCollection *apLst, tU32 anFlags) const =0
	Fill a UUID list containing the UUIDs of the implemented interfaces. More...

virtual tI32	SetNumRefs (tI32 anNumRefs)=0
	Set the reference counter directly. More...

virtual tI32	GetNumRefs () const =0
	Get the number of references to this object. More...

Member Function Documentation

virtual tBool SetFlags ( tWidgetDockingManagerFlags aFlags )

pure virtual

Set the docking manager's flags. {Property}.

virtual tWidgetDockingManagerFlags GetFlags ( ) const

pure virtual

Get the docking manager's flags. {Property}.

virtual tU32 GetDockAreaFromPageName ( const achar * aaszName ) const

pure virtual

Get the first dock area that contains a tab page with the specified name. {Property}.

virtual tU32 GetDockAreaHovered ( sVec2f avPos ) const

pure virtual

Get the dock area that is hovered by the specified absolute cursor position. {Property}.

virtual tBool DockWidget	(	tU32	anDock,
		iWidget *	apWidget
	)

pure virtual

Dock the specified widget inside the specified dock area.

Remarks: If anDock == eInvalidHandle the widget will be docked inside the dock area created by eWidgetDockingManagerMessage_CreateHoveredDockArea, if none has been created the method will return eFalse.

virtual tBool UndockWidget ( iWidget * apWidget )

pure virtual

Undock the specified widget.

virtual tU32 GetNumDockedWidgets ( ) const

pure virtual

Get the number of widgets docked. {Property}.

virtual iWidget* GetDockedWidget ( tU32 anIndex ) const

pure virtual

Get the docked widget at the specified index. {Property}.

virtual tU32 GetNumDockAreas ( ) const

pure virtual

Get the number of dock area. {Property}.

virtual iWidget* GetDockArea ( tU32 anIndex ) const

pure virtual

Get the dock area at the specified index. {Property}.

virtual tBool SetDockAreaTabContextMenu ( iWidget * apMenu )

pure virtual

Set the context menu of the dock areas tabs. {Property}.

virtual iWidget* GetDockAreaTabContextMenu ( ) const

pure virtual

Get the context menu of the dock areas tabs. {Property}.

virtual tU32 AddDockArea	(	tU32	anParent,
		tU32	aPos,
		sRectf	aRect,
		tBool	abLocal
	)

pure virtual

Add a new empty dock area.

Returns: The index of the new dock area.

virtual void ClearDockAreas ( )

pure virtual

Remove all dock areas.

virtual void CleanDockAreas ( )

pure virtual

Clean all invalid/empty dock areas.

Detailed Description

Main

Management

Additional Inherited Members

Member Function Documentation