S60 3rd Edition API Reference: CAknTab Class Reference

CAknTab Class Reference

API published in: S60 1st Ed

Link against: avkon.lib

Capability Information

Required Capabilities

None

#include <akntabgrp.h>

Inherits CAknControl.

Detailed Description

Implements tab control.

Public Types

enum  TAknTabDataType { EAknTabNone, EAknTabText, EAknTabIcon, EAknTabTextAndIcon }
 Indicates a tab title's type. More...

Public Member Functions

 ~CAknTab ()
 Destructor.
void ReplaceTextL (const TDesC &aTabText)
 Replace a tab title.
void SetActive (TBool aActive, TDrawNow aDrawNow)
 Activate or deactive this tab.
TBool Active () const
 Determines whether this tab is active.
TInt Id () const
 Gets tab's ID.
enum TAknTabDataType TabType () const
 Gets this tab's type.
void SetTotalAmountOfTabs (TInt aAmount)
 Sets the total amount of tabs in the tabgroup where this tab belongs.
void SetNarrowTabLayout (TBool aNarrow)
 Sets the narrow tab layout.
virtual TSize MinimumSize ()
 From CCoeControl.
virtual void SetDimmed (TBool aDimmed)
 From CCoeControl.
virtual void GetColorUseListL (CArrayFix< TCoeColorUse > &aColorUseList) const
 From CCoeControl.

Static Public Member Functions

static CAknTab * NewL (const CCoeControl &aParent, TResourceReader &aReader)
 Two-phased constructor.
static CAknTab * NewLC (const CCoeControl &aParent, TResourceReader &aReader)
 Two-phased constructor.
static CAknTab * NewL (TInt aId, const CCoeControl &aParent, const TDesC &aTabText)
 Two-phased constructor.
static CAknTab * NewLC (TInt aId, const CCoeControl &aParent, const TDesC &aTabText)
 Two-phased constructor.
static CAknTab * NewL (TInt aId, const CCoeControl &aParent, const TDesC &aTabText, const CFbsBitmap *aTabBitmap, const CFbsBitmap *aMask=NULL)
 Two-phased constructor.
static CAknTab * NewLC (TInt aId, const CCoeControl &aParent, const TDesC &aTabText, const CFbsBitmap *aTabBitmap, const CFbsBitmap *aMask=NULL)
 Two-phased constructor.
static CAknTab * NewL (TInt aId, const CCoeControl &aParent, const CFbsBitmap *aTabBitmap, const CFbsBitmap *aMask=NULL)
 Two-phased constructor.
static CAknTab * NewLC (TInt aId, const CCoeControl &aParent, const CFbsBitmap *aTabBitmap, const CFbsBitmap *aMask=NULL)
 Two-phased constructor.

Protected Member Functions

virtual void SizeChanged ()
 From CCoeControl.
virtual TInt CountComponentControls () const
 From CCoeControl.
virtual CCoeControl * ComponentControl (TInt aIndex) const
 From CCoeControl.
virtual void HandlePointerEventL (const TPointerEvent &aPointerEvent)
 From CCoeControl.

Friends

class CAknTabGroup

Member Enumeration Documentation

enum CAknTab::TAknTabDataType
 

Indicates a tab title's type.

Enumerator:
EAknTabNone  Tab title is empty.
EAknTabText  Tab title has only text.
EAknTabIcon  Tab title has only icon.
EAknTabTextAndIcon  Tab title has both text and icon.

Constructor & Destructor Documentation

CAknTab::~CAknTab (   ) 
 

Destructor.

Member Function Documentation

TBool CAknTab::Active (   )  const
 

Determines whether this tab is active.

Returns:
ETrue if a tab is active, EFalse if not.
virtual CCoeControl* CAknTab::ComponentControl ( TInt  aIndex  )  const [protected, virtual]
 

From CCoeControl.

Gets the specified component of a compound control.

Parameters:
aIndex The index of the control to get.
Returns:
The component control with an index of aIndex.
virtual TInt CAknTab::CountComponentControls (   )  const [protected, virtual]
 

From CCoeControl.

Gets the number of controls contained in a compound control.

Returns:
The number of component controls contained by this control.
virtual void CAknTab::GetColorUseListL ( CArrayFix< TCoeColorUse > &  aColorUseList  )  const [virtual]
 

From CCoeControl.

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:
aColorUseList The colour list.
virtual void CAknTab::HandlePointerEventL ( const TPointerEvent &  aPointerEvent  )  [protected, virtual]
 

From CCoeControl.

Handles pointer events. This function is called by framework whenever a pointer event occurs in the control,

Parameters:
aPointerEvent The pointer event that occurs.
TInt CAknTab::Id (   )  const
 

Gets tab's ID.

Returns:
Tabs' ID.
virtual TSize CAknTab::MinimumSize (   )  [virtual]
 

From CCoeControl.

Gets a minimum size of the tab.

