S60 3rd Edition API Reference: CEikButtonGroupContainer Class Reference

CEikButtonGroupContainer Class Reference

API published in: S60 1st Ed

Link against: eikcoctl.lib avkon.lib

Capability Information

Required Capabilities

None


#include <eikbtgpc.h>

Inherits CAknControl.


Detailed Description

The CEikButtonGroupContainer class provides a wrapper around the different button arrays used in pen and no-pen devices.

Requesting aUse as either EView or EDialog will create the default button set for the host device; the other options are included primarily for testing.


Public Types

enum  TOrientation { EVertical = SLafButtonGroupContainer::EVertical, EHorizontal = SLafButtonGroupContainer::EHorizontal }
enum  TLocation { EInternal = SLafButtonGroupContainer::EInternal, EExternal = SLafButtonGroupContainer::EExternal }
enum  THotKeyFlags { EShowHotKey = 0x01, EPlainHotKey = 0x02 }
enum  TFlags { EAddToStack = 0x01, EDelayActivation = 0x02, EUseMaxSize = 0x04 }

Public Member Functions

 DECLARE_TYPE_ID (0x101F4107) enum TUse
IMPORT_C ~CEikButtonGroupContainer ()
void SetCommandL (TInt aPosition, TInt aCommandId, const TDesC &aText)
 Sets aText and aCommandId (but no bitmaps) into the button at aPosition, overwriting any previous contents.
void SetCommandL (TInt aPosition, TInt aCommandId, const CFbsBitmap &aBitmap, const CFbsBitmap &aMask)
 Sets aBitmap, aMask and aCommandId (but no text) into the button at aPosition, overwriting any previous contents.
void SetCommandL (TInt aPosition, TInt aCommandId, const TDesC &aText, const CFbsBitmap &aBitmap, const CFbsBitmap &aMask)
 Sets aText, aBitmap, aMask and aCommandId into the button at aPosition, overwriting any previous contents.
void SetCommandL (TInt aPosition, TInt aCommandId, const TDesC &aFile, TInt aBitmapId, TInt aMaskId)
 Sets the bitmaps from the file specified and aCommandId into the button at aPosition, overwriting any previous contents.
void SetCommandL (TInt aPosition, TInt aCommandId, const TDesC &aText, const TDesC &aFile, TInt aBitmapId, TInt aMaskId)
 Sets aText, the bitmaps from the file specified and aCommandId into the button at aPosition, overwriting any previous contents.
void SetCommandL (TInt aPosition, TInt aResourceId)
 Sets the text, bitmaps and command id defined by aResourceId into the button at aPosition, overwriting any previous contents.
void SetCommandL (TInt aCommandId, const TDesC &aText)
 Sets aText (but no bitmaps) into the button with id aCommandId, overwriting any previous contents.
void SetCommandL (TInt aCommandId, const CFbsBitmap &aBitmap, const CFbsBitmap &aMask)
 Sets aBitmap and aMask (but no text) into the button with id aCommandId, overwriting any previous contents.
void SetCommandL (TInt aCommandId, const TDesC &aText, const CFbsBitmap &aBitmap, const CFbsBitmap &aMask)
 Sets aText, aBitmap, aMask into the button with id aCommandId, overwriting any previous contents.
void SetCommandL (TInt aCommandId, const TDesC &aFile, TInt aBitmapId, TInt aMaskId)
 Sets the bitmaps from the file specified into the button with id aCommandId, overwriting any previous contents.
void SetCommandL (TInt aCommandId, const TDesC &aText, const TDesC &aFile, TInt aBitmapId, TInt aMaskId)
 Sets aText and the bitmaps from the file specified into the button with id aCommandId, overwriting any previous contents.
IMPORT_C void SetCommandSetL (TInt aResourceId)
void AddCommandL (TInt aPosition, TInt aCommandId, const TDesC &aText)
 Adds a button containing aText and aCommandId at aPosition.
void AddCommandL (TInt aPosition, TInt aCommandId, const CFbsBitmap &aBitmap, const CFbsBitmap &aMask)
 Adds a button containing aBitmap, aMask and aCommandId at aPosition, transferring ownership of the bitmaps at the end.
void AddCommandL (TInt aPosition, TInt aCommandId, const TDesC &aText, const CFbsBitmap &aBitmap, const CFbsBitmap &aMask)
 Adds a button containing aText, aBitmap, aMask and aCommandId at aPosition, transferring ownership of the bitmaps at the end.
