CAknTab Class Reference

Link against: avkon.lib

Capability Information

Required Capabilities

None

#include <akntabgrp.h>

Inherits CAknControl.

Detailed Description

Tab item control used inside a tab group.

Dll avkon.lib

Since:: 0.9


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 the 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 to.
void	SetNarrowTabLayout (TBool aNarrow)
	Sets the narrow tab layout.
void	SetMultiColorMode (TBool aMultiColor)
	Sets the flag indicating whether or not this tab contains a multi-colored title icon.
TBool	MultiColorMode () const
	Checks whether or not this tab is drawn using multi-color mode or not.
void	SetLongTabLayout (TBool aLongTab)
	Sets the long tab layout.
virtual TSize	MinimumSize ()
	Gets the minimum size of the tab.
virtual void	SetDimmed (TBool aDimmed)
	Sets the tab dimmed.
virtual void	GetColorUseListL (CArrayFix< TCoeColorUse > &aColorUseList) const
	Gets the list of logical colors employed in the drawing of the control, paired with an explanation of how they are used.
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 ()
	Responds to size changes events to sets the size and position of the contents of this control.
virtual TInt	CountComponentControls () const
	Gets the number of controls contained in a compound control.
virtual CCoeControl *	ComponentControl (TInt aIndex) const
	Gets the specified component of a compound control.
virtual void	HandlePointerEventL (const TPointerEvent &aPointerEvent)
	Handles pointer events.
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]

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]

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]

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:

[in,out] aColorUseList The color list.

virtual void CAknTab::HandlePointerEventL ( const TPointerEvent & aPointerEvent ) [protected, virtual]

Handles pointer events.

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

Parameters:

aPointerEvent

The pointer event.

TInt CAknTab::Id

(

)

const

Gets tab's ID.

Returns:: Tabs' ID.

virtual TSize CAknTab::MinimumSize ( ) [virtual]

Gets the minimum size of the tab.

Returns:: Minimum size of the tab.

TBool CAknTab::MultiColorMode

(

)

const

Checks whether or not this tab is drawn using multi-color mode or not.

Returns:: ETrue if this tab contains a multi-color icon, EFalse otherwise.

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 the bitmap is taken.
	aMask	Bitmap's mask. Ownership of the mask is taken.

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 the bitmap is taken.
	aMask	Bitmap's mask. Ownership of the mask is taken.

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 the bitmap is taken.
	aMask	Bitmap's mask. Ownership of the mask is taken.

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 the bitmap is taken.
	aMask	Bitmap's mask. Ownership of the mask is taken.

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 the tab title.

Parameters:

aTabText

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]

Sets the tab dimmed.

Parameters:

aDimmed ETrue to dim the control, EFalse to set the control as not dimmed.

void CAknTab::SetLongTabLayout

(

TBool

aLongTab

)

Sets the long tab layout.

void CAknTab::SetMultiColorMode

(

TBool

aMultiColor

)

Sets the flag indicating whether or not this tab contains a multi-colored title icon.

The multi-color mode should be used with color icons, otherwise the tab icon is drawn using a color defined in the current skin.

Parameters:

aMultiColor ETrue to set the multi-color mode on, EFalse to turn it off.

void CAknTab::SetNarrowTabLayout

(

TBool

aNarrow

)

Sets the narrow tab layout.

void CAknTab::SetTotalAmountOfTabs

(

TInt

aAmount

)

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

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

Responds to size changes events 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:

akntabgrp.h

CAknTab Class Reference

Capability Information

Required Capabilities

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Friends

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation