Symbian^3 Application Developer Library >

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 TInt ActiveTabId ()
IMPORT_C TInt ActiveTabIndex ()
IMPORT_C TInt AddTabL ( TResourceReader &)
IMPORT_C void AddTabL ( TInt , const TDesC &)
IMPORT_C void AddTabL ( TInt , const TDesC &, const CFbsBitmap *, const CFbsBitmap *)
IMPORT_C void AddTabL ( TInt , const CFbsBitmap *, const CFbsBitmap *)
IMPORT_C void DeleteTabL ( TInt )
IMPORT_C void DimTab ( TInt , TBool )
IMPORT_C void GetColorUseListL ( CArrayFix < TCoeColorUse > &)
IMPORT_C void HandleControlEventL ( CCoeControl *, TCoeEvent)
IMPORT_C void HandleNaviDecoratorEventL ( TInt )
IMPORT_C void HandlePointerEventL (const TPointerEvent &)
void HandleResourceChange ( TInt )
IMPORT_C TBool IsTabDimmed ( TInt )
IMPORT_C TSize MinimumSize ()
IMPORT_C CAknTabGroup * NewL (const CCoeControl &)
IMPORT_C CAknTabGroup * NewLC (const CCoeControl &)
IMPORT_C TKeyResponse OfferKeyEventL (const TKeyEvent &, TEventCode )
IMPORT_C void PrepareContext ( CWindowGc &)
IMPORT_C void ReplaceTabL ( TResourceReader &)
IMPORT_C void ReplaceTabL ( TInt , const TDesC &)
IMPORT_C void ReplaceTabL ( TInt , const TDesC &, const CFbsBitmap *, const CFbsBitmap *)
IMPORT_C void ReplaceTabL ( TInt , const CFbsBitmap *, const CFbsBitmap *)
IMPORT_C void ReplaceTabTextL ( TInt , const TDesC &)
IMPORT_C void SetActiveTabById ( TInt )
IMPORT_C void SetActiveTabByIndex ( TInt )
void SetDecoratorLayout ( TBool )
void SetNarrowTabLayoutL ( TBool , TBool )
void SetNaviArrowsVisible ( TBool )
IMPORT_C void SetObserver ( MAknTabObserver *)
IMPORT_C void SetTabFixedWidthL ( TInt )
IMPORT_C void SetTabMultiColorMode ( TInt , TBool )
IMPORT_C TInt TabCount ()
IMPORT_C TInt TabIdFromIndex ( TInt )
IMPORT_C TInt TabIndexFromId ( TInt )
Protected Member Functions
IMPORT_C CCoeControl * ComponentControl ( TInt )
IMPORT_C TInt CountComponentControls ()
IMPORT_C void FocusChanged ( TDrawNow )
void ReverseTabOrderL ()
IMPORT_C void SizeChanged ()
Private Member Functions
CAknTabGroup ()
void CancelTabAnimationEventTimer ()
void CommonAddTabL (CAknTab *)
void CommonReplaceTabL (CAknTab *)
void ConstructL ()
TInt ConvertTabIndex ( TInt )
void CurrentLayout ( TAknWindowLineLayout &)
TBool CycleFocus ( TDirection , TDrawNow )
void DoDrawLowerBorder ()
void DoTabAnimationEvent ()
IMPORT_C void Draw (const TRect &)
void DrawLowerBorder ( TDrawNow )
IMPORT_C void * ExtensionInterface ( TUid )
void HandleTabStateChanged ( CCoeControl *)
TInt Index ( TInt )
void InitTabAnimationEventTimer ()
void InitTabAnimationL ()
void InitTabGroupGraphicsL ()
TInt LeftMostTabIndex ()
void LoadTabBitmapsL ( TInt , TBool )
TBool NarrowTabLayout ()
TBool NarrowTabLayoutNext ()
TRect ParentRect ( TBool )
void ReportNavigationEvent ()
IMPORT_C void Reserved1 ()
IMPORT_C void Reserved2 ()
IMPORT_C void Reserved3 ()
TInt RightMostTabIndex ()
void SizeChangedInFlatLayout ()
void SizeChangedInNarrowLayout ()
void SizeChangedInNormalLayout ()
void StartCycleAnimationL ( TDirection , TInt )
void SwitchTabLayoutL ()
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
enum TDirection { 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_C CAknTabGroup ( ) [private]

~CAknTabGroup()

IMPORT_C ~CAknTabGroup ( )

Destructor.

Member Functions Documentation

ActiveTabId()

IMPORT_C TInt ActiveTabId ( ) const

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

ActiveTabIndex()

IMPORT_C TInt ActiveTabIndex ( ) const

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

AddTabL(TResourceReader &)

IMPORT_C TInt AddTabL ( TResourceReader & aReader )

Add a tab to the tab group from resources.

Parameters

TResourceReader & aReader Resource reader.

AddTabL(TInt, const TDesC &)

IMPORT_C void AddTabL ( TInt aTabId,
const TDesC & aText
)

Add a tab to the tab group.

Parameters

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

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

IMPORT_C void AddTabL ( TInt aTabId,
const TDesC & aText,
const CFbsBitmap * aTabBitmap,
const CFbsBitmap * aMask = NULL
)

Add a tab to the tab group.

Parameters

TInt aTabId ID of the tab.
const TDesC & aText
const CFbsBitmap * aTabBitmap Bitmap for the tab. Ownership of the bitmap is taken.
const CFbsBitmap * aMask = NULL Bitmap's mask. Ownership of the mask is taken.

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

IMPORT_C void AddTabL ( TInt aTabId,
const CFbsBitmap * aTabBitmap,
const CFbsBitmap * aMask = NULL
)

Add a tab to the tab group.

Parameters

TInt aTabId ID of the tab.
const CFbsBitmap * aTabBitmap Bitmap for the tab. Ownership of the bitmap is taken.
const CFbsBitmap * aMask = NULL Bitmap's mask. Ownership of the mask is taken.

CancelTabAnimationEventTimer()

void CancelTabAnimationEventTimer ( ) [private]

CommonAddTabL(CAknTab *)

void CommonAddTabL ( CAknTab * aTab ) [private]

Parameters

CAknTab * aTab

CommonReplaceTabL(CAknTab *)

void CommonReplaceTabL ( CAknTab * aTab ) [private]

Parameters

CAknTab * aTab

ComponentControl(TInt)

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

Returns a component control determined by control index.

Parameters

TInt aIndex Index of a control to be returned.

ConstructL()

void ConstructL ( ) [private]

ConvertTabIndex(TInt)

TInt ConvertTabIndex ( TInt aIndex ) 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 aIndex Index to be converted.

CountComponentControls()

IMPORT_C TInt CountComponentControls ( ) const [protected, virtual]

Returns number of controls inside this control.

CurrentLayout(TAknWindowLineLayout &)

void CurrentLayout ( TAknWindowLineLayout & aLayout ) const [private]

Parameters

TAknWindowLineLayout & aLayout

CycleFocus(TDirection, TDrawNow)

TBool CycleFocus ( TDirection aDirection,
TDrawNow aDrawNow
) [private]

Parameters

TDirection aDirection
TDrawNow aDrawNow

DeleteTabL(TInt)

IMPORT_C void DeleteTabL ( TInt aTabId )

Delete a tab from the tab group.

Parameters

TInt aTabId ID of the tab to be deleted.

DimTab(TInt, TBool)

IMPORT_C void DimTab ( TInt aTabId,
TBool aDimmed
)

Sets a tab dimmed/not dimmed.

Parameters

TInt aTabId ID of the tab.
TBool aDimmed ETrue to set the tab dimmed, EFalse otherwise.

DoDrawLowerBorder()

void DoDrawLowerBorder ( ) const [private]

DoTabAnimationEvent()

void DoTabAnimationEvent ( ) [private]

Draw(const TRect &)

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

Parameters

const TRect & aRect

DrawLowerBorder(TDrawNow)

void DrawLowerBorder ( TDrawNow aDrawNow ) const [private]

Parameters

TDrawNow aDrawNow

ExtensionInterface(TUid)

IMPORT_C void * ExtensionInterface ( TUid aInterface ) [private, virtual]

Virtual method provided to allow extensibility of virtual behaviour

Parameters

TUid aInterface

FocusChanged(TDrawNow)

IMPORT_C void FocusChanged ( TDrawNow aDrawNow ) [protected, virtual]

This is called when the focus is changed.

Parameters

TDrawNow aDrawNow Whether or not to draw the control.

GetColorUseListL(CArrayFix< TCoeColorUse > &)

IMPORT_C void GetColorUseListL ( 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 > & aColorUseList The color list.

HandleControlEventL(CCoeControl *, TCoeEvent)

IMPORT_C void HandleControlEventL ( CCoeControl * aControl,
TCoeEvent aEventType
) [virtual]

Handles an event from an observed control.

Parameters

CCoeControl * aControl Control that caused the event.
TCoeEvent aEventType Type of the event.

HandleNaviDecoratorEventL(TInt)

IMPORT_C void HandleNaviDecoratorEventL ( TInt aEventID ) [virtual]

Parameters

TInt aEventID

HandlePointerEventL(const TPointerEvent &)

IMPORT_C void HandlePointerEventL ( const TPointerEvent & aPointerEvent ) [virtual]

Handles pointer events in tabs.

Parameters

const TPointerEvent & aPointerEvent Pointer event to be handled.

HandleResourceChange(TInt)

void HandleResourceChange ( TInt aType ) [virtual]

Handles a change to the control's resources.

Parameters

TInt aType The type of resource change.

HandleTabStateChanged(CCoeControl *)

void HandleTabStateChanged ( CCoeControl * aControl ) [private]

Parameters

CCoeControl * aControl

Index(TInt)

TInt Index ( TInt aTabId ) const [private]

Parameters

TInt aTabId

InitTabAnimationEventTimer()

void InitTabAnimationEventTimer ( ) [private]

InitTabAnimationL()

void InitTabAnimationL ( ) [private]

InitTabGroupGraphicsL()

void InitTabGroupGraphicsL ( ) [private]

IsTabDimmed(TInt)

IMPORT_C TBool IsTabDimmed ( TInt aTabId ) const [virtual]

Used to check whether or not a tab is dimmed.

Parameters

TInt aTabId ID of the tab.

LeftMostTabIndex()

TInt LeftMostTabIndex ( ) const [private]

LoadTabBitmapsL(TInt, TBool)

void LoadTabBitmapsL ( TInt aNumberOfTabsShown,
TBool aLongTabs
) [private]

Parameters

TInt aNumberOfTabsShown
TBool aLongTabs

MinimumSize()

IMPORT_C TSize MinimumSize ( ) [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 & aParent Parent 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 & aParent Parent control.

OfferKeyEventL(const TKeyEvent &, TEventCode)

IMPORT_C TKeyResponse OfferKeyEventL ( const TKeyEvent & aKeyEvent,
TEventCode aType
) [virtual]

Handles key events.

Parameters

const TKeyEvent & aKeyEvent The key event.
TEventCode aType The type of the event.

ParentRect(TBool)

TRect ParentRect ( TBool aArrowsUsed ) [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 aArrowsUsed ETrue if tab arrows are shown, EFalse otherwise.

PrepareContext(CWindowGc &)

IMPORT_C void PrepareContext ( CWindowGc & aGc ) const [virtual]

Allows to modify graphics context before Draw.

Parameters

CWindowGc & aGc Graphics context to be modified.

ReplaceTabL(TResourceReader &)

IMPORT_C void ReplaceTabL ( TResourceReader & aReader )

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

Parameters

TResourceReader & aReader Resource reader.

ReplaceTabL(TInt, const TDesC &)

IMPORT_C void ReplaceTabL ( TInt aTabId,
const TDesC & aText
)

Replaces a tab with a new one.

Parameters

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

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

IMPORT_C void ReplaceTabL ( TInt aTabId,
const TDesC & aText,
const CFbsBitmap * aTabBitmap,
const CFbsBitmap * aMask = NULL
)

Replaces a tab with a new one.

Parameters

TInt aTabId ID of the tab to be replaced.
const TDesC & aText
const CFbsBitmap * aTabBitmap Bitmap for the tab. Ownership of the bitmap is taken.
const CFbsBitmap * aMask = NULL Bitmap's mask. Ownership of the mask is taken.

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

IMPORT_C void ReplaceTabL ( TInt aTabId,
const CFbsBitmap * aTabBitmap,
const CFbsBitmap * aMask = NULL
)

Replaces a tab with a new one.

Parameters

TInt aTabId ID of the tab to be replaced.
const CFbsBitmap * aTabBitmap Bitmap for the tab. Ownership of the bitmap is taken.
const CFbsBitmap * aMask = NULL Bitmap's mask. Ownership of the mask is taken.

ReplaceTabTextL(TInt, const TDesC &)

IMPORT_C void ReplaceTabTextL ( TInt aTabId,
const TDesC & aTabText
)

Replaces a tab text with a new one.

Parameters

TInt aTabId ID of the tab containing the text to be replaced.
const TDesC & aTabText New tab text.

ReportNavigationEvent()

void ReportNavigationEvent ( ) [private]

Reserved1()

IMPORT_C void Reserved1 ( ) [private, virtual]

Reserved2()

IMPORT_C void Reserved2 ( ) [private, virtual]

Reserved3()

IMPORT_C void Reserved3 ( ) [private, virtual]

ReverseTabOrderL()

void ReverseTabOrderL ( ) [protected]

Reverse the order of tabs in tab array.

RightMostTabIndex()

TInt RightMostTabIndex ( ) const [private]

SetActiveTabById(TInt)

IMPORT_C void SetActiveTabById ( TInt aTabId )

Activate (highlight) a tab.

Parameters

TInt aTabId ID of the tab to be highlighted.

SetActiveTabByIndex(TInt)

IMPORT_C void SetActiveTabByIndex ( TInt aTabIndex )

Activate (highlight) a tab.

Parameters

TInt aTabIndex Index of the tab to be highlighted.

SetDecoratorLayout(TBool)

void SetDecoratorLayout ( TBool aNarrow )

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

Parameters

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

SetNarrowTabLayoutL(TBool, TBool)

void SetNarrowTabLayoutL ( TBool aNarrow,
TBool aUseAnimation = EFalse
)

Parameters

TBool aNarrow
TBool aUseAnimation = EFalse

SetNaviArrowsVisible(TBool)

void SetNaviArrowsVisible ( TBool aVisible )

Parameters

TBool aVisible

SetObserver(MAknTabObserver *)

IMPORT_C void SetObserver ( MAknTabObserver * aObserver )

Sets the tab observer for this tab group.

Parameters

MAknTabObserver * aObserver Tab observer to set.

SetTabFixedWidthL(TInt)

IMPORT_C void SetTabFixedWidthL ( TInt aWidth )
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 aWidth Width of each tab,

SetTabMultiColorMode(TInt, TBool)

IMPORT_C void SetTabMultiColorMode ( TInt aTabId,
TBool aMultiColor
)

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 aTabId ID of the tab.
TBool aMultiColor ETrue to set the multi-color mode on, EFalse to turn it off.

SizeChanged()

IMPORT_C void SizeChanged ( ) [protected, virtual]

Handles the size change events.

SizeChangedInFlatLayout()

void SizeChangedInFlatLayout ( ) [private]

SizeChangedInNarrowLayout()

void SizeChangedInNarrowLayout ( ) [private]

SizeChangedInNormalLayout()

void SizeChangedInNormalLayout ( ) [private]

StartCycleAnimationL(TDirection, TInt)

void StartCycleAnimationL ( TDirection aDirection,
TInt aNewTab
) [private]

Parameters

TDirection aDirection
TInt aNewTab

SwitchTabLayoutL()

void SwitchTabLayoutL ( ) [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 TInt TabCount ( ) const [virtual]

Number of tabs in the tab group.

TabIdFromIndex(TInt)

IMPORT_C TInt TabIdFromIndex ( TInt aTabIndex ) const [virtual]

Returns the ID of a tab.

Parameters

TInt aTabIndex Index of a tab.

TabIndexFromId(TInt)

IMPORT_C TInt TabIndexFromId ( TInt aTabId ) const [virtual]

Returns the index of a tab.

Parameters

TInt aTabId ID 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]

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.