void AddCommandL (TInt aPosition, TInt aCommandId, const TDesC &aFile, TInt aBitmapId, TInt aMaskId)
 Adds a button containing the bitmaps specified at aPosition.
void AddCommandL (TInt aPosition, TInt aCommandId, const TDesC &aText, const TDesC &aFile, TInt aBitmapId, TInt aMaskId)
 Adds a button containing aText and the bitmaps specified at aPosition.
void AddCommandToStackL (TInt aPosition, TInt aCommandId, const TDesC &aText)
 As with SetCommandL but allows the previous command to be retrieved at any time by calling RemoveCommand.
void AddCommandToStackL (TInt aPosition, TInt aCommandId, const CFbsBitmap &aBitmap, const CFbsBitmap &aMask)
 As with SetCommandL but allows the previous command to be retrieved at any time by calling RemoveCommand.
void AddCommandToStackL (TInt aPosition, TInt aCommandId, const TDesC &aText, const CFbsBitmap &aBitmap, const CFbsBitmap &aMask)
 As with SetCommandL but allows the previous command to be retrieved at any time by calling RemoveCommand.
void AddCommandToStackL (TInt aPosition, TInt aCommandId, const TDesC &aFile, TInt aBitmapId, TInt aMaskId)
 As with SetCommandL but allows the previous command to be retrieved at any time by calling RemoveCommand.
void AddCommandToStackL (TInt aPosition, TInt aCommandId, const TDesC &aText, const TDesC &aFile, TInt aBitmapId, TInt aMaskId)
 As with SetCommandL but allows the previous command to be retrieved at any time by calling RemoveCommand.
void AddCommandToStackL (TInt aPosition, TInt aResourceId)
 As with SetCommandL but allows the previous command to be retrieved at any time by calling RemoveCommand.
IMPORT_C void AddCommandSetToStackL (TInt aResourceId)
IMPORT_C void RemoveCommandFromStack (TInt aPosition, TInt aCommandId)
IMPORT_C void SetDefaultCommand (TInt aCommandId)
IMPORT_C TSize CalcMinimumSizeL (TInt aResourceId) const
IMPORT_C void CleanupCommandPushL (TInt aPosition)
void CleanupCommandPop ()
 Remove a command from the cleanup stack.
IMPORT_C void CleanupCommandPop (TInt aCount)
void CleanupCommandPopAndDestroy ()
 Remove a command placed on the cleanup stack by calling CleanupCommandPushL, rolling back to the previous details.
void CleanupCommandPopAndDestroy (TInt aCount)
 Remove aCount commands placed on the cleanup stack by calling CleanupCommandPushL, rolling back to the previous details.
IMPORT_C TInt MaxCommands () const
IMPORT_C TInt ButtonCount () const
IMPORT_C void DimCommand (TInt aCommandId, TBool aDimmed)
 Dims (but doesn't draw) the button with id aCommandId if aDimmed is ETrue.
IMPORT_C TBool IsCommandDimmed (TInt aCommandId) const
 Returns ETrue if the button with id aCommandId is dimmed.
IMPORT_C void MakeCommandVisible (TInt aCommandId, TBool aVisible)
 Sets the the button with id aCommandId to be visible if aVisible is ETrue.
IMPORT_C TBool IsCommandVisible (TInt aCommandId) const
 Returns ETrue if the button with id aCommandId is visible.
IMPORT_C void AnimateCommand (TInt aCommandId)
 Animates the button with id aCommandId.
IMPORT_C TLocation Location () const
IMPORT_C CEikCommandButtonCommandButtonOrNull (TInt aCommandId) const
IMPORT_C void SetBoundingRect (const TRect &aRect)
IMPORT_C void ReduceRect (TRect &aBoundingRect) const
IMPORT_C CCoeControl * ControlOrNull (TInt aCommandId) const
IMPORT_C CEikCommandButtonButtonById (TInt aCommandId) const
IMPORT_C TInt PositionById (TInt aCommandId) const
IMPORT_C void UpdateHotKey (TInt aCommandId, THotKeyFlags aFlags, TInt aKeyId)
IMPORT_C void UpdateCommandObserverL (TInt aPos, MEikCommandObserver &aCommandObserver)
IMPORT_C void RemoveCommandObserver (TInt aPos)
IMPORT_C TBool DelayActivation () const
MEikButtonGroupButtonGroup ()
TUse ButtonGroupType ()
IMPORT_C TSize MinimumSize ()
IMPORT_C TKeyResponse OfferKeyEventL (const TKeyEvent &aKeyEvent, TEventCode aType)
void MakeVisible (TBool aVisible)
IMPORT_C void WriteInternalStateL (RWriteStream &aWriteStream) const
virtual IMPORT_C void Reserved_MtsmPosition ()
virtual IMPORT_C void Reserved_MtsmObject ()
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)
 Replacing command with another.

