CAknTabGroup Class Reference

class CAknTabGroup : public CAknControl

Tab group functionality for navigation pane.

avkon.lib
Since
0.9

Inherits from

Public Member Functions
~CAknTabGroup()
IMPORT_C TIntActiveTabId()
IMPORT_C TIntActiveTabIndex()
IMPORT_C TIntAddTabL(TResourceReader &)
IMPORT_C voidAddTabL(TInt, const TDesC &)
IMPORT_C voidAddTabL(TInt, const TDesC &, const CFbsBitmap *, const CFbsBitmap *)
IMPORT_C voidAddTabL(TInt, const CFbsBitmap *, const CFbsBitmap *)
IMPORT_C voidDeleteTabL(TInt)
IMPORT_C voidDimTab(TInt, TBool)
IMPORT_C voidGetColorUseListL(CArrayFix< TCoeColorUse > &)
IMPORT_C voidHandleControlEventL(CCoeControl *, TCoeEvent)
IMPORT_C voidHandleNaviDecoratorEventL(TInt)
IMPORT_C voidHandlePointerEventL(const TPointerEvent &)
voidHandleResourceChange(TInt)
IMPORT_C TBoolIsTabDimmed(TInt)
IMPORT_C TSizeMinimumSize()
IMPORT_C CAknTabGroup *NewL(const CCoeControl &)
IMPORT_C CAknTabGroup *NewLC(const CCoeControl &)
IMPORT_C TKeyResponseOfferKeyEventL(const TKeyEvent &, TEventCode)
IMPORT_C voidPrepareContext(CWindowGc &)
IMPORT_C voidReplaceTabL(TResourceReader &)
IMPORT_C voidReplaceTabL(TInt, const TDesC &)
IMPORT_C voidReplaceTabL(TInt, const TDesC &, const CFbsBitmap *, const CFbsBitmap *)
IMPORT_C voidReplaceTabL(TInt, const CFbsBitmap *, const CFbsBitmap *)
IMPORT_C voidReplaceTabTextL(TInt, const TDesC &)
IMPORT_C voidSetActiveTabById(TInt)
IMPORT_C voidSetActiveTabByIndex(TInt)
voidSetDecoratorLayout(TBool)
voidSetNarrowTabLayoutL(TBool, TBool)
voidSetNaviArrowsVisible(TBool)
IMPORT_C voidSetObserver(MAknTabObserver *)
IMPORT_C voidSetTabFixedWidthL(TInt)
IMPORT_C voidSetTabMultiColorMode(TInt, TBool)
IMPORT_C TIntTabCount()
IMPORT_C TIntTabIdFromIndex(TInt)
IMPORT_C TIntTabIndexFromId(TInt)
Protected Member Functions
IMPORT_C CCoeControl *ComponentControl(TInt)
IMPORT_C TIntCountComponentControls()
IMPORT_C voidFocusChanged(TDrawNow)
voidReverseTabOrderL()
IMPORT_C voidSizeChanged()
Private Member Functions
CAknTabGroup()
voidCancelTabAnimationEventTimer()
voidCommonAddTabL(CAknTab *)
voidCommonReplaceTabL(CAknTab *)
voidConstructL()
TInt ConvertTabIndex(TInt)
voidCurrentLayout(TAknWindowLineLayout &)
TBool CycleFocus(TDirection, TDrawNow)
voidDoDrawLowerBorder()
voidDoTabAnimationEvent()
IMPORT_C voidDraw(const TRect &)
voidDrawLowerBorder(TDrawNow)
IMPORT_C void *ExtensionInterface(TUid)
voidHandleTabStateChanged(CCoeControl *)
TInt Index(TInt)
voidInitTabAnimationEventTimer()
voidInitTabAnimationL()
voidInitTabGroupGraphicsL()
TInt LeftMostTabIndex()
voidLoadTabBitmapsL(TInt, TBool)
TBool NarrowTabLayout()
TBool NarrowTabLayoutNext()
TRect ParentRect(TBool)
voidReportNavigationEvent()
IMPORT_C voidReserved1()
IMPORT_C voidReserved2()
IMPORT_C voidReserved3()
TInt RightMostTabIndex()
voidSizeChangedInFlatLayout()
voidSizeChangedInNarrowLayout()
voidSizeChangedInNormalLayout()
voidStartCycleAnimationL(TDirection, TInt)
voidSwitchTabLayoutL()
TInt TabAnimationEvent(TAny *)
TBool TabsVisibleInCurrentLayout()
Inherited Functions
CAknControl::CAknControl()
CAknControl::~CAknControl()
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()
CCoeControl::AccumulatedZoom()const
CCoeControl::ActivateGc()const
CCoeControl::ActivateL()
CCoeControl::BackedUpWindow()const
CCoeControl::Background()const
CCoeControl::CCoeControl()
CCoeControl::CCoeControl(CCoeEnv *)
CCoeControl::CCoeControl(const CCoeControl &)
CCoeControl::CapturesPointer()const
CCoeControl::ClaimPointerGrab(TBool)
CCoeControl::ClaimPointerGrab(TInt,TBool)
CCoeControl::CloseWindow()
CCoeControl::ComponentArrayExists()const
CCoeControl::Components()
CCoeControl::Components()const
CCoeControl::ConstructFromResourceL(TResourceReader &)
CCoeControl::ControlContext()const
CCoeControl::ControlEnv()const
CCoeControl::CopyControlContextFrom(const CCoeControl *)
CCoeControl::CreateBackedUpWindowL(RWindowTreeNode &)
CCoeControl::CreateBackedUpWindowL(RWindowTreeNode &,TDisplayMode)
CCoeControl::CreateWindowL()
CCoeControl::CreateWindowL(RWindowGroup *)
CCoeControl::CreateWindowL(RWindowTreeNode &)
CCoeControl::CreateWindowL(const CCoeControl *)
CCoeControl::CustomGc()const
CCoeControl::DeactivateGc()const
CCoeControl::DrawBackground(const TRect &)const
CCoeControl::DrawDeferred()const
CCoeControl::DrawForeground(const TRect &)const
CCoeControl::DrawNow()const
CCoeControl::DrawNow(const TRect &)const
CCoeControl::DrawableWindow()const
CCoeControl::EnableDragEvents()
CCoeControl::EnableReportControlStateChange(TBool)
CCoeControl::EnableWindowTransparency()
CCoeControl::FindBackground()const
CCoeControl::FindFontProvider()const
CCoeControl::GetColor(TInt,TRgb &)const
CCoeControl::GetGc()const
CCoeControl::GetHelpContext(TCoeHelpContext &)const
CCoeControl::GrabbingComponent()const
CCoeControl::GrabbingComponent(TInt)const
CCoeControl::HandleComponentControlsResourceChange(TInt)
CCoeControl::HandleControlArrayEventL(CCoeControlArray::TEvent,const CCoeControlArray *,CCoeControl *,TInt)
CCoeControl::HandlePointerBufferReadyL()
CCoeControl::HandleRedrawEvent(const TRect &)const
CCoeControl::HasBorder()const
CCoeControl::HitTest()const
CCoeControl::IgnoreEventsUntilNextPointerUp()
CCoeControl::Index(const CCoeControl *)const
CCoeControl::InitComponentArrayL()
CCoeControl::InputCapabilities()const
CCoeControl::IsActivated()const
CCoeControl::IsBackedUp()const
CCoeControl::IsBeingDestroyed()const
CCoeControl::IsBlank()const
CCoeControl::IsDimmed()const
CCoeControl::IsFocused()const
CCoeControl::IsNonFocusing()const
CCoeControl::IsReadyToDraw()const
CCoeControl::IsVisible()const
CCoeControl::LayoutManager()const
CCoeControl::MakeVisible(TBool)
CCoeControl::MaximumWidth()const
CCoeControl::MopSupplyObject(TTypeUid)
CCoeControl::NotifyFontChange(const CCoeFontProvider *)
CCoeControl::Observer()const
CCoeControl::OverrideColorL(TInt,TRgb)
CCoeControl::OwnsWindow()const
CCoeControl::Parent()
CCoeControl::Parent()const
CCoeControl::Position()const
CCoeControl::PositionChanged()
CCoeControl::PositionRelativeToScreen()const
CCoeControl::PrepareForFocusGainL()
CCoeControl::PrepareForFocusLossL()
CCoeControl::ProcessPointerBufferReadyL()
CCoeControl::ProcessPointerEventL(const TPointerEvent &)
CCoeControl::Rect()const
CCoeControl::RecursivelyMergeInputCapabilities(TCoeInputCapabilities &)const
CCoeControl::RecursivelyMergedInputCapabilities()const
CCoeControl::RefetchPixelMappingL()
CCoeControl::RemoveFromParent()
CCoeControl::ReportEventL(MCoeControlObserver::TCoeEvent)
CCoeControl::RequestRelayout(const CCoeControl *)
CCoeControl::ResetGc()const
CCoeControl::ScreenFont(const TCoeFont &)const
CCoeControl::SetAdjacent(TInt)
CCoeControl::SetAllowStrayPointers()
CCoeControl::SetBackground(const MCoeControlBackground *)
CCoeControl::SetBlank()
CCoeControl::SetCanDrawOutsideRect()
CCoeControl::SetComponentsToInheritVisibility(TBool)
CCoeControl::SetContainerWindowL(RBackedUpWindow &)
CCoeControl::SetContainerWindowL(RWindow &)
CCoeControl::SetContainerWindowL(const CCoeControl &)
CCoeControl::SetControlContext(MCoeControlContext *)
CCoeControl::SetCornerAndSize(TGulAlignment,const TSize &)
CCoeControl::SetCustomGc(CWindowGc *)
CCoeControl::SetDimmed(TBool)
CCoeControl::SetExtent(const TPoint &,const TSize &)
CCoeControl::SetExtentToWholeScreen()
CCoeControl::SetFocus(TBool,TDrawNow)
CCoeControl::SetFocusing(TBool)
CCoeControl::SetFontProviderL(const CCoeFontProvider &)
CCoeControl::SetGc(CWindowGc *)const
CCoeControl::SetGloballyCapturing(TBool)
CCoeControl::SetHitTest(const MCoeControlHitTest *)
CCoeControl::SetLayoutManagerL(MCoeLayoutManager *)
CCoeControl::SetMaximumWidth(TInt)
CCoeControl::SetMopParent(MObjectProvider *)
CCoeControl::SetNeighbor(CCoeControl *)
CCoeControl::SetNonFocusing()
CCoeControl::SetObserver(MCoeControlObserver *)
CCoeControl::SetParent(CCoeControl *)
CCoeControl::SetPointerCapture(TBool)
CCoeControl::SetPosition(const TPoint &)
CCoeControl::SetRect(const TRect &)
CCoeControl::SetSize(const TSize &)
CCoeControl::SetSizeWithoutNotification(const TSize &)
CCoeControl::SetTextBaselineSpacing(TInt)
CCoeControl::SetUniqueHandle(TInt)
CCoeControl::SetZoomFactorL(TInt,TZoomType)
CCoeControl::Size()const
CCoeControl::SystemGc()const
CCoeControl::TextBaselineOffset(const TSize &)const
CCoeControl::TextDrawer(TInt)const
CCoeControl::UniqueHandle()const
CCoeControl::Window()const
CCoeControl::WriteInternalStateL(RWriteStream &)const
CCoeControl::WriteInternalStateNowL(RWriteStream &)const
CCoeControl::ZoomWithType()const
CCoeControl::operator=(const CCoeControl &)
CCoeControl::~CCoeControl()
Public Member Enumerations
enumTDirection { ELeft, ERight }
Inherited Enumerations
CCoeControl:TZoomType
Private Attributes
TInt iActiveTab
TInt iBitmapMaskNames
TInt iBitmapNames
CAknTabGroupExtension *iExtension
TInt iFirstShownTab
TBool iLongTabs
TBool iMirrored
TInt iNumberOfTabsShown
TRect iSpareRect
CArrayPtr< CAknTab > *iTabArray
CFbsBitmap *iTabBitmaps
TInt iTabFixedWidth
CFbsBitmap *iTabMaskBitmaps
MAknTabObserver *iTabObserver
Inherited Attributes
CCoeControl::iCoeEnv
CCoeControl::iContext
CCoeControl::iPosition
CCoeControl::iSize

