Inheritance diagram for iWidgetToolbar:

Detailed Description

Toolbar widget interface.

General
virtual void	SetHeight (ni::tF32 afHeight)=0
	Set the toolbar's height in pixels. {Property}. More...

virtual ni::tF32	GetHeight () const =0
	Get the toolbar's height. {Property}. More...

virtual void	SetAutoHide (ni::tBool abAutoHide)=0
	Set whether the toolbar should auto-hide. {Property}. More...

virtual ni::tBool	GetAutoHide () const =0
	Get whether the toolbar should auto-hide. {Property}. More...

virtual void	SetAutoHideBackground (ni::tBool abAutoHide)=0
	Set whether the toolbar should draw the bottom background when unfolded in auto-hide mode. {Property}. More...

virtual ni::tBool	GetAutoHideBackground () const =0
	Get whether the toolbar should draw the bottom background when unfolded in auto-hide mode. {Property}. More...

virtual void	SetShowPage (ni::tBool abShowPage)=0
	Set whether the toolbar's active page should be visible. {Property}. More...

virtual ni::tBool	GetShowPage () const =0
	Get whether the toolbar's active page is visible. {Property}. More...

virtual iWidget *	GetTopBar () const =0
	Get the top bar widget. {Property}. More...

virtual iWidget *	GetBottomBar () const =0
	Get the bottom bar widget. {Property}. More...

virtual void	SetCommandDestination (iMessageHandler *apMH)=0
	Set the destination message target for the commands received by the toolbar. {Property}. More...

virtual iMessageHandler *	GetCommandDestination () const =0
	Get the destination message for the commands received by the toolbar. {Property}. More...

virtual void	UpdateToolbar ()=0
	Updates the toolbar. More...

virtual void	HidePopup ()=0
	Hide the toolbar pop-up. More...

Pages
virtual ni::tU32	GetNumPages () const =0
	Get the number of pages in the toolbar. {Property}. More...

virtual ni::iWidget *	GetPageWidget (ni::tU32 anIndex) const =0
	Get the widget of the page at the specified index. {Property}. More...

virtual ni::tU32	GetPageIndex (ni::iHString *ahspID) const =0
	Get the index of the page with the specified ID. {Property}. More...

virtual iWidget *	InitPage (iHString ahspID, iHString ahspName)=0
	Initialize/Add a toolbar with the specified ID and name. More...

virtual ni::tBool	SetPageName (iHString ahspID, iHString ahspName)=0
	Set the name/title of the specified page. {Property}. More...

virtual iHString *	GetPageName (iHString *ahspID) const =0
	Get the name/title of the specified page. {Property}. More...

virtual ni::tBool	SetPageEnabled (iHString *ahspID, tBool abEnabled)=0
	Set whether the specifed page is enabled. {Property}. More...

virtual ni::tBool	GetPageEnabled (iHString *ahspID) const =0
	Get whether the specifed page is enabled. {Property}. More...

virtual ni::tBool	SetActivePageIndex (ni::tU32 anActivePage)=0
	Set the active's page index. {Property}. More...

virtual ni::tU32	GetActivePageIndex () const =0
	Get the active's pages index. {Property}. More...

virtual ni::tBool	SetActivePageID (ni::iHString *ahspID)=0
	Set the active's page ID. {Property}. More...

virtual ni::iHString *	GetActivePageID () const =0
	Get the active's page ID. {Property}. More...

Top bar
virtual tU32	GetNumTopWidgets () const =0
	Get the number of widgets in the top bar. {Property}. More...

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

virtual tU32	GetTopWidgetIndex (iWidget *apWidget) const =0
	Get the index of the specified top bar widget. {Property}. More...

virtual iWidget *	GetTopWidgetFromID (iHString *ahspID) const =0
	Get the top bar widget with the specified ID. {Property}. More...

virtual tBool	SetTopWidgetCommandDestination (tU32 anIndex, iMessageHandler *apCmdDest)=0
	Set the command destination of the specified top widget. {Property}. More...

virtual iMessageHandler *	GetTopWidgetCommandDestination (tU32 anIndex) const =0
	Get the command destination of the specified top widget. {Property}. More...

virtual tBool	AddTopWidget (iWidget apWidget, tF32 afWidth, iMessageHandler apCmdDest)=0
	Add a top bar widget. More...

Groups
virtual iWidget *	AddGroup (iHString ahspPageID, iHString ahspPageName, iHString ahspGroupID, iHString ahspGroupName, iMessageHandler *apCmdDest)=0
	Add a group in the specified page. If the page doesn't already exist it is added. More...

virtual iWidget *	GetGroup (ni::iHString *ahspID) const =0
	Get the group with the specified ID. {Property}. More...

virtual tBool	RemoveGroup (ni::iHString *ahspID)=0
	Remove the specified group. 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 void SetHeight ( ni::tF32 afHeight )

pure virtual

Set the toolbar's height in pixels. {Property}.

Remarks: Default is 120 pixels.

virtual ni::tF32 GetHeight ( ) const

pure virtual

Get the toolbar's height. {Property}.

virtual void SetAutoHide ( ni::tBool abAutoHide )

pure virtual

Set whether the toolbar should auto-hide. {Property}.

Remarks: Default is true.

virtual ni::tBool GetAutoHide ( ) const

pure virtual

