Collapse all Symbian^3 Application Developer Library

CGSTabHelper Class Reference

class CGSTabHelper : public CBase

CGSTabHelper is used to create dynamic tabs from either

CGSPluginInterface* array (plugins)
MGSTabbedView* interface Array (local views owned by plugin).

How to use:

1. Call CreateTabGroupL() from the plugin's/view's DoActivate(). Providing an array of all the plugins/views which should be in the tab group including the plugin/view itself.

2. Call RemoveTabGroup() from the plugin's/view's DoDeactivate().

3. It is recommended to use CGSTabHelper* as an member variable owned by the plugin/view class.

GSFramework.lib

Since: Series60_3.1

Inherits from

CGSTabHelper
- CBase

Public Member Functions
	~CGSTabHelper ()
IMPORT_C void	CreateTabGroupL ( TUid , MGSTabbedViewOwner *)
IMPORT_C void	CreateTabGroupL ( TUid , CArrayPtrFlat < CGSPluginInterface > *)
IMPORT_C void	CreateTabGroupL ( TUid , CArrayPtrFlat < MGSTabbedView > *)
IMPORT_C CGSTabHelper *	NewL ()
IMPORT_C CGSTabHelper *	NewLC ()
IMPORT_C void	RemoveTabGroup ()
IMPORT_C void	TabChangedL ( TInt )

Protected Member Functions
	CGSTabHelper ()
void	ConstructL ()

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()

Private Attributes
CAknViewAppUi *	iAppUi
CAknNavigationControlContainer *	iNaviContainer
CAknNavigationDecorator *	iNaviDecorator
CAknTabGroup *	iTabGroup
MGSTabbedViewOwner *	iTabOwner

Constructor & Destructor Documentation

CGSTabHelper()

CGSTabHelper

(

)

[protected]

C++ default constructor.

~CGSTabHelper()

IMPORT_C

~CGSTabHelper

(

)

Destructor.

Member Functions Documentation

ConstructL()

void

ConstructL

(

)

[protected]

Symbian OS default constructor.

CreateTabGroupL(TUid, MGSTabbedViewOwner *)

IMPORT_C void	CreateTabGroupL	(	TUid	aActiveViewUid,
			MGSTabbedViewOwner *	aTabOwner
		)

This function is for views implementing MGSTabbedViewOwner . Such may be needed in case view needs to update its selected item according to tab selection.

Creates and adds a tab group to navipane. The number of visible tabs is 4 unless there are less tabbed views in which case the number of tabs equal the number of tabbed views.

Parameters

TUid aActiveViewUid	UID of the view whose tab should be activated when the tab group is added to the navi pane.
MGSTabbedViewOwner * aTabOwner	Reference to the owner of the tabbed views.

CreateTabGroupL(TUid, CArrayPtrFlat< CGSPluginInterface > *)

IMPORT_C void	CreateTabGroupL	(	TUid	aActiveViewUid,
			CArrayPtrFlat < CGSPluginInterface > *	aTabbedViews
		)

This function is for plugin implementation.

Creates and adds a tab group to navipane. The number of visible tabs is 4 unless there are less tabbed views in which case the number of tabs equal the number of tabbed views.

Parameters

TUid aActiveViewUid	UID of the view whose tab should be activated when the tab group is added to the navi pane.
CArrayPtrFlat < CGSPluginInterface > * aTabbedViews	References to the views which belong to the tab group.

CreateTabGroupL(TUid, CArrayPtrFlat< MGSTabbedView > *)

IMPORT_C void	CreateTabGroupL	(	TUid	aActiveViewUid,
			CArrayPtrFlat < MGSTabbedView > *	aTabbedViews
		)

This function is for local view implementation.

Creates and adds a tab group to navipane. The number of visible tabs is 4 unless there are less tabbed views in which case the number of tabs equal the number of tabbed views.

Parameters

TUid aActiveViewUid	UID of the view whose tab should be activated when the tab group is added to the navi pane.
CArrayPtrFlat < MGSTabbedView > * aTabbedViews	References to the views which belong to the tab group.

NewL()

IMPORT_C CGSTabHelper *

NewL

(

)

[static]

Symbian OS two-phased constructor

NewLC()

IMPORT_C CGSTabHelper *

NewLC

(

)

[static]

Symbian OS two-phased constructor

RemoveTabGroup()

IMPORT_C void

RemoveTabGroup

(

)

Removes the topmost tab group from navi pane.

TabChangedL(TInt)

IMPORT_C void

TabChangedL

(

TInt

aIndex

)

See base class.

Parameters

TInt aIndex

Member Data Documentation

CAknViewAppUi * iAppUi

CAknViewAppUi *

iAppUi

[private]

CAknNavigationControlContainer * iNaviContainer

CAknNavigationControlContainer *

iNaviContainer

[private]

CAknNavigationDecorator * iNaviDecorator

CAknNavigationDecorator *

iNaviDecorator

[private]

CAknTabGroup * iTabGroup

CAknTabGroup *

iTabGroup

[private]

MGSTabbedViewOwner * iTabOwner

MGSTabbedViewOwner *

iTabOwner

[private]