Inheritance diagram for iWidgetSplitter:

Detailed Description

Splitter widget interface.

Public Member Functions
virtual tBool	AddSplitterFront (tF32 afPos)=0
	Add a splitter in the front (top or left). More...

virtual tBool	AddSplitterBack (tF32 afPos)=0
	Add a splitter in the back (bottom or right). More...

virtual tBool	RemoveSplitter (tU32 anIndex)=0
	Remove the splitter at the specified index. More...

virtual tU32	GetNumSplitters () const =0
	Get the number of splitters. {Property}. More...

virtual tU32	GetNumSplitterWidgets () const =0
	Get the number of splitter's widgets. {Property}. More...

virtual iWidget *	GetSplitterWidget (tU32 anIndex) const =0
	Get a splitter's widget. {Property}. More...

virtual tU32	GetSplitterWidgetIndex (iWidget *apWidget) const =0
	Get a splitter's widget index. {Property}. More...

virtual tBool	RemoveSplitterWidget (tU32 anIndex)=0
	Remove the specified splitter widget. More...

virtual tBool	AddSplitterBefore (tU32 anWidget, tF32 afPos)=0
	Add a splitter before the specified widget (top or left). More...

virtual tBool	AddSplitterAfter (tU32 anWidget, tF32 afPos)=0
	Add a splitter after the specified widget (bottom or right). More...

virtual tBool	SetSplitterPosition (tU32 anIndex, tF32 aVal)=0
	Set the position of the splitter at the given index. {Property}. More...

virtual tF32	GetSplitterPosition (tU32 anIndex) const =0
	Get the position of the splitter at the given index {Property}. More...

virtual tBool	SetSplitterMinPosition (tF32 aVal)=0
	Set the splitter's minimum position. {Property}. More...

virtual tF32	GetSplitterMinPosition () const =0
	Get the splitter's minimum position. {Property}. More...

virtual tBool	SetSplitterSize (tF32 afSize)=0
	Set the splitter size. {Property}. More...

virtual tF32	GetSplitterSize () const =0
	Get the splitter size. {Property}. More...

virtual tBool	SwapSplitterWidget (tU32 anA, tU32 anB)=0
	Swap two splitter widgets. More...

virtual void	SetSplitterBorderSize (tF32 afSize)=0
	Set the splitter's border size. {Property}. More...

virtual tF32	GetSplitterBorderSize () const =0
	Get the splitter's border size. {Property}. More...

virtual void	SetSplitterResizableBorders (tU32 aEdges)=0
	Set the splitter's resizable borders. More...

virtual tU32	GetSplitterResizableBorders () const =0
	Get the splitter's resizable borders. {Property}. More...

virtual void	SetSplitterParentDockRectMinimumSize (sVec2f avMinSize)=0
	Set the minimum size that the parent dock rect can have. More...

virtual sVec2f	GetSplitterParentDockRectMinimumSize () const =0
	Get the minimum size that the parent dock rect can have. {Property}. More...

virtual void	SetSplitterFillerIndex (ni::tU32 anIndex)=0
	Set the index of the filling splitter. More...

virtual tU32	GetSplitterFillerIndex () const =0
	Set the index of the filling splitter. {Property}. More...

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 AddSplitterFront ( tF32 afPos )

pure virtual

Add a splitter in the front (top or left).

virtual tBool AddSplitterBack ( tF32 afPos )

pure virtual

Add a splitter in the back (bottom or right).

virtual tBool RemoveSplitter ( tU32 anIndex )

pure virtual

Remove the splitter at the specified index.

Remarks: The widget at the bottom (right if horizontal) will be removed.

virtual tU32 GetNumSplitters ( ) const

pure virtual

Get the number of splitters. {Property}.

virtual tU32 GetNumSplitterWidgets ( ) const

pure virtual

Get the number of splitter's widgets. {Property}.

virtual iWidget* GetSplitterWidget ( tU32 anIndex ) const

pure virtual

Get a splitter's widget. {Property}.

Remarks: Widgets are numbered from top to bottom, and left to right.

virtual tU32 GetSplitterWidgetIndex ( iWidget * apWidget ) const

pure virtual

Get a splitter's widget index. {Property}.

virtual tBool RemoveSplitterWidget ( tU32 anIndex )

pure virtual

Remove the specified splitter widget.

Remarks: At least one widget will always be available, so the last widget cant be removed.; This will take care of removing the appropriate splitter.

virtual tBool AddSplitterBefore	(	tU32	anWidget,
		tF32	afPos
	)

pure virtual

Add a splitter before the specified widget (top or left).

Remarks: afPos is relative to the widget used for insertion.

virtual tBool AddSplitterAfter	(	tU32	anWidget,
		tF32	afPos
	)

pure virtual

Add a splitter after the specified widget (bottom or right).

Remarks: afPos is relative to the widget used for insertion.

virtual tBool SetSplitterPosition	(	tU32	anIndex,
		tF32	aVal
	)

pure virtual

Set the position of the splitter at the given index. {Property}.

Remarks: The position is in percent, relative to the size of the widget.

virtual tF32 GetSplitterPosition ( tU32 anIndex ) const

pure virtual

Get the position of the splitter at the given index {Property}.

Remarks: The position is in percent, relative to the size of the widget.

virtual tBool SetSplitterMinPosition ( tF32 aVal )

pure virtual

Set the splitter's minimum position. {Property}.

Remarks: The minimum position is the minimum distance from the parent's borders in pixels.; If the minimum position is < 0 no limit is applied.

virtual tF32 GetSplitterMinPosition ( ) const

pure virtual

Get the splitter's minimum position. {Property}.

Remarks: The minimum position is the minimum distance from the parent's borders in pixels.

virtual tBool SetSplitterSize ( tF32 afSize )

pure virtual

Set the splitter size. {Property}.

virtual tF32 GetSplitterSize ( ) const

pure virtual

Get the splitter size. {Property}.

virtual tBool SwapSplitterWidget	(	tU32	anA,
		tU32	anB
	)

pure virtual

Swap two splitter widgets.

virtual void SetSplitterBorderSize ( tF32 afSize )

pure virtual

Set the splitter's border size. {Property}.

virtual tF32 GetSplitterBorderSize ( ) const

pure virtual

Get the splitter's border size. {Property}.

virtual void SetSplitterResizableBorders ( tU32 aEdges )

pure virtual

Set the splitter's resizable borders.

Parameters

aEdges edges flags.

See also: eRectEdges {Property}

virtual tU32 GetSplitterResizableBorders ( ) const

pure virtual

Get the splitter's resizable borders. {Property}.

virtual void SetSplitterParentDockRectMinimumSize ( sVec2f avMinSize )

pure virtual

Set the minimum size that the parent dock rect can have.

Remarks: This value is used only if a border is resizable, if the min size >= 0 and if the splitter is docked.; By default the value is (20,20) {Property}

virtual sVec2f GetSplitterParentDockRectMinimumSize ( ) const

pure virtual

Get the minimum size that the parent dock rect can have. {Property}.

virtual void SetSplitterFillerIndex ( ni::tU32 anIndex )

pure virtual

Set the index of the filling splitter.

Remarks: The filling splitter correspond to the index of the canvas that will fill the whole splitter's rectangle, so that it'll be the only widget visible. This is meant to be used as a special mode to allow 'fullscreen' widgets with toggle to a splitted/composite view. {Property}

virtual tU32 GetSplitterFillerIndex ( ) const

pure virtual

Set the index of the filling splitter. {Property}.

Detailed Description

Public Member Functions

Member Function Documentation