Constructor & Destructor Documentation

CAknTabGroup()

IMPORT_CCAknTabGroup()[private]

~CAknTabGroup()

IMPORT_C~CAknTabGroup()

Destructor.

Member Functions Documentation

ActiveTabId()

IMPORT_C TIntActiveTabId()const

Returns the ID of the currently active (highlighted) tab.

ActiveTabIndex()

IMPORT_C TIntActiveTabIndex()const

Returns the index of the currently active (highlighted) tab.

AddTabL(TResourceReader &)

IMPORT_C TIntAddTabL(TResourceReader &aReader)

Add a tab to the tab group from resources.

Parameters

TResourceReader & aReaderResource reader.

AddTabL(TInt, const TDesC &)

IMPORT_C voidAddTabL(TIntaTabId,
const TDesC &aText
)

Add a tab to the tab group.

Parameters

TInt aTabIdID of the tab to be added.
const TDesC & aText

AddTabL(TInt, const TDesC &, const CFbsBitmap *, const CFbsBitmap *)

IMPORT_C voidAddTabL(TIntaTabId,
const TDesC &aText,
const CFbsBitmap *aTabBitmap,
const CFbsBitmap *aMask = NULL
)

Add a tab to the tab group.

Parameters

TInt aTabIdID of the tab.
const TDesC & aText
const CFbsBitmap * aTabBitmapBitmap for the tab. Ownership of the bitmap is taken.
const CFbsBitmap * aMask = NULLBitmap's mask. Ownership of the mask is taken.