Static Public Member Functions

static IMPORT_C CEikButtonGroupContainerNewL (TUse aUse, TOrientation aOrientation, MEikCommandObserver *aCommandObserver, TInt aResourceId, TUint aFlags=EAddToStack)
static IMPORT_C CEikButtonGroupContainerNewL (TUse aUse, TOrientation aOrientation, MEikCommandObserver *aCommandObserver, TInt aResourceId, const CCoeControl &aParent, TUint aFlags=EAddToStack)
static IMPORT_C CEikButtonGroupContainerNewL (TUse aUse, TOrientation aOrientation, MEikCommandObserver *aCommandObserver, TInt aResourceId, RWindowGroup &aParentWg, TUint aFlags=EAddToStack)
static IMPORT_C CEikButtonGroupContainerCurrent ()

Friends

class CCmdObserverArray
class CEikButtonGroupStack

Data Structures

class  CCmdObserverArray
class  TCmdObserver
class  TCmdPos

Member Enumeration Documentation

enum CEikButtonGroupContainer::TFlags
 
Enumerator:
EAddToStack 
EDelayActivation 
EUseMaxSize 
enum CEikButtonGroupContainer::THotKeyFlags
 
Enumerator:
EShowHotKey 
EPlainHotKey 
enum CEikButtonGroupContainer::TLocation
 
Enumerator:
EInternal 
EExternal 
enum CEikButtonGroupContainer::TOrientation
 
Enumerator:
EVertical 
EHorizontal 

Constructor & Destructor Documentation

IMPORT_C CEikButtonGroupContainer::~CEikButtonGroupContainer  ) 
 

Member Function Documentation

void CEikButtonGroupContainer::AddCommandL TInt  aPosition,
TInt  aCommandId,
const TDesC &  aText,
const TDesC &  aFile,
TInt  aBitmapId,
TInt  aMaskId
[inline]
 

Adds a button containing aText and the bitmaps specified at aPosition.

Panics if aPosition is out of range.

void CEikButtonGroupContainer::AddCommandL TInt  aPosition,
TInt  aCommandId,
const TDesC &  aFile,
TInt  aBitmapId,
TInt  aMaskId
[inline]
 

Adds a button containing the bitmaps specified at aPosition.

Panics if aPosition is out of range.

void CEikButtonGroupContainer::AddCommandL TInt  aPosition,
TInt  aCommandId,
const TDesC &  aText,
const CFbsBitmap &  aBitmap,
const CFbsBitmap &  aMask
[inline]
 

Adds a button containing aText, aBitmap, aMask and aCommandId at aPosition, transferring ownership of the bitmaps at the end.

Panics if aPosition is out of range.

void CEikButtonGroupContainer::AddCommandL TInt  aPosition,
TInt  aCommandId,
const CFbsBitmap &  aBitmap,
const CFbsBitmap &  aMask
[inline]
 

Adds a button containing aBitmap, aMask and aCommandId at aPosition, transferring ownership of the bitmaps at the end.

Panics if aPosition is out of range.

void CEikButtonGroupContainer::AddCommandL TInt  aPosition,
TInt  aCommandId,
const TDesC &  aText
[inline]
 

Adds a button containing aText and aCommandId at aPosition.

Panics if aPosition is out of range.

IMPORT_C void CEikButtonGroupContainer::AddCommandSetToStackL TInt  aResourceId  ) 
 
void CEikButtonGroupContainer::AddCommandToStackL TInt  aPosition,
TInt  aResourceId
[inline]
 

As with SetCommandL but allows the previous command to be retrieved at any time by calling RemoveCommand.

Panics if aPosition is out of range.

void CEikButtonGroupContainer::AddCommandToStackL TInt  aPosition,
TInt  aCommandId,
const TDesC &  aText,
const TDesC &  aFile,
TInt  aBitmapId,
TInt  aMaskId
[inline]
 

As with SetCommandL but allows the previous command to be retrieved at any time by calling RemoveCommand.

Panics if aPosition is out of range.

void CEikButtonGroupContainer::AddCommandToStackL TInt  aPosition,
TInt  aCommandId,
const TDesC &  aFile,
TInt  aBitmapId,
TInt  aMaskId
[inline]
 

