Inheritance diagram for iWidgetTab:

Detailed Description

Tab widget.

Page management
virtual void	AddPage (iHString ahspName, iWidget apPage)=0
	Add a page. More...

virtual tBool	RemovePage (iWidget *apPage)=0
	Remove a page. More...

virtual tBool	HasPage (iWidget *apPage) const =0
	Check if the specified page is in the tab. More...

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

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

virtual iWidget *	GetPageButton (tU32 anIndex) const =0
	Get the button associated with the page at the specified index. {Property}. More...

virtual iWidget *	GetPageFromName (iHString *ahspName) const =0
	Get the page with the specified name. {Property}. More...

virtual iWidget *	GetPageFromID (iHString *ahspID) const =0
	Get the page with the specified ID. {Property}. More...

virtual tBool	SetPageName (iWidget apPage, iHString ahspName)=0
	Set the name of the specified page. {Property}. More...

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

virtual tBool	SetPageIndex (iWidget *apPage, tU32 anIndex)=0
	Set the index of the specified page. {Property}. More...

virtual tU32	GetPageIndex (iWidget *apPage) const =0
	Get the index of the specified page. {Property}. More...

virtual tBool	MovePageLeft (iWidget *apPage, tU32 anLeft)=0
	Move the specified type to the left. More...

virtual tBool	MovePageRight (iWidget *apPage, tU32 anCount)=0
	Move the specified type to the right. More...

virtual void	SetMinNumPagesToShowTabs (tU32 anMinNumPages)=0
	Set the number of pages necessary to show the tabs. {Property}. More...

virtual tU32	GetMinNumPagesToShowTabs () const =0
	Get the number of pages necessary to show the tabs. {Property}. More...

Active page
virtual tBool	SetActivePage (iWidget *apPage)=0
	Activate the specified page. {Property}. More...

virtual iWidget *	GetActivePage () const =0
	Get the active page. {Property}. More...

virtual tBool	SetActivePageName (iHString *ahspName)=0
	Activate the page with the specified name. {Property}. More...

virtual iHString *	GetActivePageName () const =0
	Get the name of the active page. {Property}. More...

virtual tBool	SetActivePageIndex (tU32 anIndex)=0
	Activate the page with the specified index. {Property}. More...

virtual tU32	GetActivePageIndex () const =0
	Get the index of the active page. {Property}. More...

virtual tBool	SetActivePageID (iHString *ahspName)=0
	Activate the page with the specified id. {Property}. More...

virtual iHString *	GetActivePageID () const =0
	Get the id of the active page. {Property}. More...

virtual void	SetForceActivated (tBool abForce)=0
	Set the forced activated state. {Property}. More...

virtual tBool	GetForceActivated (tBool abForce) const =0
	Get the forced activated state. {Property}. 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 AddPage	(	iHString *	ahspName,
		iWidget *	apPage
	)

pure virtual

Add a page.

virtual tBool RemovePage ( iWidget * apPage )

pure virtual

Remove a page.

virtual tBool HasPage ( iWidget * apPage ) const

pure virtual

Check if the specified page is in the tab.

virtual tU32 GetNumPages ( ) const

pure virtual

Get the number of pages. {Property}.

virtual iWidget* GetPage ( tU32 anIndex ) const

pure virtual

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

virtual iWidget* GetPageButton ( tU32 anIndex ) const

pure virtual

Get the button associated with the page at the specified index. {Property}.

virtual iWidget* GetPageFromName ( iHString * ahspName ) const

pure virtual

Get the page with the specified name. {Property}.

virtual iWidget* GetPageFromID ( iHString * ahspID ) const

pure virtual

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

virtual tBool SetPageName	(	iWidget *	apPage,
		iHString *	ahspName
	)

pure virtual

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

virtual iHString* GetPageName ( iWidget * apPage ) const

pure virtual

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

virtual tBool SetPageIndex	(	iWidget *	apPage,
		tU32	anIndex
	)

pure virtual

Set the index of the specified page. {Property}.

Remarks: Will swap with the page at the specified index.

virtual tU32 GetPageIndex ( iWidget * apPage ) const

pure virtual

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

virtual tBool MovePageLeft	(	iWidget *	apPage,
		tU32	anLeft
	)

pure virtual

Move the specified type to the left.

virtual tBool MovePageRight	(	iWidget *	apPage,
		tU32	anCount
	)

pure virtual

Move the specified type to the right.

virtual void SetMinNumPagesToShowTabs ( tU32 anMinNumPages )

pure virtual

Set the number of pages necessary to show the tabs. {Property}.

Remarks: Default is two. If set to <= 1 when any page is added the tabs are displayed, otherwise can be set to 2 for example to show the tab page only if they are at least two pages visible.

virtual tU32 GetMinNumPagesToShowTabs ( ) const

pure virtual

Get the number of pages necessary to show the tabs. {Property}.

virtual tBool SetActivePage ( iWidget * apPage )

pure virtual

Activate the specified page. {Property}.

virtual iWidget* GetActivePage ( ) const

pure virtual

Get the active page. {Property}.

virtual tBool SetActivePageName ( iHString * ahspName )

pure virtual

Activate the page with the specified name. {Property}.

virtual iHString* GetActivePageName ( ) const

pure virtual

Get the name of the active page. {Property}.

virtual tBool SetActivePageIndex ( tU32 anIndex )

pure virtual

Activate the page with the specified index. {Property}.

virtual tU32 GetActivePageIndex ( ) const

pure virtual

Get the index of the active page. {Property}.

virtual tBool SetActivePageID ( iHString * ahspName )

pure virtual

Activate the page with the specified id. {Property}.

virtual iHString* GetActivePageID ( ) const

pure virtual

Get the id of the active page. {Property}.

virtual void SetForceActivated ( tBool abForce )

pure virtual

Set the forced activated state. {Property}.

virtual tBool GetForceActivated ( tBool abForce ) const

pure virtual

Get the forced activated state. {Property}.

Detailed Description

Page management

Active page

Additional Inherited Members

Member Function Documentation