AddTabL(TInt, const CFbsBitmap *, const CFbsBitmap *)

IMPORT_C voidAddTabL(TIntaTabId,
const CFbsBitmap *aTabBitmap,
const CFbsBitmap *aMask = NULL
)

Add a tab to the tab group.

Parameters

TInt aTabIdID of the tab.
const CFbsBitmap * aTabBitmapBitmap for the tab. Ownership of the bitmap is taken.
const CFbsBitmap * aMask = NULLBitmap's mask. Ownership of the mask is taken.

CancelTabAnimationEventTimer()

voidCancelTabAnimationEventTimer()[private]

CommonAddTabL(CAknTab *)

voidCommonAddTabL(CAknTab *aTab)[private]

Parameters

CAknTab * aTab

CommonReplaceTabL(CAknTab *)

voidCommonReplaceTabL(CAknTab *aTab)[private]

Parameters

CAknTab * aTab

ComponentControl(TInt)

IMPORT_C CCoeControl *ComponentControl(TIntaIndex)const [protected, virtual]

Returns a component control determined by control index.

Parameters

TInt aIndexIndex of a control to be returned.

ConstructL()

voidConstructL()[private]

ConvertTabIndex(TInt)

TInt ConvertTabIndex(TIntaIndex)const [private]

Tab groups can be mirrored depending on current locale. To client application everything always seems like tabs are not mirrored but the internal order of tabs in tab group may or may not be mirrored. If mirroring is off then this function just returns given parameter as it is. If mirroring is on then this function returns unmirrored index if given index was mirrord and vice versa. Two nested calls to this function cancels its effect (ConvertTabIndex(ConvertTabIndex(aIndex)) == aIndex).

Parameters

TInt aIndexIndex to be converted.

CountComponentControls()

IMPORT_C TIntCountComponentControls()const [protected, virtual]

Returns number of controls inside this control.

CurrentLayout(TAknWindowLineLayout &)

voidCurrentLayout(TAknWindowLineLayout &aLayout)const [private]

Parameters

TAknWindowLineLayout & aLayout

CycleFocus(TDirection, TDrawNow)

TBool CycleFocus(TDirectionaDirection,
TDrawNowaDrawNow
)[private]

Parameters

TDirection aDirection
TDrawNow aDrawNow

DeleteTabL(TInt)

IMPORT_C voidDeleteTabL(TIntaTabId)

Delete a tab from the tab group.

Parameters

TInt aTabIdID of the tab to be deleted.

DimTab(TInt, TBool)

IMPORT_C voidDimTab(TIntaTabId,
TBoolaDimmed
)

Sets a tab dimmed/not dimmed.

Parameters

TInt aTabIdID of the tab.
TBool aDimmedETrue to set the tab dimmed, EFalse otherwise.

DoDrawLowerBorder()

voidDoDrawLowerBorder()const [private]

DoTabAnimationEvent()

voidDoTabAnimationEvent()[private]

Draw(const TRect &)

IMPORT_C voidDraw(const TRect &aRect)const [private, virtual]