As with SetCommandL but allows the previous command to be retrieved at any time by calling RemoveCommand.

Panics if aPosition is out of range.

void CEikButtonGroupContainer::AddCommandToStackL TInt  aPosition,
TInt  aCommandId,
const TDesC &  aText,
const CFbsBitmap &  aBitmap,
const CFbsBitmap &  aMask
[inline]
 

As with SetCommandL but allows the previous command to be retrieved at any time by calling RemoveCommand.

Panics if aPosition is out of range.

void CEikButtonGroupContainer::AddCommandToStackL TInt  aPosition,
TInt  aCommandId,
const CFbsBitmap &  aBitmap,
const CFbsBitmap &  aMask
[inline]
 

As with SetCommandL but allows the previous command to be retrieved at any time by calling RemoveCommand.

Panics if aPosition is out of range.

void CEikButtonGroupContainer::AddCommandToStackL TInt  aPosition,
TInt  aCommandId,
const TDesC &  aText
[inline]
 

As with SetCommandL but allows the previous command to be retrieved at any time by calling RemoveCommand.

Panics if aPosition is out of range.

IMPORT_C void CEikButtonGroupContainer::AnimateCommand TInt  aCommandId  ) 
 

Animates the button with id aCommandId.

If two buttons have the same id, the button to be animated is undefined.

Parameters:
aCommandId the id for command to be animated
IMPORT_C CEikCommandButton* CEikButtonGroupContainer::ButtonById TInt  aCommandId  )  const
 
IMPORT_C TInt CEikButtonGroupContainer::ButtonCount  )  const
 
MEikButtonGroup * CEikButtonGroupContainer::ButtonGroup  )  [inline]
 
CEikButtonGroupContainer::TUse CEikButtonGroupContainer::ButtonGroupType  )  [inline]
 
IMPORT_C TSize CEikButtonGroupContainer::CalcMinimumSizeL TInt  aResourceId  )  const
 
IMPORT_C void CEikButtonGroupContainer::CleanupCommandPop TInt  aCount  ) 
 
void CEikButtonGroupContainer::CleanupCommandPop  )  [inline]
 

Remove a command from the cleanup stack.

void CEikButtonGroupContainer::CleanupCommandPopAndDestroy TInt  aCount  )  [inline]
 

Remove aCount commands placed on the cleanup stack by calling CleanupCommandPushL, rolling back to the previous details.

void CEikButtonGroupContainer::CleanupCommandPopAndDestroy  )  [inline]
 

Remove a command placed on the cleanup stack by calling CleanupCommandPushL, rolling back to the previous details.

IMPORT_C void CEikButtonGroupContainer::CleanupCommandPushL TInt  aPosition  ) 
 
IMPORT_C CEikCommandButton* CEikButtonGroupContainer::CommandButtonOrNull TInt  aCommandId  )  const
 
IMPORT_C CCoeControl* CEikButtonGroupContainer::ControlOrNull TInt  aCommandId  )  const
 
static IMPORT_C CEikButtonGroupContainer* CEikButtonGroupContainer::Current  )  [static]
 
CEikButtonGroupContainer::DECLARE_TYPE_ID 0x101F4107   )  [inline]
 
IMPORT_C TBool CEikButtonGroupContainer::DelayActivation  )  const
 
IMPORT_C void CEikButtonGroupContainer::DimCommand TInt  aCommandId,
TBool  aDimmed
 

Dims (but doesn't draw) the button with id aCommandId if aDimmed is ETrue.

If two buttons have the same id, the button to be dimmed is undefined.

Parameters:
aCommandId the id for command to be dimmed
aDimmed ETrue for dimming
IMPORT_C TBool CEikButtonGroupContainer::IsCommandDimmed TInt  aCommandId  )  const
 

Returns ETrue if the button with id aCommandId is dimmed.

If two buttons have the same id, the results of this check are undefined.

Parameters:
aCommandId the id for command to be checked
Returns:
the state of the button.
IMPORT_C TBool CEikButtonGroupContainer::IsCommandInGroup const TInt  aCommandId  )  const
 

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
IMPORT_C TBool CEikButtonGroupContainer::IsCommandVisible TInt  aCommandId  )  const
 

Returns ETrue if the button with id aCommandId is visible.

If two buttons have the same id, the results are undefined.

Parameters:
aCommandId the id for command to be checked
Returns:
the state of the button.
IMPORT_C TLocation CEikButtonGroupContainer::Location  )  const
 
