CEikCommandTable Class Reference

API published in: S60 1st Ed

Link against: eikcoctl.lib avkon.lib

Capability Information

Required Capabilities

None

#include <eikcba.h>

Detailed Description

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

Public Member Functions

 ~CEikCommandTable ()
 Destructor.
TInt AddCommandL (CEikEnhancedCbaButton *aButton)
 Used to add a command to CommandTable.
TBool IsCommandPlaced (const TInt aCommandId) const
 Used to check if command table has a button with a certain id.
void ReplaceCommandL (const TInt aCommandId, const TInt aResourceId)
 Used to replace command with a new command.
CEikEnhancedCbaButton * Command (const TInt aCommandIndex)
 Used to get CEikEnhancedCbaButton for current control button (1-4).
void Reset ()
 Reset CommandTable.

Static Public Member Functions

static CEikCommandTable * NewL ()
 Constructs a new command table instance.
static CEikCommandTable * NewLC ()
 Constructs a new command table instance.

Constructor & Destructor Documentation

CEikCommandTable::~CEikCommandTable (   ) 
 

Destructor.

Member Function Documentation

TInt CEikCommandTable::AddCommandL ( CEikEnhancedCbaButton *  aButton  ) 
 

Used to add a command to CommandTable.

Parameters:
aButton The button to be added.
Returns:
KErrNone if addition was successful.
CEikEnhancedCbaButton* CEikCommandTable::Command ( const TInt  aCommandIndex  ) 
 

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

Parameters:
aCommandIndex Index for requested button, use enum TCommandTableCbaPositions.
Returns:
CEikCbaButton for current position, NULL if no button placed in that position.
TBool CEikCommandTable::IsCommandPlaced ( const TInt  aCommandId  )  const
 

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

Parameters:
aCommandId The id to be checked.
Returns:
ETrue if command is placed in the command table.
static CEikCommandTable* CEikCommandTable::NewL (   )  [static]
 

Constructs a new command table instance.

Returns:
The new command table.
static CEikCommandTable* CEikCommandTable::NewLC (   )  [static]
 

Constructs a new command table instance.

Returns:
The new command table.
void CEikCommandTable::ReplaceCommandL ( const TInt  aCommandId,
const TInt  aResourceId
) 
 

Used to replace command with a new command.

Parameters:
aCommandId Id for command that should be replaced.
aResourceId Id for new ENHANCED_CBA_BUTTON resource to be placed in the CommandTable.
void CEikCommandTable::Reset (   ) 
 

Reset CommandTable.

The documentation for this class was generated from the following file:
Copyright © Nokia Corporation 2001-2008
Back to top