Parameters

const TRect & aRect

DrawLowerBorder(TDrawNow)

voidDrawLowerBorder(TDrawNowaDrawNow)const [private]

Parameters

TDrawNow aDrawNow

ExtensionInterface(TUid)

IMPORT_C void *ExtensionInterface(TUidaInterface)[private, virtual]

Virtual method provided to allow extensibility of virtual behaviour

Parameters

TUid aInterface

FocusChanged(TDrawNow)

IMPORT_C voidFocusChanged(TDrawNowaDrawNow)[protected, virtual]

This is called when the focus is changed.

Parameters

TDrawNow aDrawNowWhether or not to draw the control.

GetColorUseListL(CArrayFix< TCoeColorUse > &)

IMPORT_C voidGetColorUseListL(CArrayFix< TCoeColorUse > &aColorUseList)const [virtual]

Gets the list of logical colors employed in the drawing of the control, paired with an explanation of how they are used. Appends the list into aColorUseList.

Parameters

CArrayFix< TCoeColorUse > & aColorUseListThe color list.

HandleControlEventL(CCoeControl *, TCoeEvent)

IMPORT_C voidHandleControlEventL(CCoeControl *aControl,
TCoeEventaEventType
)[virtual]

Handles an event from an observed control.

Parameters

CCoeControl * aControlControl that caused the event.
TCoeEvent aEventTypeType of the event.

HandleNaviDecoratorEventL(TInt)

IMPORT_C voidHandleNaviDecoratorEventL(TIntaEventID)[virtual]

Parameters

TInt aEventID

HandlePointerEventL(const TPointerEvent &)

IMPORT_C voidHandlePointerEventL(const TPointerEvent &aPointerEvent)[virtual]

Handles pointer events in tabs.

Parameters

const TPointerEvent & aPointerEventPointer event to be handled.

HandleResourceChange(TInt)

voidHandleResourceChange(TIntaType)[virtual]

Handles a change to the control's resources.

Parameters

TInt aTypeThe type of resource change.

HandleTabStateChanged(CCoeControl *)

voidHandleTabStateChanged(CCoeControl *aControl)[private]

Parameters

CCoeControl * aControl

Index(TInt)

TInt Index(TIntaTabId)const [private]

Parameters

TInt aTabId

InitTabAnimationEventTimer()

voidInitTabAnimationEventTimer()[private]

InitTabAnimationL()

voidInitTabAnimationL()[private]

InitTabGroupGraphicsL()

voidInitTabGroupGraphicsL()[private]

IsTabDimmed(TInt)

IMPORT_C TBoolIsTabDimmed(TIntaTabId)const [virtual]

Used to check whether or not a tab is dimmed.

Parameters

TInt aTabIdID of the tab.

LeftMostTabIndex()

TInt LeftMostTabIndex()const [private]

LoadTabBitmapsL(TInt, TBool)

voidLoadTabBitmapsL(TIntaNumberOfTabsShown,
TBoolaLongTabs
)[private]

Parameters

TInt aNumberOfTabsShown
TBool aLongTabs

MinimumSize()

IMPORT_C TSizeMinimumSize()[virtual]

Return minimum size of the control.

NarrowTabLayout()

TBool NarrowTabLayout()[private]

NarrowTabLayoutNext()

TBool NarrowTabLayoutNext()[private]

NewL(const CCoeControl &)

IMPORT_C CAknTabGroup *NewL(const CCoeControl &aParent)[static]

Creates new tab group.

Parameters

const CCoeControl & aParentParent control.

NewLC(const CCoeControl &)

IMPORT_C CAknTabGroup *NewLC(const CCoeControl &aParent)[static]

Creates new tab group and pushes it to the clean up stack.

Parameters

const CCoeControl & aParentParent control.

OfferKeyEventL(const TKeyEvent &, TEventCode)

IMPORT_C TKeyResponseOfferKeyEventL(const TKeyEvent &aKeyEvent,
TEventCodeaType
)[virtual]

Handles key events.