IMPORT_C void CEikButtonGroupContainer::MakeCommandVisible TInt  aCommandId,
TBool  aVisible
 

Sets the the button with id aCommandId to be visible if aVisible is ETrue.

If two buttons have the same id, the button to be altered is undefined.

Parameters:
aCommandId the id for command to be made visible
aVisible EFalse for making button invisible
void CEikButtonGroupContainer::MakeVisible TBool  aVisible  ) 
 
IMPORT_C TInt CEikButtonGroupContainer::MaxCommands  )  const
 
IMPORT_C TSize CEikButtonGroupContainer::MinimumSize  ) 
 
static IMPORT_C CEikButtonGroupContainer* CEikButtonGroupContainer::NewL TUse  aUse,
TOrientation  aOrientation,
MEikCommandObserver *  aCommandObserver,
TInt  aResourceId,
RWindowGroup &  aParentWg,
TUint  aFlags = EAddToStack
[static]
 
static IMPORT_C CEikButtonGroupContainer* CEikButtonGroupContainer::NewL TUse  aUse,
TOrientation  aOrientation,
MEikCommandObserver *  aCommandObserver,
TInt  aResourceId,
const CCoeControl &  aParent,
TUint  aFlags = EAddToStack
[static]
 
static IMPORT_C CEikButtonGroupContainer* CEikButtonGroupContainer::NewL TUse  aUse,
TOrientation  aOrientation,
MEikCommandObserver *  aCommandObserver,
TInt  aResourceId,
TUint  aFlags = EAddToStack
[static]
 
IMPORT_C void CEikButtonGroupContainer::OfferCommandListL const TInt  aResourceId  ) 
 

Used to offer list of commands for softkeys.

Parameters:
aResourceId id for CBA resource that defines enhanced cba buttons
IMPORT_C void CEikButtonGroupContainer::OfferCommandListL const RArray< TInt > &  aCommandList  ) 
 

Used to offer list of commands for softkeys.

Parameters:
aCommandList a list of command ids to be offered for softkeys
IMPORT_C TKeyResponse CEikButtonGroupContainer::OfferKeyEventL const TKeyEvent &  aKeyEvent,
TEventCode  aType
 
IMPORT_C TInt CEikButtonGroupContainer::PositionById TInt  aCommandId  )  const
 
IMPORT_C void CEikButtonGroupContainer::ReduceRect TRect &  aBoundingRect  )  const
 
IMPORT_C void CEikButtonGroupContainer::RemoveCommandFromStack TInt  aPosition,
TInt  aCommandId
 
IMPORT_C void CEikButtonGroupContainer::RemoveCommandObserver TInt  aPos  ) 
 
IMPORT_C void CEikButtonGroupContainer::ReplaceCommand const TInt  aCommandId,
const TInt  aResourceId
 

Replacing command with another.

Parameters:
aCommandId Id for command that should be replaced
aResourceId resource id for new enhanced cba button
virtual IMPORT_C void CEikButtonGroupContainer::Reserved_MtsmObject  )  [virtual]
 
virtual IMPORT_C void CEikButtonGroupContainer::Reserved_MtsmPosition  )  [virtual]
 
IMPORT_C void CEikButtonGroupContainer::SetBoundingRect const TRect &  aRect  ) 
 
void CEikButtonGroupContainer::SetCommandL TInt  aCommandId,
const TDesC &  aText,
const TDesC &  aFile,
TInt  aBitmapId,
TInt  aMaskId
[inline]
 

Sets aText and the bitmaps from the file specified into the button with id aCommandId, overwriting any previous contents.

Ownership of the bitmaps is transferred at the end of the function. aMaskId must be specified to guarantee compliance with different colour schemes. If two buttons have the same id, it is undefined which one will be altered. The behaviour is also undefined if aCommandId can't be matched to any button.

void CEikButtonGroupContainer::SetCommandL TInt  aCommandId,
const TDesC &  aFile,
TInt  aBitmapId,
TInt  aMaskId
[inline]
 

Sets the bitmaps from the file specified into the button with id aCommandId, overwriting any previous contents.

Ownership of the bitmaps is transferred at the end of the function. aMaskId must be specified to guarantee compliance with different colour schemes. If two buttons have the same id, it is undefined which one will be altered. The behaviour is also undefined if aCommandId can't be matched to any button.

void CEikButtonGroupContainer::SetCommandL TInt  aCommandId,
const TDesC &  aText,
const CFbsBitmap &  aBitmap,
const CFbsBitmap &  aMask
[inline]
 