Get whether the toolbar should auto-hide. {Property}.

virtual void SetAutoHideBackground ( ni::tBool abAutoHide )

pure virtual

Set whether the toolbar should draw the bottom background when unfolded in auto-hide mode. {Property}.

Remarks: Default is false.

virtual ni::tBool GetAutoHideBackground ( ) const

pure virtual

Get whether the toolbar should draw the bottom background when unfolded in auto-hide mode. {Property}.

virtual void SetShowPage ( ni::tBool abShowPage )

pure virtual

Set whether the toolbar's active page should be visible. {Property}.

virtual ni::tBool GetShowPage ( ) const

pure virtual

Get whether the toolbar's active page is visible. {Property}.

virtual iWidget* GetTopBar ( ) const

pure virtual

Get the top bar widget. {Property}.

virtual iWidget* GetBottomBar ( ) const

pure virtual

Get the bottom bar widget. {Property}.

virtual void SetCommandDestination ( iMessageHandler * apMH )

pure virtual

Set the destination message target for the commands received by the toolbar. {Property}.

Remarks: Set to eInvalidHandle to disable.

virtual iMessageHandler* GetCommandDestination ( ) const

pure virtual

Get the destination message for the commands received by the toolbar. {Property}.

virtual void UpdateToolbar ( )

pure virtual

Updates the toolbar.

Remarks: Removes all empty or invalid pages, removes all invalid top widgets and recomputes the layout.; Should be called after invalidating any toolbar group.

virtual void HidePopup ( )

pure virtual

Hide the toolbar pop-up.

Remarks: Hides the toolbar pop-up shown in "AutoHide" mode.

virtual ni::tU32 GetNumPages ( ) const

pure virtual

Get the number of pages in the toolbar. {Property}.

virtual ni::iWidget* GetPageWidget ( ni::tU32 anIndex ) const

pure virtual

Get the widget of the page at the specified index. {Property}.

virtual ni::tU32 GetPageIndex ( ni::iHString * ahspID ) const

pure virtual

Get the index of the page with the specified ID. {Property}.

virtual iWidget* InitPage	(	iHString *	ahspID,
		iHString *	ahspName
	)

pure virtual

Initialize/Add a toolbar with the specified ID and name.

Remarks: Empty and invalid pages are removed automatically when UpdateToolbar is called.

virtual ni::tBool SetPageName	(	iHString *	ahspID,
		iHString *	ahspName
	)

pure virtual

Set the name/title of the specified page. {Property}.

virtual iHString* GetPageName ( iHString * ahspID ) const

pure virtual

Get the name/title of the specified page. {Property}.

virtual ni::tBool SetPageEnabled	(	iHString *	ahspID,
		tBool	abEnabled
	)

pure virtual

Set whether the specifed page is enabled. {Property}.

virtual ni::tBool GetPageEnabled ( iHString * ahspID ) const

pure virtual

Get whether the specifed page is enabled. {Property}.

virtual ni::tBool SetActivePageIndex ( ni::tU32 anActivePage )

pure virtual

Set the active's page index. {Property}.

virtual ni::tU32 GetActivePageIndex ( ) const

pure virtual

Get the active's pages index. {Property}.

virtual ni::tBool SetActivePageID ( ni::iHString * ahspID )

pure virtual

Set the active's page ID. {Property}.

virtual ni::iHString* GetActivePageID ( ) const

pure virtual

Get the active's page ID. {Property}.

virtual tU32 GetNumTopWidgets ( ) const

pure virtual

Get the number of widgets in the top bar. {Property}.

virtual iWidget* GetTopWidget ( tU32 anIndex ) const

pure virtual

Get the top bar widget at the specified index. {Property}.

virtual tU32 GetTopWidgetIndex ( iWidget * apWidget ) const

pure virtual

Get the index of the specified top bar widget. {Property}.

virtual iWidget* GetTopWidgetFromID ( iHString * ahspID ) const

pure virtual

Get the top bar widget with the specified ID. {Property}.

virtual tBool SetTopWidgetCommandDestination	(	tU32	anIndex,
		iMessageHandler *	apCmdDest
	)

pure virtual

Set the command destination of the specified top widget. {Property}.

virtual iMessageHandler* GetTopWidgetCommandDestination ( tU32 anIndex ) const

pure virtual

Get the command destination of the specified top widget. {Property}.

virtual tBool AddTopWidget	(	iWidget *	apWidget,
		tF32	afWidth,
		iMessageHandler *	apCmdDest
	)

pure virtual

Add a top bar widget.

Remarks: Invalid top bar widgets are removed automatically when UpdateToolbar is called.

virtual iWidget* AddGroup	(	iHString *	ahspPageID,
		iHString *	ahspPageName,
		iHString *	ahspGroupID,
		iHString *	ahspGroupName,
		iMessageHandler *	apCmdDest
	)

pure virtual

Add a group in the specified page. If the page doesn't already exist it is added.

Remarks: Calls UpdateToolbar

virtual iWidget* GetGroup ( ni::iHString * ahspID ) const

pure virtual

Get the group with the specified ID. {Property}.

virtual tBool RemoveGroup ( ni::iHString * ahspID )

pure virtual

Remove the specified group.

Remarks: Calls UpdateToolbar

Detailed Description

General

Pages

Top bar

Groups

Additional Inherited Members

Member Function Documentation