S60 3rd Edition API Reference: CEikCbaButton Class Reference

CEikCbaButton Class Reference

API published in: S60 1st Ed

Link against: eikcoctl.lib avkon.lib

Capability Information

Required Capabilities

None

#include <eikcba.h>

Inherits CAknControl.

Inherited by CEikEnhancedCbaButton.


Public Member Functions

 ~CEikCbaButton ()
void ConstructL (TGulAlignmentValue aAlignment)
void AddCommandL (const TDesC &aText)
void PushCommandL (TInt aCommandId, const TDesC &aText)
TInt PopCommand ()
void RemoveCommand (TInt aCommandId)
void RemovePreviousCommand ()
void SwitchToShortTextL (TBool aShortText)
void SetLabelFont (const CFont *aLabelFont)
void TruncateLabelText ()
void SetContainerWindowL (const CCoeControl &aContainer)
void ConstructFromResourceL (TResourceReader &aReader, TGulAlignmentValue anAlignment)
TSize MinimumSize ()
void SetDimmed (TBool aDimmed)
IMPORT_C void HandlePointerEventL (const TPointerEvent &aPointerEvent)
void SetImage (CEikImage &aImage)
void ReplaceImageByLabel ()
TBool IsImageOn () const
void ConstructEmptyButtonL ()
 Constructs empty button with id EAknSoftkeyEmpty Public Since 3rd Ed FP1.

Protected Member Functions

TInt IndexFromCommandId (TInt aCommandId)
void UpdateLabelText (TPtrC aLabelText)

Protected Attributes

TBuf< KMaxCbaLabelLength > iFullLabelText
TPtrC iLongLabelText
TPtrC iShortLabelText
CEikLabel * iLabel
CDesCArray * iText
CArrayFix< SButtonOptions > * iButtonOptions
CEikImage * iImage

Data Structures

struct  SButtonOptions

Constructor & Destructor Documentation

CEikCbaButton::~CEikCbaButton (   ) 
 

Member Function Documentation

void CEikCbaButton::AddCommandL ( const TDesC &  aText  ) 
 
void CEikCbaButton::ConstructEmptyButtonL (   ) 
 

Constructs empty button with id EAknSoftkeyEmpty Public Since 3rd Ed FP1.

Reimplemented in CEikEnhancedCbaButton.

void CEikCbaButton::ConstructFromResourceL ( TResourceReader &  aReader,
TGulAlignmentValue  anAlignment
) 
 
void CEikCbaButton::ConstructL ( TGulAlignmentValue  aAlignment  ) 
 
IMPORT_C void CEikCbaButton::HandlePointerEventL ( const TPointerEvent &  aPointerEvent  ) 
 
TInt CEikCbaButton::IndexFromCommandId ( TInt  aCommandId  )  [protected]
 
TBool CEikCbaButton::IsImageOn (   )  const [inline]
 
TSize CEikCbaButton::MinimumSize (   ) 
 
TInt CEikCbaButton::PopCommand (   ) 
 
void CEikCbaButton::PushCommandL ( TInt  aCommandId,
const TDesC &  aText
) 
 
void CEikCbaButton::RemoveCommand ( TInt  aCommandId  ) 
 
void CEikCbaButton::RemovePreviousCommand (   ) 
 
void CEikCbaButton::ReplaceImageByLabel (   ) 
 
void CEikCbaButton::SetContainerWindowL ( const CCoeControl &  aContainer  ) 
 
void CEikCbaButton::SetDimmed ( TBool  aDimmed  ) 
 
void CEikCbaButton::SetImage ( CEikImage &  aImage  ) 
 
void CEikCbaButton::SetLabelFont ( const CFont *  aLabelFont  ) 
 
void CEikCbaButton::SwitchToShortTextL ( TBool  aShortText  ) 
 
void CEikCbaButton::TruncateLabelText (   ) 
 
void CEikCbaButton::UpdateLabelText ( TPtrC  aLabelText  )  [protected]
 

Field Documentation

CArrayFix<SButtonOptions>* CEikCbaButton::iButtonOptions [protected]
 
TBuf<KMaxCbaLabelLength> CEikCbaButton::iFullLabelText [protected]
 
CEikImage* CEikCbaButton::iImage [protected]
 
CEikLabel* CEikCbaButton::iLabel [protected]
 
TPtrC CEikCbaButton::iLongLabelText [protected]
 
TPtrC CEikCbaButton::iShortLabelText [protected]
 
CDesCArray* CEikCbaButton::iText [protected]
 
The documentation for this class was generated from the following file:
Copyright © Nokia Corporation 2001-2007
Back to top