Returns:
A Minimum size of the tab.
static CAknTab* CAknTab::NewL ( TInt  aId,
const CCoeControl &  aParent,
const CFbsBitmap *  aTabBitmap,
const CFbsBitmap *  aMask = NULL
)  [static]
 

Two-phased constructor.

Parameters:
aId Tab ID.
aParent Reference to parent control.
aTabBitmap Bitmap for the tab. Ownership of a bitmap is taken.
aMask Bitmap's mask. Default is NULL.
Returns:
A pointer to constructed CAknTab object.
static CAknTab* CAknTab::NewL ( TInt  aId,
const CCoeControl &  aParent,
const TDesC &  aTabText,
const CFbsBitmap *  aTabBitmap,
const CFbsBitmap *  aMask = NULL
)  [static]
 

Two-phased constructor.

Parameters:
aId Tab ID.
aParent Reference to parent control.
aTabText Reference to title text.
aTabBitmap Bitmap for the tab. Ownership of a bitmap is taken.
aMask Bitmap's mask. Default is NULL.
Returns:
A pointer to constructed CAknTab object.
static CAknTab* CAknTab::NewL ( TInt  aId,
const CCoeControl &  aParent,
const TDesC &  aTabText
)  [static]
 

Two-phased constructor.

Parameters:
aId Tab ID.
aParent Reference to parent control.
aTabText Reference to title text.
Returns:
A pointer to constructed CAknTab object.
static CAknTab* CAknTab::NewL ( const CCoeControl &  aParent,
TResourceReader &  aReader
)  [static]
 

Two-phased constructor.

Parameters:
aParent Reference to parent control.
aReader Reference to resource reader.
Returns:
A pointer to constructed CAknTab object.
static CAknTab* CAknTab::NewLC ( TInt  aId,
const CCoeControl &  aParent,
const CFbsBitmap *  aTabBitmap,
const CFbsBitmap *  aMask = NULL
)  [static]
 

Two-phased constructor.

Parameters:
aId Tab ID.
aParent Reference to parent control.
aTabBitmap Bitmap for the tab. Ownership of a bitmap is taken.
aMask Bitmap's mask. Default is NULL.
Returns:
A pointer to constructed CAknTab object.
static CAknTab* CAknTab::NewLC ( TInt  aId,
const CCoeControl &  aParent,
const TDesC &  aTabText,
const CFbsBitmap *  aTabBitmap,
const CFbsBitmap *  aMask = NULL
)  [static]
 

Two-phased constructor.

Parameters:
aId Tab ID.
aParent Reference to parent control.
aTabText Reference to title text.
aTabBitmap Bitmap for the tab. Ownership of a bitmap is taken.
aMask Bitmap's mask. Default is NULL.
Returns:
A pointer to constructed CAknTab object.
static CAknTab* CAknTab::NewLC ( TInt  aId,
const CCoeControl &  aParent,
const TDesC &  aTabText
)  [static]
 

Two-phased constructor.

Parameters:
aId Tab ID.
aParent Reference to parent control.
aTabText Reference to title text.
Returns:
A pointer to constructed CAknTab object.
static CAknTab* CAknTab::NewLC ( const CCoeControl &  aParent,
TResourceReader &  aReader
)  [static]
 

Two-phased constructor.

Parameters:
aParent Reference to parent control.
aReader Reference to resource reader.
Returns:
A pointer to constructed CAknTab object.
void CAknTab::ReplaceTextL ( const TDesC &  aTabText  ) 
 

Replace a tab title.

Parameters:
aTabText A new title text.
void CAknTab::SetActive ( TBool  aActive,
TDrawNow  aDrawNow
) 
 

Activate or deactive this tab.

Parameters:
aActive ETrue for activation, EFalse for deactivation.
aDrawNow Indicates whether control need to be redrawn.
virtual void CAknTab::SetDimmed ( TBool  aDimmed  )  [virtual]
 

From CCoeControl.

Sets a tab dimmed.

Parameters:
aDimmed ETrue to dim the control, EFalse to set the control as not dimmed.
void CAknTab::SetNarrowTabLayout ( TBool  aNarrow  ) 
 

Sets the narrow tab layout.

Used by the UI framework. Applications can set the narrow layout using CAknNaviDecorator class.

void CAknTab::SetTotalAmountOfTabs ( TInt  aAmount  ) 
 

Sets the total amount of tabs in the tabgroup where this tab belongs.

virtual void CAknTab::SizeChanged (   )  [protected, virtual]
 

From CCoeControl.

Responds to size changes to sets the size and position of the contents of this control.

enum TAknTabDataType CAknTab::TabType (   )  const
 

Gets this tab's type.

Returns:
Tab's type.

Friends And Related Function Documentation

friend class CAknTabGroup [friend]
 
The documentation for this class was generated from the following file:
Copyright © Nokia Corporation 2001-2007
Back to top