Sets aText, aBitmap, aMask into the button with id aCommandId, overwriting any previous contents.

Ownership of the bitmaps is transferred at the end of the function. aMask must be specified to guarantee compliance with different colour schemes. If two buttons have the same id, it is undefined which one will be altered. The behaviour is also undefined if aCommandId can't be matched to any button

void CEikButtonGroupContainer::SetCommandL TInt  aCommandId,
const CFbsBitmap &  aBitmap,
const CFbsBitmap &  aMask
[inline]
 

Sets aBitmap and aMask (but no text) into the button with id aCommandId, overwriting any previous contents.

Ownership of the bitmaps is transferred at the end of the function. aMask must be specified to guarantee compliance with different colour schemes. If two buttons have the same id, it is undefined which one will be altered. The behaviour is also undefined if aCommandId can't be matched to any button.

void CEikButtonGroupContainer::SetCommandL TInt  aCommandId,
const TDesC &  aText
[inline]
 

Sets aText (but no bitmaps) into the button with id aCommandId, overwriting any previous contents.

If two buttons have the same id, it is undefined which one will be altered. The behaviour is also undefined if aCommandId can't be matched to any button.

void CEikButtonGroupContainer::SetCommandL TInt  aPosition,
TInt  aResourceId
[inline]
 

Sets the text, bitmaps and command id defined by aResourceId into the button at aPosition, overwriting any previous contents.

Panics if aPosition is out of range.

void CEikButtonGroupContainer::SetCommandL TInt  aPosition,
TInt  aCommandId,
const TDesC &  aText,
const TDesC &  aFile,
TInt  aBitmapId,
TInt  aMaskId
[inline]
 

Sets aText, the bitmaps from the file specified and aCommandId into the button at aPosition, overwriting any previous contents.

aMask must be specified to guarantee compliance with different colour schemes. Panics if aPosition is out of range.

void CEikButtonGroupContainer::SetCommandL TInt  aPosition,
TInt  aCommandId,
const TDesC &  aFile,
TInt  aBitmapId,
TInt  aMaskId
[inline]
 

Sets the bitmaps from the file specified and aCommandId into the button at aPosition, overwriting any previous contents.

aMask must be specified to guarantee compliance with different colour schemes. Panics if aPosition is out of range.

void CEikButtonGroupContainer::SetCommandL TInt  aPosition,
TInt  aCommandId,
const TDesC &  aText,
const CFbsBitmap &  aBitmap,
const CFbsBitmap &  aMask
[inline]
 

Sets aText, aBitmap, aMask and aCommandId into the button at aPosition, overwriting any previous contents.

Ownership of the bitmaps is transferred at the end of the function. aMask must be specified to guarantee compliance with different colour schemes. Panics if aPosition is out of range.

void CEikButtonGroupContainer::SetCommandL TInt  aPosition,
TInt  aCommandId,
const CFbsBitmap &  aBitmap,
const CFbsBitmap &  aMask
[inline]
 

Sets aBitmap, aMask and aCommandId (but no text) into the button at aPosition, overwriting any previous contents.

Ownership of the bitmaps is transferred at the end of the function. aMask must be specified to guarantee compliance with different colour schemes. Panics if aPosition is out of range.

void CEikButtonGroupContainer::SetCommandL TInt  aPosition,
TInt  aCommandId,
const TDesC &  aText
[inline]
 

Sets aText and aCommandId (but no bitmaps) into the button at aPosition, overwriting any previous contents.

Panics if aPosition is out of range.

IMPORT_C void CEikButtonGroupContainer::SetCommandSetL TInt  aResourceId  ) 
 
IMPORT_C void CEikButtonGroupContainer::SetDefaultCommand TInt  aCommandId  ) 
 
IMPORT_C void CEikButtonGroupContainer::UpdateCommandObserverL TInt  aPos,
MEikCommandObserver &  aCommandObserver
 
IMPORT_C void CEikButtonGroupContainer::UpdateHotKey TInt  aCommandId,
THotKeyFlags  aFlags,
TInt  aKeyId
 
IMPORT_C void CEikButtonGroupContainer::WriteInternalStateL RWriteStream &  aWriteStream  )  const
 

Friends And Related Function Documentation

friend class CCmdObserverArray [friend]
 
friend class CEikButtonGroupStack [friend]
 

The documentation for this class was generated from the following file:

Copyright © Nokia Corporation 2001-2007
Back to top