S60 3rd Edition API Reference: CEikCba Class Reference

CEikCba Class Reference

API published in: S60 1st Ed

Link against: eikcoctl.lib avkon.lib

Capability Information

Required Capabilities

None

#include <eikcba.h>

Inherits CEikControlGroup, MEikEnhancedButtonGroup, and MEikScrollBarObserver.

Detailed Description

Defines a Control Button Array control, used in Avkon to define the softkeys in the control pane.

Public Member Functions

 DECLARE_TYPE_ID (0x101F4105) static CEikCba *NewL(const CEikCba *aPrevious
 ~CEikCba ()
TInt MaxCommands () const
void UpdateCbaLabels (TBool aScrollerOn)
TInt MSKEnabledInPlatform () const
 Public Since 3rd Ed FP1.
void SetSBFrameObserver (MEikScrollBarObserver *aObserver)
void SetScrollBarModelL (TEikScrollBarModel *aModel)
const CEikCbaScrollBarFrame * ScrollBarFrame () const
CAknScrollBar * VScrollBarAsControl ()
void CreateArrowHeadScrollBarL ()
void InsertControlL (TEikGroupControl &aGroupControl, TInt aIndex)
void SetCommandL (TInt aPosition, TInt aCommandId, const TDesC *aText, const CFbsBitmap *aBitmap, const CFbsBitmap *aMask)
void SetCommandL (TInt aPosition, TInt aResourceId)
void SetCommandSetL (TInt aResourceId)
void AddCommandL (TInt aPosition, TInt aCommandId, const TDesC *aText, const CFbsBitmap *aBitmap, const CFbsBitmap *aMask)
void AddCommandToStackL (TInt aPosition, TInt aCommandId, const TDesC *aText, const CFbsBitmap *aBitmap, const CFbsBitmap *aMask)
void AddCommandToStackL (TInt aPosition, TInt aResourceId)
void AddCommandSetToStackL (TInt aResourceId)
void SetDefaultCommand (TInt aCommandId)
TSize CalcMinimumSizeL (TInt aResourceId)
void RemoveCommandFromStack (TInt aPosition, TInt aCommandId)
TInt CommandPos (TInt aCommandId) const
void DimCommand (TInt aCommandId, TBool aDimmed)
TBool IsCommandDimmed (TInt aCommandId) const
void MakeCommandVisible (TInt aCommandId, TBool aVisible)
TBool IsCommandVisible (TInt aCommandId) const
void AnimateCommand (TInt aCommandId)
CCoeControl * AsControl ()
const CCoeControl * AsControl () const
void SetBoundingRect (const TRect &aBoundingRect)
void ReduceRect (TRect &aBoundingRect) const
CCoeControl * GroupControlById (TInt aCommandId)
CCoeControl * GroupControlById (TInt aCommandId) const
TInt CommandId (TInt aCommandPos) const
TInt ButtonCount () const
void RemovePreviousCommand (TInt aPosition)
CEikCommandButton * GroupControlAsButton (TInt aCommandId) const
TUint ButtonGroupFlags () const
IMPORT_C void SetButtonGroupFlags (TInt aFlags)
IMPORT_C void SetSkinBackgroundId (const TAknsItemID &aIID)
 Sets the skin background for this control button array.
void SetMSKIconL ()
 Public Since 3rd Ed FP1 MSK related methods since 3.1.
virtual void Reserved_MtsmPosition ()
virtual void Reserved_MtsmObject ()
TKeyResponse OfferKeyEventL (const TKeyEvent &aKeyEvent, TEventCode aType)
TSize MinimumSize ()
void GetColorUseListL (CArrayFix< TCoeColorUse > &aColorUseList) const
  Not used in S60.
void HandleResourceChange (TInt aType)
 Handles a change to the control's resources.
void MakeVisible (TBool aVisible)
 Public Since 3rd Ed FP1.
void HandlePointerEventL (const TPointerEvent &aPointerEvent)
 From CCoeControl.
IMPORT_C void OfferCommandListL (const RArray< TInt > &aCommandList)
 Used to offer list of commands for softkeys.
IMPORT_C void OfferCommandListL (const TInt aResourceId)
 Used to offer list of commands for softkeys.
IMPORT_C TBool IsCommandInGroup (const TInt aCommandId) const
 Used to check if a certain command have been approved to the current command set.
IMPORT_C void ReplaceCommand (const TInt aCommandId, const TInt aResourceId)
 Replace existing command with a new command.

Static Public Member Functions

static CEikCba * NewL (TInt aResourceId, const CEikCba *aPrevious, MEikCommandObserver *aCommandObserver, RWindowGroup *aParentWg)
static CEikCba * NewLC (const CEikCba *aPrevious, MEikCommandObserver *aCommandObserver, RWindowGroup *aParentWg)
static CEikCba * NewLC (TInt aResourceId, const CEikCba *aPrevious, MEikCommandObserver *aCommandObserver, RWindowGroup *aParentWg)

Data Fields

MEikCommandObserver * aCommandObserver
MEikCommandObserver RWindowGroup * aParentWg

Protected Member Functions

virtual void HandleScrollEventL (CEikScrollBar *aScrollBar, TEikScrollEvent aEventType)
 Callback method for scroll bar events.
TTypeUid::Ptr MopSupplyObject (TTypeUid aId)
void Draw (const TRect &aRect) const
 Draws the border around the control.

Constructor & Destructor Documentation

CEikCba::~CEikCba (   ) 
 

Member Function Documentation

void CEikCba::AddCommandL ( TInt  aPosition,
TInt  aCommandId,
const TDesC *  aText,
const CFbsBitmap *  aBitmap,
const CFbsBitmap *  aMask
)  [virtual]
 

Implements MEikButtonGroup.

void CEikCba::AddCommandSetToStackL ( TInt  aResourceId  )  [virtual]
 

Implements MEikButtonGroup.

void CEikCba::AddCommandToStackL ( TInt  aPosition,
TInt  aResourceId
)  [virtual]
 

Implements MEikButtonGroup.

void CEikCba::AddCommandToStackL ( TInt  aPosition,
TInt  aCommandId,
const TDesC *  aText,
const CFbsBitmap *  aBitmap,
const CFbsBitmap *  aMask
)  [virtual]
 

Implements MEikButtonGroup.

void CEikCba::AnimateCommand ( TInt  aCommandId  )  [virtual]
 

Reimplemented from MEikButtonGroup.

const CCoeControl* CEikCba::AsControl (   )  const [virtual]
 

Implements MEikButtonGroup.

CCoeControl* CEikCba::AsControl (   )  [virtual]
 

Implements MEikButtonGroup.

TInt CEikCba::ButtonCount (   )  const [virtual]
 

Implements MEikButtonGroup.

TUint CEikCba::ButtonGroupFlags (   )  const [virtual]
 

Implements MEikButtonGroup.

TSize CEikCba::CalcMinimumSizeL ( TInt  aResourceId  )  [virtual]
 

Implements MEikButtonGroup.

TInt CEikCba::CommandId ( TInt  aCommandPos  )  const [virtual]
 

Implements MEikButtonGroup.

TInt CEikCba::CommandPos ( TInt  aCommandId  )  const [virtual]
 

Implements MEikButtonGroup.

void CEikCba::CreateArrowHeadScrollBarL (   ) 
 
CEikCba::DECLARE_TYPE_ID ( 0x101F4105   )  const
 
void CEikCba::DimCommand ( TInt  aCommandId,
TBool  aDimmed
)  [virtual]
 

Implements MEikButtonGroup.

void CEikCba::Draw ( const TRect &  aRect  )  const [protected]
 

Draws the border around the control.

This function also clears the central area if the IsBlank() method returns ETrue.

From CCoeControl

Parameters:
aRect Not used.
See also:
CCoeControl::IsBlank()

Border()

Reimplemented from CEikControlGroup.

void CEikCba::GetColorUseListL ( CArrayFix< TCoeColorUse > &  aColorUseList  )  const [virtual]
 

Not used in S60.

From CCoeControl.

Parameters:
aColorUseList Not used.

Reimplemented from CEikControlGroup.

CEikCommandButton* CEikCba::GroupControlAsButton ( TInt  aCommandId  )  const [virtual]
 

Implements MEikButtonGroup.

CCoeControl* CEikCba::GroupControlById ( TInt  aCommandId  )  const [virtual]
 

Implements MEikButtonGroup.

CCoeControl* CEikCba::GroupControlById ( TInt  aCommandId  ) 
 
void CEikCba::HandlePointerEventL ( const TPointerEvent &  aPointerEvent  ) 
 

From CCoeControl.

Handles pointer events.

Parameters:
aPointerEvent The pointer event

Reimplemented from CEikControlGroup.

void CEikCba::HandleResourceChange ( TInt  aType  )  [virtual]
 

Handles a change to the control's resources.

The types of resources handled are those which are shared across the environment, e.g. colours or fonts. For colour scheme changes, DrawDeferred() is called in order to redraw the control.

If overriding this method, the implementation must include a base call to this method.

From CCoeControl.

Parameters:
aType The type of resource that has changed.

Reimplemented from CEikControlGroup.

virtual void CEikCba::HandleScrollEventL ( CEikScrollBar *  aScrollBar,
TEikScrollEvent  aEventType
)  [protected, virtual]
 

Callback method for scroll bar events.

Scroll bar observer should implement this method to get scroll bar events.

Parameters:
aScrollBar A pointer to scrollbar which created the event
aEventType The event occured on the scroll bar

Implements MEikScrollBarObserver.

void CEikCba::InsertControlL ( TEikGroupControl &  aGroupControl,
TInt  aIndex
) 
 

Reimplemented from CEikControlGroup.

TBool CEikCba::IsCommandDimmed ( TInt  aCommandId  )  const [virtual]
 

Implements MEikButtonGroup.

IMPORT_C TBool CEikCba::IsCommandInGroup ( const TInt  aCommandId  )  const [virtual]
 

Used to check if a certain command have been approved to the current command set.

Parameters:
aCommandId the id for command which existence should be checked
Returns:
TBool returns ETrue is command is in control group, otherwise EFalse

Implements MEikEnhancedButtonGroup.

TBool CEikCba::IsCommandVisible ( TInt  aCommandId  )  const [virtual]
 

Implements MEikButtonGroup.

void CEikCba::MakeCommandVisible ( TInt  aCommandId,
TBool  aVisible
)  [virtual]
 

Implements MEikButtonGroup.

void CEikCba::MakeVisible ( TBool  aVisible  ) 
 

Public Since 3rd Ed FP1.

TInt CEikCba::MaxCommands (   )  const
 
TSize CEikCba::MinimumSize (   ) 
 

Reimplemented from CEikControlGroup.

TTypeUid::Ptr CEikCba::MopSupplyObject ( TTypeUid  aId  )  [protected]
 
TInt CEikCba::MSKEnabledInPlatform (   )  const
 

Public Since 3rd Ed FP1.

static CEikCba* CEikCba::NewL ( TInt  aResourceId,
const CEikCba *  aPrevious,
MEikCommandObserver *  aCommandObserver,
RWindowGroup *  aParentWg
)  [static]
 
static CEikCba* CEikCba::NewLC ( TInt  aResourceId,
const CEikCba *  aPrevious,
MEikCommandObserver *  aCommandObserver,
RWindowGroup *  aParentWg
)  [static]
 
static CEikCba* CEikCba::NewLC ( const CEikCba *  aPrevious,
MEikCommandObserver *  aCommandObserver,
RWindowGroup *  aParentWg
)  [static]
 
IMPORT_C void CEikCba::OfferCommandListL ( const TInt  aResourceId  )  [virtual]
 

Used to offer list of commands for softkeys.

Parameters:
aResourceId id for CBA resource that defines enhanced cba buttons

Implements MEikEnhancedButtonGroup.

IMPORT_C void CEikCba::OfferCommandListL ( const RArray< TInt > &  aCommandList  )  [virtual]
 

Used to offer list of commands for softkeys.

Parameters:
aCommandList a list of command ids to be offered for softkeys

Implements MEikEnhancedButtonGroup.

TKeyResponse CEikCba::OfferKeyEventL ( const TKeyEvent &  aKeyEvent,
TEventCode  aType
) 
 
void CEikCba::ReduceRect ( TRect &  aBoundingRect  )  const [virtual]
 

Implements MEikButtonGroup.

void CEikCba::RemoveCommandFromStack ( TInt  aPosition,
TInt  aCommandId
)  [virtual]
 

Implements MEikButtonGroup.

void CEikCba::RemovePreviousCommand ( TInt  aPosition  ) 
 
IMPORT_C void CEikCba::ReplaceCommand ( const TInt  aCommandId,
const TInt  aResourceId
)  [virtual]
 

Replace existing command with a new command.

Parameters:
aCommandId Id for command that should be replaced
aResourceId resource id for new enhanced cba button

Implements MEikEnhancedButtonGroup.

virtual void CEikCba::Reserved_MtsmObject (   )  [virtual]
 
virtual void CEikCba::Reserved_MtsmPosition (   )  [virtual]
 
const CEikCbaScrollBarFrame* CEikCba::ScrollBarFrame (   )  const
 
void CEikCba::SetBoundingRect ( const TRect &  aBoundingRect  )  [virtual]
 

Implements MEikButtonGroup.

IMPORT_C void CEikCba::SetButtonGroupFlags ( TInt  aFlags  ) 
 
void CEikCba::SetCommandL ( TInt  aPosition,
TInt  aResourceId
)  [virtual]
 

Implements MEikButtonGroup.

void CEikCba::SetCommandL ( TInt  aPosition,
TInt  aCommandId,
const TDesC *  aText,
const CFbsBitmap *  aBitmap,
const CFbsBitmap *  aMask
)  [virtual]
 

Implements MEikButtonGroup.

void CEikCba::SetCommandSetL ( TInt  aResourceId  )  [virtual]
 

Implements MEikButtonGroup.

void CEikCba::SetDefaultCommand ( TInt  aCommandId  )  [virtual]
 

Implements MEikButtonGroup.

void CEikCba::SetMSKIconL (   ) 
 

Public Since 3rd Ed FP1 MSK related methods since 3.1.

void CEikCba::SetSBFrameObserver ( MEikScrollBarObserver *  aObserver  ) 
 
void CEikCba::SetScrollBarModelL ( TEikScrollBarModel *  aModel  ) 
 
IMPORT_C void CEikCba::SetSkinBackgroundId ( const TAknsItemID &  aIID  ) 
 

Sets the skin background for this control button array.

The new background is used for all the subsequent drawing operations. This method does not itself cause a repaint.

Parameters:
aIID Skin item ID of the new background. This is one of the constants defined in AknsConstants.h, and the usual values are KAknsIIDQsnBgAreaControl, KAknsIIDQsnBgAreaControlPopup, and KAknsIIDQsnBgAreaControlIdle.
void CEikCba::UpdateCbaLabels ( TBool  aScrollerOn  ) 
 
CAknScrollBar* CEikCba::VScrollBarAsControl (   ) 
 

Field Documentation

MEikCommandObserver* CEikCba::aCommandObserver
 
MEikCommandObserver RWindowGroup* CEikCba::aParentWg
 
The documentation for this class was generated from the following file:
Copyright © Nokia Corporation 2001-2007
Back to top