CEikCommandTable Class Reference

class CEikCommandTable : public CBase

Holds (enhanced) CBA commands and handles command ordering due to placement rules.

eikcoctl.lib S60 3.0

Inherits from

CEikCommandTable
- CBase

Public Member Functions
	~CEikCommandTable()
TInt	AddCommandL(CEikEnhancedCbaButton *)
CEikEnhancedCbaButton *	Command(const TInt)
TBool	IsCommandPlaced(const TInt)
CEikCommandTable *	NewL()
CEikCommandTable *	NewLC()
void	ReplaceCommandL(const TInt, const TInt)
void	Reset()

Private Member Functions
	CEikCommandTable()
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
TFixedArray< CEikEnhancedCbaButton *, KMaxButtonsInCommandTable >	iCommandButtons
RArray< RArray< TInt > >	iPriorities

Constructor & Destructor Documentation

CEikCommandTable()

CEikCommandTable

(

)

[private]

Constructor.

~CEikCommandTable()

~CEikCommandTable

(

)

Destructor.

Member Functions Documentation

AddCommandL(CEikEnhancedCbaButton *)

TInt

AddCommandL

(

CEikEnhancedCbaButton *

aButton

)

Used to add a command to CommandTable.

KErrNone if addition was successful.

Parameters

CEikEnhancedCbaButton * aButton

The button to be added.

Command(const TInt)

CEikEnhancedCbaButton *

Command

(

const TInt

aCommandIndex

)

Used to get CEikEnhancedCbaButton for current control button (1-4).

CEikCbaButton for current position, NULL if no button placed in that position.

Parameters

const TInt aCommandIndex

Index for requested button, use enum TCommandTableCbaPositions.

ConstructL()

void

ConstructL

(

)

[private]

Constructs command table with device button priorities.

IsCommandPlaced(const TInt)

TBool

IsCommandPlaced

(

const TInt

aCommandId

)

const

Used to check if command table has a button with a certain id.

ETrue if command is placed in the command table.

Parameters

const TInt aCommandId

The id to be checked.

NewL()

CEikCommandTable *

NewL

(

)

[static]

Constructs a new command table instance.

The new command table.

NewLC()

CEikCommandTable *

NewLC

(

)

[static]

Constructs a new command table instance.

The new command table.

ReplaceCommandL(const TInt, const TInt)

void	ReplaceCommandL	(	const TInt	aCommandId,
			const TInt	aResourceId
		)

Used to replace command with a new command.

Parameters

const TInt aCommandId	Id for command that should be replaced.
const TInt aResourceId	Id for new ENHANCED_CBA_BUTTON resource to be placed in the CommandTable.

Reset()

void

Reset

(

)

Reset CommandTable.

Member Data Documentation

TFixedArray< CEikEnhancedCbaButton *, KMaxButtonsInCommandTable > iCommandButtons

TFixedArray< CEikEnhancedCbaButton *, KMaxButtonsInCommandTable >

iCommandButtons

[private]

Displayed commands.

RArray< RArray< TInt > > iPriorities

RArray< RArray< TInt > >

iPriorities

[private]

Priority order for each button.