Parameters

const TKeyEvent & aKeyEventThe key event.
TEventCode aTypeThe type of the event.

ParentRect(TBool)

TRect ParentRect(TBoolaArrowsUsed)[private, static]

Gets the rectangle for the tab group. If the tab arrows are not shown, then the tab group gets a wider rectangle.

Parameters

TBool aArrowsUsedETrue if tab arrows are shown, EFalse otherwise.

PrepareContext(CWindowGc &)

IMPORT_C voidPrepareContext(CWindowGc &aGc)const [virtual]

Allows to modify graphics context before Draw.

Parameters

CWindowGc & aGcGraphics context to be modified.

ReplaceTabL(TResourceReader &)

IMPORT_C voidReplaceTabL(TResourceReader &aReader)

Replaces a tab with a new one from resources. Tab with same ID is replaced.

Parameters

TResourceReader & aReaderResource reader.

ReplaceTabL(TInt, const TDesC &)

IMPORT_C voidReplaceTabL(TIntaTabId,
const TDesC &aText
)

Replaces a tab with a new one.

Parameters

TInt aTabIdID of the tab to be replaced.
const TDesC & aText

ReplaceTabL(TInt, const TDesC &, const CFbsBitmap *, const CFbsBitmap *)

IMPORT_C voidReplaceTabL(TIntaTabId,
const TDesC &aText,
const CFbsBitmap *aTabBitmap,
const CFbsBitmap *aMask = NULL
)

Replaces a tab with a new one.

Parameters

TInt aTabIdID of the tab to be replaced.
const TDesC & aText
const CFbsBitmap * aTabBitmapBitmap for the tab. Ownership of the bitmap is taken.
const CFbsBitmap * aMask = NULLBitmap's mask. Ownership of the mask is taken.

ReplaceTabL(TInt, const CFbsBitmap *, const CFbsBitmap *)

IMPORT_C voidReplaceTabL(TIntaTabId,
const CFbsBitmap *aTabBitmap,
const CFbsBitmap *aMask = NULL
)

Replaces a tab with a new one.

Parameters

TInt aTabIdID of the tab to be replaced.
const CFbsBitmap * aTabBitmapBitmap for the tab. Ownership of the bitmap is taken.
const CFbsBitmap * aMask = NULLBitmap's mask. Ownership of the mask is taken.

ReplaceTabTextL(TInt, const TDesC &)

IMPORT_C voidReplaceTabTextL(TIntaTabId,
const TDesC &aTabText
)

Replaces a tab text with a new one.

Parameters

TInt aTabIdID of the tab containing the text to be replaced.
const TDesC & aTabTextNew tab text.

ReportNavigationEvent()

voidReportNavigationEvent()[private]

Reserved1()

IMPORT_C voidReserved1()[private, virtual]

Reserved2()

IMPORT_C voidReserved2()[private, virtual]

Reserved3()

IMPORT_C voidReserved3()[private, virtual]

ReverseTabOrderL()

voidReverseTabOrderL()[protected]

Reverse the order of tabs in tab array.

RightMostTabIndex()

TInt RightMostTabIndex()const [private]

SetActiveTabById(TInt)

IMPORT_C voidSetActiveTabById(TIntaTabId)

Activate (highlight) a tab.

Parameters

TInt aTabIdID of the tab to be highlighted.

SetActiveTabByIndex(TInt)

IMPORT_C voidSetActiveTabByIndex(TIntaTabIndex)

Activate (highlight) a tab.

Parameters

TInt aTabIndexIndex of the tab to be highlighted.

SetDecoratorLayout(TBool)

voidSetDecoratorLayout(TBoolaNarrow)

Sets the navigation decorator layout so that it corresponds the current tab group layout.

Parameters

TBool aNarrowETrue if narrow tab group layout is used, EFalse if normal layout is used.

SetNarrowTabLayoutL(TBool, TBool)

voidSetNarrowTabLayoutL(TBoolaNarrow,
TBoolaUseAnimation = EFalse
)

Parameters

TBool aNarrow
TBool aUseAnimation = EFalse

SetNaviArrowsVisible(TBool)

voidSetNaviArrowsVisible(TBoolaVisible)

Parameters

TBool aVisible

SetObserver(MAknTabObserver *)

IMPORT_C voidSetObserver(MAknTabObserver *aObserver)

Sets the tab observer for this tab group.

Parameters

MAknTabObserver * aObserverTab observer to set.

SetTabFixedWidthL(TInt)

IMPORT_C voidSetTabFixedWidthL(TIntaWidth)
Set width of each tab. This width determines what tab layout is used. To get a specific tab layout, use the following constants:
  • KTabWidthWithOneTab One tab layout

  • KTabWidthWithTwoTabs Two tabs layout

  • KTabWidthWithThreeTabs Three tabs layout

  • KTabWidthWithFourTabs Four tabs layout

  • KTabWidthWithTwoLongTabs Two long tabs layout

  • KTabWidthWithThreeLongTabs Three long tabs layout

aknconsts.h.

Parameters

TInt aWidthWidth of each tab,

SetTabMultiColorMode(TInt, TBool)

IMPORT_C voidSetTabMultiColorMode(TIntaTabId,
TBoolaMultiColor
)

Sets the multi-color drawing mode of a tab. This should be called after adding a tab to the tab group if the icon in the tab should be drawn as multi-colored. The tab icon will be drawn using a color specified in the active skin if multi-color mode is not defined.

This function should be called right after a tab containing a multi-color icon is added to the tab group.

Parameters

TInt aTabIdID of the tab.
TBool aMultiColorETrue to set the multi-color mode on, EFalse to turn it off.

SizeChanged()

IMPORT_C voidSizeChanged()[protected, virtual]

Handles the size change events.

SizeChangedInFlatLayout()

voidSizeChangedInFlatLayout()[private]

SizeChangedInNarrowLayout()

voidSizeChangedInNarrowLayout()[private]

SizeChangedInNormalLayout()

voidSizeChangedInNormalLayout()[private]

StartCycleAnimationL(TDirection, TInt)

voidStartCycleAnimationL(TDirectionaDirection,
TIntaNewTab
)[private]

Parameters

TDirection aDirection
TInt aNewTab

SwitchTabLayoutL()

voidSwitchTabLayoutL()[private]

Called on the dynamic layout switch event, switches the current tab layout to a corresponding one that is usable in the new layout.

TabAnimationEvent(TAny *)

TInt TabAnimationEvent(TAny *aPtr)[private, static]

Parameters

TAny * aPtr

TabCount()

IMPORT_C TIntTabCount()const [virtual]

Number of tabs in the tab group.

TabIdFromIndex(TInt)

IMPORT_C TIntTabIdFromIndex(TIntaTabIndex)const [virtual]

Returns the ID of a tab.

Parameters

TInt aTabIndexIndex of a tab.

TabIndexFromId(TInt)

IMPORT_C TIntTabIndexFromId(TIntaTabId)const [virtual]

Returns the index of a tab.

Parameters

TInt aTabIdID of a tab.

TabsVisibleInCurrentLayout()

TBool TabsVisibleInCurrentLayout()const [private]

Member Enumerations Documentation

Enum TDirection

Directions in which the tab group focus can be moved.

Enumerators

ELeft
ERight

Member Data Documentation

TInt iActiveTab

TInt iActiveTab[private]

TInt iBitmapMaskNames

TInt iBitmapMaskNames[private]

TInt iBitmapNames

TInt iBitmapNames[private]

CAknTabGroupExtension * iExtension

CAknTabGroupExtension *iExtension[private]

TInt iFirstShownTab

TInt iFirstShownTab[private]

TBool iLongTabs

TBool iLongTabs[private]

TBool iMirrored

TBool iMirrored[private]

TInt iNumberOfTabsShown

TInt iNumberOfTabsShown[private]

TRect iSpareRect

TRect iSpareRect[private]

CArrayPtr< CAknTab > * iTabArray

CArrayPtr< CAknTab > *iTabArray[private]

CFbsBitmap * iTabBitmaps

CFbsBitmap *iTabBitmaps[private]

TInt iTabFixedWidth

TInt iTabFixedWidth[private]

CFbsBitmap * iTabMaskBitmaps

CFbsBitmap *iTabMaskBitmaps[private]

MAknTabObserver * iTabObserver

MAknTabObserver *iTabObserver[private]