CEikButtonGroupContainer Class Reference

class CEikButtonGroupContainer : public CAknControl

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

eikcoctl.lib S60 0.9

Inherits from

Public Member Functions
~CEikButtonGroupContainer()
voidAddCommandL(TInt, TInt, const TDesC &)
voidAddCommandL(TInt, TInt, const CFbsBitmap &, const CFbsBitmap &)
voidAddCommandL(TInt, TInt, const TDesC &, const CFbsBitmap &, const CFbsBitmap &)
voidAddCommandL(TInt, TInt, const TDesC &, TInt, TInt)
voidAddCommandL(TInt, TInt, const TDesC &, const TDesC &, TInt, TInt)
IMPORT_C voidAddCommandSetToStackL(TInt)
voidAddCommandToStackL(TInt, TInt, const TDesC &)
voidAddCommandToStackL(TInt, TInt, const CFbsBitmap &, const CFbsBitmap &)
voidAddCommandToStackL(TInt, TInt, const TDesC &, const CFbsBitmap &, const CFbsBitmap &)
voidAddCommandToStackL(TInt, TInt, const TDesC &, TInt, TInt)
voidAddCommandToStackL(TInt, TInt, const TDesC &, const TDesC &, TInt, TInt)
voidAddCommandToStackL(TInt, TInt)
IMPORT_C voidAnimateCommand(TInt)
IMPORT_C voidAnimateCommandByPosition(TCommandPosition)
IMPORT_C CEikCommandButton *ButtonById(TInt)
IMPORT_C TIntButtonCount()
MEikButtonGroup *ButtonGroup()
TUse ButtonGroupType()
IMPORT_C TSizeCalcMinimumSizeL(TInt)
voidCleanupCommandPop()
IMPORT_C voidCleanupCommandPop(TInt)
voidCleanupCommandPopAndDestroy()
voidCleanupCommandPopAndDestroy(TInt)
IMPORT_C voidCleanupCommandPushL(TInt)
IMPORT_C CEikCommandButton *CommandButtonOrNull(TInt)
IMPORT_C CCoeControl *ControlOrNull(TInt)
IMPORT_C CEikButtonGroupContainer *Current()
IMPORT_C TBoolDelayActivation()
IMPORT_C voidDimCommand(TInt, TBool)
IMPORT_C voidDimCommandByPosition(TCommandPosition, TBool)
IMPORT_C TBoolIsCommandDimmed(TInt)
IMPORT_C TBoolIsCommandDimmedByPosition(TCommandPosition)
IMPORT_C TBoolIsCommandInGroup(const TInt)
IMPORT_C TBoolIsCommandVisible(TInt)
IMPORT_C TBoolIsCommandVisibleByPosition(TCommandPosition)
IMPORT_C TLocationLocation()
IMPORT_C voidMakeCommandVisible(TInt, TBool)
IMPORT_C voidMakeCommandVisibleByPosition(TCommandPosition, TBool)
voidMakeVisible(TBool)
IMPORT_C TIntMaxCommands()
IMPORT_C TSizeMinimumSize()
IMPORT_C CEikButtonGroupContainer *NewL(TUse, TOrientation, MEikCommandObserver *, TInt, TUint)
IMPORT_C CEikButtonGroupContainer *NewL(TUse, TOrientation, MEikCommandObserver *, TInt, const CCoeControl &, TUint)
IMPORT_C CEikButtonGroupContainer *NewL(TUse, TOrientation, MEikCommandObserver *, TInt, RWindowGroup &, TUint)
IMPORT_C voidOfferCommandListL(const RArray< TInt > &)
IMPORT_C voidOfferCommandListL(const TInt)
IMPORT_C TKeyResponseOfferKeyEventL(const TKeyEvent &, TEventCode)
IMPORT_C TIntPositionById(TInt)
IMPORT_C voidReduceRect(TRect &)
IMPORT_C voidRemoveCommandFromStack(TInt, TInt)
IMPORT_C voidRemoveCommandObserver(TInt)
IMPORT_C voidReplaceCommand(const TInt, const TInt)
IMPORT_C voidReserved_MtsmObject()
IMPORT_C voidReserved_MtsmPosition()
IMPORT_C voidSetBoundingRect(const TRect &)
voidSetCommandL(TInt, TInt, const TDesC &)
voidSetCommandL(TInt, TInt, const CFbsBitmap &, const CFbsBitmap &)
voidSetCommandL(TInt, TInt, const TDesC &, const CFbsBitmap &, const CFbsBitmap &)
voidSetCommandL(TInt, TInt, const TDesC &, TInt, TInt)
voidSetCommandL(TInt, TInt, const TDesC &, const TDesC &, TInt, TInt)
voidSetCommandL(TInt, TInt)
voidSetCommandL(TInt, const TDesC &)
voidSetCommandL(TInt, const CFbsBitmap &, const CFbsBitmap &)
voidSetCommandL(TInt, const TDesC &, const CFbsBitmap &, const CFbsBitmap &)
voidSetCommandL(TInt, const TDesC &, TInt, TInt)
voidSetCommandL(TInt, const TDesC &, const TDesC &, TInt, TInt)
IMPORT_C voidSetCommandSetL(TInt)
IMPORT_C voidSetDefaultCommand(TInt)
IMPORT_C voidUpdateCommandObserverL(TInt, MEikCommandObserver &)
IMPORT_C voidUpdateHotKey(TInt, THotKeyFlags, TInt)
voidUpdateMSKCommandObserver(CEikListBox *, MEikCommandObserver *)
IMPORT_C TBoolUpdatedCommandObserverExists(TCommandPosition)
IMPORT_C voidWriteInternalStateL(RWriteStream &)
Private Member Functions
CEikButtonGroupContainer(TUse)
CCoeControl *ButtonGroupAsControl()
voidCleanupCommandDestroy(TAny *)
CCoeControl *ComponentControl(TInt)
voidConstructL(TOrientation, MEikCommandObserver *, TInt, RWindowGroup *, TUint)
TInt CountComponentControls()
CCoeControl *CreateCustomCommandControlL(TInt)
TCmdPos DoCleanupCommandPop()
voidDoCleanupCommandPopAndDestroy()
IMPORT_C voidDoSetCommandL(TInt, TInt, const TDesC *, const CFbsBitmap *, const CFbsBitmap *, TCommandOp)
IMPORT_C voidDoSetCommandL(TInt, TInt, const TDesC *, const TDesC &, TInt, TInt, TCommandOp)
IMPORT_C voidDoSetCommandL(TInt, const TDesC *, const CFbsBitmap *, const CFbsBitmap *, TCommandOp)
IMPORT_C voidDoSetCommandL(TInt, const TDesC *, const TDesC &, TInt, TInt, TCommandOp)
IMPORT_C voidDoSetCommandL(TInt, TInt, TCommandOp)
voidProcessCommandL(TInt)
voidSizeChanged()
voidUpdateRect()
Inherited Functions
CAknControl::CAknControl()
CAknControl::~CAknControl()
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()
CCoeControl::AccumulatedZoom()const
CCoeControl::ActivateGc()const
CCoeControl::ActivateL()
CCoeControl::BackedUpWindow()const
CCoeControl::Background()const
CCoeControl::CCoeControl()
CCoeControl::CCoeControl(CCoeEnv *)
CCoeControl::CCoeControl(const CCoeControl &)
CCoeControl::CapturesPointer()const
CCoeControl::ClaimPointerGrab(TBool)
CCoeControl::ClaimPointerGrab(TInt,TBool)
CCoeControl::CloseWindow()
CCoeControl::ComponentArrayExists()const
CCoeControl::Components()
CCoeControl::Components()const
CCoeControl::ConstructFromResourceL(TResourceReader &)
CCoeControl::ControlContext()const
CCoeControl::ControlEnv()const
CCoeControl::CopyControlContextFrom(const CCoeControl *)
CCoeControl::CreateBackedUpWindowL(RWindowTreeNode &)
CCoeControl::CreateBackedUpWindowL(RWindowTreeNode &,TDisplayMode)
CCoeControl::CreateWindowL()
CCoeControl::CreateWindowL(RWindowGroup *)
CCoeControl::CreateWindowL(RWindowTreeNode &)
CCoeControl::CreateWindowL(const CCoeControl *)
CCoeControl::CustomGc()const
CCoeControl::DeactivateGc()const
CCoeControl::DrawBackground(const TRect &)const
CCoeControl::DrawDeferred()const
CCoeControl::DrawForeground(const TRect &)const
CCoeControl::DrawNow()const
CCoeControl::DrawNow(const TRect &)const
CCoeControl::DrawableWindow()const
CCoeControl::EnableDragEvents()
CCoeControl::EnableReportControlStateChange(TBool)
CCoeControl::EnableWindowTransparency()
CCoeControl::FindBackground()const
CCoeControl::FindFontProvider()const
CCoeControl::FocusChanged(TDrawNow)
CCoeControl::GetColor(TInt,TRgb &)const
CCoeControl::GetColorUseListL(CArrayFix< TCoeColorUse > &)const
CCoeControl::GetGc()const
CCoeControl::GetHelpContext(TCoeHelpContext &)const
CCoeControl::GrabbingComponent()const
CCoeControl::GrabbingComponent(TInt)const
CCoeControl::HandleComponentControlsResourceChange(TInt)
CCoeControl::HandleControlArrayEventL(CCoeControlArray::TEvent,const CCoeControlArray *,CCoeControl *,TInt)
CCoeControl::HandlePointerBufferReadyL()
CCoeControl::HandlePointerEventL(const TPointerEvent &)
CCoeControl::HandleRedrawEvent(const TRect &)const
CCoeControl::HandleResourceChange(TInt)
CCoeControl::HasBorder()const
CCoeControl::HitTest()const
CCoeControl::IgnoreEventsUntilNextPointerUp()
CCoeControl::Index(const CCoeControl *)const
CCoeControl::InitComponentArrayL()
CCoeControl::InputCapabilities()const
CCoeControl::IsActivated()const
CCoeControl::IsBackedUp()const
CCoeControl::IsBeingDestroyed()const
CCoeControl::IsBlank()const
CCoeControl::IsDimmed()const
CCoeControl::IsFocused()const
CCoeControl::IsNonFocusing()const
CCoeControl::IsReadyToDraw()const
CCoeControl::IsVisible()const
CCoeControl::LayoutManager()const
CCoeControl::MaximumWidth()const
CCoeControl::MopSupplyObject(TTypeUid)
CCoeControl::NotifyFontChange(const CCoeFontProvider *)
CCoeControl::Observer()const
CCoeControl::OverrideColorL(TInt,TRgb)
CCoeControl::OwnsWindow()const
CCoeControl::Parent()
CCoeControl::Parent()const
CCoeControl::Position()const
CCoeControl::PositionChanged()
CCoeControl::PositionRelativeToScreen()const
CCoeControl::PrepareForFocusGainL()
CCoeControl::PrepareForFocusLossL()
CCoeControl::ProcessPointerBufferReadyL()
CCoeControl::ProcessPointerEventL(const TPointerEvent &)
CCoeControl::Rect()const
CCoeControl::RecursivelyMergeInputCapabilities(TCoeInputCapabilities &)const
CCoeControl::RecursivelyMergedInputCapabilities()const
CCoeControl::RefetchPixelMappingL()
CCoeControl::RemoveFromParent()
CCoeControl::ReportEventL(MCoeControlObserver::TCoeEvent)
CCoeControl::RequestRelayout(const CCoeControl *)
CCoeControl::ResetGc()const
CCoeControl::ScreenFont(const TCoeFont &)const
CCoeControl::SetAdjacent(TInt)
CCoeControl::SetAllowStrayPointers()
CCoeControl::SetBackground(const MCoeControlBackground *)
CCoeControl::SetBlank()
CCoeControl::SetCanDrawOutsideRect()
CCoeControl::SetComponentsToInheritVisibility(TBool)
CCoeControl::SetContainerWindowL(RBackedUpWindow &)
CCoeControl::SetContainerWindowL(RWindow &)
CCoeControl::SetContainerWindowL(const CCoeControl &)
CCoeControl::SetControlContext(MCoeControlContext *)
CCoeControl::SetCornerAndSize(TGulAlignment,const TSize &)
CCoeControl::SetCustomGc(CWindowGc *)
CCoeControl::SetDimmed(TBool)
CCoeControl::SetExtent(const TPoint &,const TSize &)
CCoeControl::SetExtentToWholeScreen()
CCoeControl::SetFocus(TBool,TDrawNow)
CCoeControl::SetFocusing(TBool)
CCoeControl::SetFontProviderL(const CCoeFontProvider &)
CCoeControl::SetGc(CWindowGc *)const
CCoeControl::SetGloballyCapturing(TBool)
CCoeControl::SetHitTest(const MCoeControlHitTest *)
CCoeControl::SetLayoutManagerL(MCoeLayoutManager *)
CCoeControl::SetMaximumWidth(TInt)
CCoeControl::SetMopParent(MObjectProvider *)
CCoeControl::SetNeighbor(CCoeControl *)
CCoeControl::SetNonFocusing()
CCoeControl::SetObserver(MCoeControlObserver *)
CCoeControl::SetParent(CCoeControl *)
CCoeControl::SetPointerCapture(TBool)
CCoeControl::SetPosition(const TPoint &)
CCoeControl::SetRect(const TRect &)
CCoeControl::SetSize(const TSize &)
CCoeControl::SetSizeWithoutNotification(const TSize &)
CCoeControl::SetTextBaselineSpacing(TInt)
CCoeControl::SetUniqueHandle(TInt)
CCoeControl::SetZoomFactorL(TInt,TZoomType)
CCoeControl::Size()const
CCoeControl::SystemGc()const
CCoeControl::TextBaselineOffset(const TSize &)const
CCoeControl::TextDrawer(TInt)const
CCoeControl::UniqueHandle()const
CCoeControl::Window()const
CCoeControl::WriteInternalStateNowL(RWriteStream &)const
CCoeControl::ZoomWithType()const
CCoeControl::operator=(const CCoeControl &)
CCoeControl::~CCoeControl()
Public Member Enumerations
enumTCommandPosition { ELeftSoftkeyPosition = 0, ERightSoftkeyPosition = 2, EMiddleSoftkeyPosition = 3 }
enumTFlags { EAddToStack = 0x01, EDelayActivation = 0x02, EUseMaxSize = 0x04, EIsEmbedded = 0x08, EParentIsControl = 0x10 }
enumTHotKeyFlags { EShowHotKey = 0x01, EPlainHotKey = 0x02 }
enumTLocation { EInternal = SLafButtonGroupContainer::EInternal, EExternal = SLafButtonGroupContainer::EExternal }
enumTOrientation { EVertical = SLafButtonGroupContainer::EVertical, EHorizontal = SLafButtonGroupContainer::EHorizontal }
enumTUse { EView = SLafButtonGroupContainer::EView, EDialog = SLafButtonGroupContainer::EDialog, EToolbar = SLafButtonGroupContainer::EToolbar, ECba = SLafButtonGroupContainer::ECba, EDialogButtons = SLafButtonGroupContainer::EDialogButtons }
Private Member Enumerations
enumTCommandOp { ESet, EAdd, EPush }
Inherited Enumerations
CCoeControl:TZoomType
Private Attributes
TDblQueLink iBtLink
MEikButtonGroup *iButtonGroup
MEikCommandObserver *iCommandObserver
CArrayFix< TCmdPos > *iCommandsCleanup
CEikListBox *iMSKObserverOwner
CCmdObserverArray *iObserverArray
TInt iSpare
TUse iUse
TInt iValid
Inherited Attributes
CCoeControl::iCoeEnv
CCoeControl::iContext
CCoeControl::iPosition
CCoeControl::iSize

Constructor & Destructor Documentation

CEikButtonGroupContainer(TUse)

CEikButtonGroupContainer(TUseaUse)[private]

Parameters

TUse aUse

~CEikButtonGroupContainer()

IMPORT_C~CEikButtonGroupContainer()

Destructor.

Member Functions Documentation

AddCommandL(TInt, TInt, const TDesC &)

voidAddCommandL(TIntaPosition,
TIntaCommandId,
const TDesC &aText
)[inline]

Adds a command button with a text label and command ID.

Parameters

TInt aPositionThe position in the button group for the new button.
TInt aCommandIdCommand ID for the new button.
const TDesC & aTextText for the button.

AddCommandL(TInt, TInt, const CFbsBitmap &, const CFbsBitmap &)

voidAddCommandL(TIntaPosition,
TIntaCommandId,
const CFbsBitmap &aBitmap,
const CFbsBitmap &aMask
)[inline]

Adds a command button with a bitmap label and command ID.

Parameters

TInt aPositionThe position in the button group for the new button.
TInt aCommandIdCommand ID for the new button.
const CFbsBitmap & aBitmapBitmap for the button.
const CFbsBitmap & aMaskMask bitmap for aBitmap.

AddCommandL(TInt, TInt, const TDesC &, const CFbsBitmap &, const CFbsBitmap &)

voidAddCommandL(TIntaPosition,
TIntaCommandId,
const TDesC &aText,
const CFbsBitmap &aBitmap,
const CFbsBitmap &aMask
)[inline]

Adds a command button with a command ID and a label containing both a bitmap and text.

Parameters

TInt aPositionThe position in the button group for the new button.
TInt aCommandIdCommand ID for the new button.
const TDesC & aTextText for the button.
const CFbsBitmap & aBitmapBitmap for the button.
const CFbsBitmap & aMaskMask bitmap for aBitmap.

AddCommandL(TInt, TInt, const TDesC &, TInt, TInt)

voidAddCommandL(TIntaPosition,
TIntaCommandId,
const TDesC &aFile,
TIntaBitmapId,
TIntaMaskId
)[inline]

Adds a command button with a command ID and a bitmap which is read from a file.

Parameters

TInt aPositionThe position in the button group for the new button.
TInt aCommandIdCommand ID for the new button.
const TDesC & aFileMulti-bitmap file containing the bitmap and mask.
TInt aBitmapIdID of the bitmap within aFile.
TInt aMaskIdID of the mask within aFile.

AddCommandL(TInt, TInt, const TDesC &, const TDesC &, TInt, TInt)

voidAddCommandL(TIntaPosition,
TIntaCommandId,
const TDesC &aText,
const TDesC &aFile,
TIntaBitmapId,
TIntaMaskId
)[inline]

Adds a command button with a command ID and a label containing both a bitmap and text. The bitmap and mask are read from file.

Parameters

TInt aPositionThe position in the button group for the new button.
TInt aCommandIdCommand ID for the new button.
const TDesC & aTextText for the button.
const TDesC & aFileMulti-bitmap file containing the bitmap and mask.
TInt aBitmapIdID of the bitmap within aFile.
TInt aMaskIdID of the mask within aFile.

AddCommandSetToStackL(TInt)

IMPORT_C voidAddCommandSetToStackL(TIntaResourceId)

As with SetCommandL() but for a set of buttons, also allows the previous command button to be retrieved by calling RemoveCommand().

Parameters

TInt aResourceIdResource describing the set of command buttons.

AddCommandToStackL(TInt, TInt, const TDesC &)

voidAddCommandToStackL(TIntaPosition,
TIntaCommandId,
const TDesC &aText
)[inline]

Pushes a command button with a text label and command ID onto a position's button stack. This function behaves similarly to SetCommandL() but allows the previous command button to be retrieved by calling RemoveCommandFromStack().

Parameters

TInt aPositionThe position in the button group at which to add the command button.
TInt aCommandIdCommand ID the button will send.
const TDesC & aTextText for the button.

AddCommandToStackL(TInt, TInt, const CFbsBitmap &, const CFbsBitmap &)

voidAddCommandToStackL(TIntaPosition,
TIntaCommandId,
const CFbsBitmap &aBitmap,
const CFbsBitmap &aMask
)[inline]

Pushes a command button with a bitmap, mask and command ID onto a position's button stack. This function behaves similarly to SetCommandL() but allows the previous command button to be retrieved by calling RemoveCommandFromStack().

Parameters

TInt aPositionThe position in the button group at which to add the command button.
TInt aCommandIdCommand ID the button will send.
const CFbsBitmap & aBitmapBitmap for the button.
const CFbsBitmap & aMaskMask bitmap for aBitmap.

AddCommandToStackL(TInt, TInt, const TDesC &, const CFbsBitmap &, const CFbsBitmap &)

voidAddCommandToStackL(TIntaPosition,
TIntaCommandId,
const TDesC &aText,
const CFbsBitmap &aBitmap,
const CFbsBitmap &aMask
)[inline]

Pushes a command button with text, bitmap, mask and a command ID onto a position's button stack. This function behaves similarly to SetCommandL() but allows the previous command button to be retrieved by calling RemoveCommandFromStack().

Parameters

TInt aPositionThe position in the button group at which to add the command button.
TInt aCommandIdCommand ID the button will send.
const TDesC & aTextText for the button.
const CFbsBitmap & aBitmapBitmap for the button.
const CFbsBitmap & aMaskMask bitmap for aBitmap.

AddCommandToStackL(TInt, TInt, const TDesC &, TInt, TInt)

voidAddCommandToStackL(TIntaPosition,
TIntaCommandId,
const TDesC &aFile,
TIntaBitmapId,
TIntaMaskId
)[inline]

Pushes a command button with a bitmap, mask and command ID onto a position's button stack. The bitmap and mask are read from a file. This function behaves similarly to SetCommandL() but allows the previous command button to be retrieved by calling RemoveCommandFromStack().

Parameters

TInt aPositionThe position in the button group at which to add the command button.
TInt aCommandIdCommand ID the button will send.
const TDesC & aFileA multi-bitmap file containing mask and bitmap.
TInt aBitmapIdIndex into the file of the bitmap.
TInt aMaskIdIndex into the file of the bitmap mask.

AddCommandToStackL(TInt, TInt, const TDesC &, const TDesC &, TInt, TInt)

voidAddCommandToStackL(TIntaPosition,
TIntaCommandId,
const TDesC &aText,
const TDesC &aFile,
TIntaBitmapId,
TIntaMaskId
)[inline]

Pushes a command button with text, bitmap, mask and command button onto a position's button stack. The bitmap and mask are read from a file. This function behaves similarly to SetCommandL() but allows the previous command button to be retrieved by calling RemoveCommandFromStack().

Parameters

TInt aPositionThe position in the button group at which to push the command button.
TInt aCommandIdCommand ID the button will send.
const TDesC & aTextText for the button.
const TDesC & aFileA multi-bitmap file containing mask and bitmap.
TInt aBitmapIdIndex into the file of the bitmap.
TInt aMaskIdIndex into the file of the bitmap mask.

AddCommandToStackL(TInt, TInt)

voidAddCommandToStackL(TIntaPosition,
TIntaResourceId
)[inline]

Pushes a command button onto a position's button stack. The text, bitmap, mask and command ID are all read from resource. This function behaves similarly to SetCommandL() but allows the previous command button to be retrieved by calling RemoveCommandFromStack().

Parameters

TInt aPositionThe position in the button group at which to push the command button.
TInt aResourceIdID of a resource specifying the text, bitmaps and command ID.

AnimateCommand(TInt)

IMPORT_C voidAnimateCommand(TIntaCommandId)

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

S60 3.1

Parameters

TInt aCommandIdThe id for command to be animated.

AnimateCommandByPosition(TCommandPosition)

IMPORT_C voidAnimateCommandByPosition(TCommandPositionaPosition)

Animates the button with position aPosition.

S60 3.1

Parameters

TCommandPosition aPositionThe position for command to be animated.

ButtonById(TInt)

IMPORT_C CEikCommandButton *ButtonById(TIntaCommandId)const

Gets a pointer to the the button with the specified command Id.

The button object.

Parameters

TInt aCommandIdCommand ID of the button to obtain.

ButtonCount()

IMPORT_C TIntButtonCount()const

Gets the total number of buttons currently present in the group.

The number of buttons.

ButtonGroup()

MEikButtonGroup *ButtonGroup()[inline]

Returns the container's button group.

Pointer to the button group object. Ownership is not transferred.

ButtonGroupAsControl()

CCoeControl *ButtonGroupAsControl()const [private, inline]

ButtonGroupType()

TUse ButtonGroupType()[inline]

Returns the button group type.

The button group type.

CalcMinimumSizeL(TInt)

IMPORT_C TSizeCalcMinimumSizeL(TIntaResourceId)const

Calculates minimum size required to display the buttons defined in the specified resource structure.

Minimum size required to display the button group defined in the specified resource structure.

Parameters

TInt aResourceIdThe ID of the resource structure describing the button group.

CleanupCommandDestroy(TAny *)

voidCleanupCommandDestroy(TAny *aPtr)[private, static]

Parameters

TAny * aPtr

CleanupCommandPop()

voidCleanupCommandPop()[inline]

Removes a command from the cleanup stack without destroying it.

CleanupCommandPop(TInt)

IMPORT_C voidCleanupCommandPop(TIntaCount)

Removes one or more commands from the cleanup stack without destroying them.

Parameters

TInt aCountNumber of commands to pop.

CleanupCommandPopAndDestroy()

voidCleanupCommandPopAndDestroy()[inline]

Removes a single command which was pushed onto the cleanup stack. It does this by calling CleanupCommandPushL(), rolling back to the previous details. The command button popped is destroyed.

CleanupCommandPopAndDestroy(TInt)

voidCleanupCommandPopAndDestroy(TIntaCount)[inline]

Removes one or more commands which were pushed onto the cleanup stack. It does this by calling CleanupCommandPushL(), rolling back to the previous details. The command buttons popped are destroyed.

Parameters

TInt aCountNumber of commands to pop and destroy.

CleanupCommandPushL(TInt)

IMPORT_C voidCleanupCommandPushL(TIntaPosition)

Places the command in position aPosition in the group on the cleanup stack. Typically used when a control or view changes the contents of two or more buttons on receipt of focus. After altering one command with a call to AddCommandToStackL() the push is made to guarantee the display will be left in a consistent state if the second (and any subsequent) calls to AddCommandToStackL() fail. Only a single command can be pushed for each position.

Parameters

TInt aPositionPosition in the container of the button to push.

CommandButtonOrNull(TInt)

IMPORT_C CEikCommandButton *CommandButtonOrNull(TIntaCommandId)const

Gets a pointer to the command button with the specified command Id.

Pointer to the command button CEikCommandButton, NULL if there was no button with Id aCommandId.

Parameters

TInt aCommandIdCommand ID of the button.

ComponentControl(TInt)

CCoeControl *ComponentControl(TIntaIndex)const [private, virtual]

Parameters

TInt aIndex

ConstructL(TOrientation, MEikCommandObserver *, TInt, RWindowGroup *, TUint)

voidConstructL(TOrientationaOrientation,
MEikCommandObserver *aCommandObserver,
TIntaResourceId,
RWindowGroup *aParentWg,
TUintaFlags
)[private]

Parameters

TOrientation aOrientation
MEikCommandObserver * aCommandObserver
TInt aResourceId
RWindowGroup * aParentWg
TUint aFlags

ControlOrNull(TInt)

IMPORT_C CCoeControl *ControlOrNull(TIntaCommandId)const

Gets a pointer to the control (button) with the specified command ID. This method is intended to allow access to standard CCoeControl functionality only. Casting the return value is likely to fail on different devices.

Pointer to a CCoeControl, NULL if there was no button at aCommandId.

Parameters

TInt aCommandIdCommand ID of the button to get.

CountComponentControls()

TInt CountComponentControls()const [private, virtual]

CreateCustomCommandControlL(TInt)

CCoeControl *CreateCustomCommandControlL(TIntaControlType)[private]

Parameters

TInt aControlType

Current()

IMPORT_C CEikButtonGroupContainer *Current()[static]

Gets a pointer to an application's currently active CEikButtonGroupContainer (if any).

Returns NULL if there are no containers active or none suitable for sharing. Ownership of the returned pointer is not transferred.

Pointer to the button group container.

DelayActivation()

IMPORT_C TBoolDelayActivation()const

Tests whether the button group has explicitly been instructed to suppress redraws. Some button groups may not activate themselves during construction, in which case, they need to be activated by the client. This method allows the client to enquire whether this is necessary.

ETrue if the button group will suppress redraws, otherwise EFalse.

DimCommand(TInt, TBool)

IMPORT_C voidDimCommand(TIntaCommandId,
TBoolaDimmed
)

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

TInt aCommandIdThe id for command to be dimmed.
TBool aDimmedETrue for dimming.

DimCommandByPosition(TCommandPosition, TBool)

IMPORT_C voidDimCommandByPosition(TCommandPositionaPosition,
TBoolaDimmed
)

Dims (but doesn't draw) the button with position aPosition.

S60 3.1

Parameters

TCommandPosition aPositionThe position for command to be dimmed.
TBool aDimmedETrue for dimming.

DoCleanupCommandPop()

TCmdPos DoCleanupCommandPop()[private]

DoCleanupCommandPopAndDestroy()

voidDoCleanupCommandPopAndDestroy()[private]

DoSetCommandL(TInt, TInt, const TDesC *, const CFbsBitmap *, const CFbsBitmap *, TCommandOp)

IMPORT_C voidDoSetCommandL(TIntaPosition,
TIntaCommandId,
const TDesC *aText,
const CFbsBitmap *aBitmap,
const CFbsBitmap *aMask,
TCommandOpaOp
)[private]

Parameters

TInt aPosition
TInt aCommandId
const TDesC * aText
const CFbsBitmap * aBitmap
const CFbsBitmap * aMask
TCommandOp aOp

DoSetCommandL(TInt, TInt, const TDesC *, const TDesC &, TInt, TInt, TCommandOp)

IMPORT_C voidDoSetCommandL(TIntaPosition,
TIntaCommandId,
const TDesC *aText,
const TDesC &aFile,
TIntaBitmapId,
TIntaMaskId,
TCommandOpaOp
)[private]

Parameters

TInt aPosition
TInt aCommandId
const TDesC * aText
const TDesC & aFile
TInt aBitmapId
TInt aMaskId
TCommandOp aOp

DoSetCommandL(TInt, const TDesC *, const CFbsBitmap *, const CFbsBitmap *, TCommandOp)

IMPORT_C voidDoSetCommandL(TIntaCommandId,
const TDesC *aText,
const CFbsBitmap *aBitmap,
const CFbsBitmap *aMask,
TCommandOpaOp
)[private]

Parameters

TInt aCommandId
const TDesC * aText
const CFbsBitmap * aBitmap
const CFbsBitmap * aMask
TCommandOp aOp

DoSetCommandL(TInt, const TDesC *, const TDesC &, TInt, TInt, TCommandOp)

IMPORT_C voidDoSetCommandL(TIntaCommandId,
const TDesC *aText,
const TDesC &aFile,
TIntaBitmapId,
TIntaMaskId,
TCommandOpaOp
)[private]

Parameters

TInt aCommandId
const TDesC * aText
const TDesC & aFile
TInt aBitmapId
TInt aMaskId
TCommandOp aOp

DoSetCommandL(TInt, TInt, TCommandOp)

IMPORT_C voidDoSetCommandL(TIntaPosition,
TIntaResourceId,
TCommandOpaOp
)[private]

Parameters

TInt aPosition
TInt aResourceId
TCommandOp aOp

IsCommandDimmed(TInt)

IMPORT_C TBoolIsCommandDimmed(TIntaCommandId)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.

The state of the button.

Parameters

TInt aCommandIdThe id for command to be checked.

IsCommandDimmedByPosition(TCommandPosition)

IMPORT_C TBoolIsCommandDimmedByPosition(TCommandPositionaPosition)const

Returns ETrue if the button with position aPosition is dimmed.

S60 3.1

The state of the button.

Parameters

TCommandPosition aPositionThe position for command to be checked.

IsCommandInGroup(const TInt)

IMPORT_C TBoolIsCommandInGroup(const TIntaCommandId)const

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

S60 3.2

ETrue if command is in control group, otherwise EFalse.

Parameters

const TInt aCommandIdThe id for command which existence should be checked.

IsCommandVisible(TInt)

IMPORT_C TBoolIsCommandVisible(TIntaCommandId)const

Returns ETrue if the button with id aCommandId is visible. If two buttons have the same id, the results are undefined.

The state of the button.

Parameters

TInt aCommandIdThe id for command to be checked.

IsCommandVisibleByPosition(TCommandPosition)

IMPORT_C TBoolIsCommandVisibleByPosition(TCommandPositionaPosition)const

Returns ETrue if the button with position aPosition is visible.

S60 3.1

The state of the button.

Parameters

TCommandPosition aPositionThe position for command to be checked.

Location()

IMPORT_C TLocationLocation()const

Gets the button group's location. Typically the button group is external to the view which is using it. In some cases, such as in dialogs with button panels, the button group is internal to the control which is using it.

The button group's location.

MakeCommandVisible(TInt, TBool)

IMPORT_C voidMakeCommandVisible(TIntaCommandId,
TBoolaVisible
)

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

TInt aCommandIdThe id for command to be made visible.
TBool aVisibleEFalse for making button invisible.

MakeCommandVisibleByPosition(TCommandPosition, TBool)

IMPORT_C voidMakeCommandVisibleByPosition(TCommandPositionaPosition,
TBoolaVisible
)

Sets the the button with position aPosition to be visible if aVisible is ETrue.

S60 3.1

Parameters

TCommandPosition aPositionThe position for command to be made visible.
TBool aVisibleEFalse for making button invisible.

MakeVisible(TBool)

voidMakeVisible(TBoolaVisible)[virtual]

From CCoeControl. Sets this control as visible or invisible.

Parameters

TBool aVisibleETrue to make the control visible, EFalse to make it invisible.

MaxCommands()

IMPORT_C TIntMaxCommands()const

Gets the maximum number of buttons that can be supported by the device.

The number of command buttons supported.

MinimumSize()

IMPORT_C TSizeMinimumSize()[virtual]

From CCoeControl. Gets the control's minimum required size.

The minimum size required by the control.

NewL(TUse, TOrientation, MEikCommandObserver *, TInt, TUint)

IMPORT_C CEikButtonGroupContainer *NewL(TUseaUse,
TOrientationaOrientation,
MEikCommandObserver *aCommandObserver,
TIntaResourceId,
TUintaFlags = EAddToStack
)[static]

Creates a button group container in its own window.

Button group container object.

Parameters

TUse aUseThe button group's type.
TOrientation aOrientationThe button group's orientation. You need specify this only for devices that can layout their buttons either horizontally or vertically.
MEikCommandObserver * aCommandObserverA command observer to be notified of commands on the container.
TInt aResourceIdA resource containing descriptions of buttons in the group. This can be NULL if buttons are to be added dynamically.
TUint aFlags = EAddToStackThe button group's flags.

NewL(TUse, TOrientation, MEikCommandObserver *, TInt, const CCoeControl &, TUint)

IMPORT_C CEikButtonGroupContainer *NewL(TUseaUse,
TOrientationaOrientation,
MEikCommandObserver *aCommandObserver,
TIntaResourceId,
const CCoeControl &aParent,
TUintaFlags = EAddToStack
)[static]

Creates a button group container in its parent control's window.

Button group container object.

Parameters

TUse aUseThe button group's type.
TOrientation aOrientationThe button group's orientation. You need specify this only for devices that can layout their buttons either horizontally or vertically.
MEikCommandObserver * aCommandObserverA command observer to be notified of commands on the container.
TInt aResourceIdA resource containing descriptions of buttons in the group. This can be NULL if buttons are to be added dynamically.
const CCoeControl & aParentThe control's parent.
TUint aFlags = EAddToStackThe button group's flags.

NewL(TUse, TOrientation, MEikCommandObserver *, TInt, RWindowGroup &, TUint)

IMPORT_C CEikButtonGroupContainer *NewL(TUseaUse,
TOrientationaOrientation,
MEikCommandObserver *aCommandObserver,
TIntaResourceId,
RWindowGroup &aParentWg,
TUintaFlags = EAddToStack
)[static]

Creates a button group container in given window group.

Button group container object.

Parameters

TUse aUseThe button group's type.
TOrientation aOrientationThe button group's orientation. You need specify this only for devices that can layout their buttons either horizontally or vertically.
MEikCommandObserver * aCommandObserverA command observer to be notified of commands on the container.
TInt aResourceIdA resource containing descriptions of buttons in the group. This can be NULL if buttons are to be added dynamically.
RWindowGroup & aParentWgThe parent window group.
TUint aFlags = EAddToStackThe button group's flags.

OfferCommandListL(const RArray< TInt > &)

IMPORT_C voidOfferCommandListL(const RArray< TInt > &aCommandList)

Used to offer list of commands for softkeys.

S60 3.2

Parameters

const RArray< TInt > & aCommandListA list of command ids to be offered for softkeys.

OfferCommandListL(const TInt)

IMPORT_C voidOfferCommandListL(const TIntaResourceId)

Used to offer list of commands for softkeys.

S60 3.2

Parameters

const TInt aResourceIdId for CBA resource that defines enhanced cba buttons.

OfferKeyEventL(const TKeyEvent &, TEventCode)

IMPORT_C TKeyResponseOfferKeyEventL(const TKeyEvent &aKeyEvent,
TEventCodeaType
)[virtual]

From CCoeControl. Handles key events.

Indicates whether or not the key event was used by this control.

Parameters

const TKeyEvent & aKeyEventThe key event.
TEventCode aTypeThe type of key event: EEventKey, EEventKeyUp or EEventKeyDown.

PositionById(TInt)

IMPORT_C TIntPositionById(TIntaCommandId)const

Gets the position in the group of the button with the specified command Id. The return value is undefined if two buttons share the same id.

The command's container position.

Parameters

TInt aCommandIdIdentifies the command.

ProcessCommandL(TInt)

voidProcessCommandL(TIntaCommandId)[private]

Parameters

TInt aCommandId

ReduceRect(TRect &)

IMPORT_C voidReduceRect(TRect &aBoundingRect)const

Subtracts the area occupied by the button group from the specified bounding rectangle. This method should be used in preference to querying the container's area at all times. For use by EExternal button groups only.

Parameters

TRect & aBoundingRectRectangle to be modified.

RemoveCommandFromStack(TInt, TInt)

IMPORT_C voidRemoveCommandFromStack(TIntaPosition,
TIntaCommandId
)

Removes the command identified by aCommandId, in position aPosition in the group, from the command stack. Automatically retrieves the previous command details. Commands are added to the stack by calling AddCommandToStackL.

Parameters

TInt aPositionThe position in the button group from which to remove the command button.
TInt aCommandIdCommand ID.

RemoveCommandObserver(TInt)

IMPORT_C voidRemoveCommandObserver(TIntaPos)

Removes the temporary observer for the button at aPos, replacing it with the observer that was present when UpdateCommandObserverL() was called.

Parameters

TInt aPosThe button's position.

ReplaceCommand(const TInt, const TInt)

IMPORT_C voidReplaceCommand(const TIntaCommandId,
const TIntaResourceId
)

Replaces command with another.

S60 3.2

Parameters

const TInt aCommandIdId for command that should be replaced.
const TInt aResourceIdResource id for new enhanced cba button.

Reserved_MtsmObject()

IMPORT_C voidReserved_MtsmObject()[virtual]

Formerly from MTopSetMember<CEikButtonGroupContainer>, now reserved.

Reserved_MtsmPosition()

IMPORT_C voidReserved_MtsmPosition()[virtual]

Formerly from MTopSetMember<CEikButtonGroupContainer>, now reserved.

SetBoundingRect(const TRect &)

IMPORT_C voidSetBoundingRect(const TRect &aRect)

Sets the boundary rectangle for externally-positioned button groups. For use by EExternal button groups only.

Parameters

const TRect & aRectThe boundary rectangle to use. The button group attaches itself to the inside of this rectangle.

SetCommandL(TInt, TInt, const TDesC &)

voidSetCommandL(TIntaPosition,
TIntaCommandId,
const TDesC &aText
)[inline]

Sets a command button's text label and command ID.

Parameters

TInt aPositionThe position within the button group of the button to change. If the position is out of range this function raises a panic.
TInt aCommandIdCommand ID the button will send.
const TDesC & aTextText for the button.

SetCommandL(TInt, TInt, const CFbsBitmap &, const CFbsBitmap &)

voidSetCommandL(TIntaPosition,
TIntaCommandId,
const CFbsBitmap &aBitmap,
const CFbsBitmap &aMask
)[inline]

Sets a command button's bitmap and command ID.

Parameters

TInt aPositionThe position within the button group of the button to change. If the position is out of range this function raises a panic.
TInt aCommandIdCommand ID the button will send.
const CFbsBitmap & aBitmapThe bitmap for the button.
const CFbsBitmap & aMaskThe mask bitmap for aBitmap.

SetCommandL(TInt, TInt, const TDesC &, const CFbsBitmap &, const CFbsBitmap &)

voidSetCommandL(TIntaPosition,
TIntaCommandId,
const TDesC &aText,
const CFbsBitmap &aBitmap,
const CFbsBitmap &aMask
)[inline]

Sets a command button's bitmap, text and command ID.

Parameters

TInt aPositionThe position within the button group of the button to change. If the position is out of range, the function raises a panic.
TInt aCommandIdCommand ID the button will send.
const TDesC & aTextThe text for the button.
const CFbsBitmap & aBitmapThe bitmap for the button.
const CFbsBitmap & aMaskThe mask bitmap for aBitmap.

SetCommandL(TInt, TInt, const TDesC &, TInt, TInt)

voidSetCommandL(TIntaPosition,
TIntaCommandId,
const TDesC &aFile,
TIntaBitmapId,
TIntaMaskId
)[inline]

Sets a command button's bitmap and command ID. The bitmap and its mask are read from a file.

Parameters

TInt aPositionThe position within the button group of the button to change. If the position is out of range, the function raises a panic.
TInt aCommandIdCommand ID the button will send.
const TDesC & aFileA multi-bitmap file, containing mask and bitmap images.
TInt aBitmapIdID of the bitmap within aFile.
TInt aMaskIdID of the mask within aFile.

SetCommandL(TInt, TInt, const TDesC &, const TDesC &, TInt, TInt)

voidSetCommandL(TIntaPosition,
TIntaCommandId,
const TDesC &aText,
const TDesC &aFile,
TIntaBitmapId,
TIntaMaskId
)[inline]

Sets a command button's bitmap, text label and command ID. The bitmap and its mask are read from a file.

Parameters

TInt aPositionThe position within the button group of the button to change. If the position is out of range, the function raises a panic.
TInt aCommandIdCommand ID the button will send.
const TDesC & aTextThe text for the button.
const TDesC & aFileA multi-bitmap file, containing mask and bitmap images.
TInt aBitmapIdID of the bitmap within aFile.
TInt aMaskIdID of the mask within aFile.

SetCommandL(TInt, TInt)

voidSetCommandL(TIntaPosition,
TIntaResourceId
)[inline]

Sets a command button's bitmap, text label and command ID. The bitmap, mask, text and command ID are all read from resource.

Parameters

TInt aPositionThe position within the button group of the button to change. If the position is out of range, the function raises a panic.
TInt aResourceIdResource ID specifying the text, bitmaps and command ID.

SetCommandL(TInt, const TDesC &)

voidSetCommandL(TIntaCommandId,
const TDesC &aText
)[inline]

Sets a command button's text. The button to change is identified by its command ID.

leave

KErrNotFound The ID cannot be matched to any button.

Parameters

TInt aCommandIdCommand ID of the button to change.
const TDesC & aTextThe text for the button.

SetCommandL(TInt, const CFbsBitmap &, const CFbsBitmap &)

voidSetCommandL(TIntaCommandId,
const CFbsBitmap &aBitmap,
const CFbsBitmap &aMask
)[inline]

Sets a command button's bitmap and mask. The button to change is identified by its command ID.

leave

KErrNotFound The ID cannot be matched to any button.

Parameters

TInt aCommandIdCommand ID of the button to change.
const CFbsBitmap & aBitmapBitmap for the button.
const CFbsBitmap & aMaskMask bitmap for aBitmap.

SetCommandL(TInt, const TDesC &, const CFbsBitmap &, const CFbsBitmap &)

voidSetCommandL(TIntaCommandId,
const TDesC &aText,
const CFbsBitmap &aBitmap,
const CFbsBitmap &aMask
)[inline]

Sets a command button's bitmap, mask and text. The button to change is identified by its command ID.

Parameters

TInt aCommandIdCommand ID of the button to change.
const TDesC & aTextText for the button.
const CFbsBitmap & aBitmapBitmap for the button.
const CFbsBitmap & aMaskMask bitmap for aBitmap.

SetCommandL(TInt, const TDesC &, TInt, TInt)

voidSetCommandL(TIntaCommandId,
const TDesC &aFile,
TIntaBitmapId,
TIntaMaskId
)[inline]

Sets a command button's bitmap and mask. The bitmap and mask are read from a multi bitmap file. The button to change is identified by its command ID.

Parameters

TInt aCommandIdCommand ID of the button to change.
const TDesC & aFileA multi-bitmap file, containing mask and bitmap images.
TInt aBitmapIdID of the bitmap within aFile.
TInt aMaskIdID of the mask within aFile.

SetCommandL(TInt, const TDesC &, const TDesC &, TInt, TInt)

voidSetCommandL(TIntaCommandId,
const TDesC &aText,
const TDesC &aFile,
TIntaBitmapId,
TIntaMaskId
)[inline]

Sets a command button's bitmap, mask and text. The bitmap and its mask are read from a multi bitmap file. The button to change is identified by its command ID.

Parameters

TInt aCommandIdCommand ID of the button to change.
const TDesC & aTextText for the button.
const TDesC & aFileA multi-bitmap file, containing mask and bitmap images.
TInt aBitmapIdID of the bitmap within aFile.
TInt aMaskIdID of the mask within aFile.

SetCommandSetL(TInt)

IMPORT_C voidSetCommandSetL(TIntaResourceId)

Initialises the group of command buttons from a resource.

Parameters

TInt aResourceIdID of the resource structure specifying the command buttons.

SetDefaultCommand(TInt)

IMPORT_C voidSetDefaultCommand(TIntaCommandId)

Sets the default command ID for buttons in this container.

Parameters

TInt aCommandIdCommand to issue if no other is specified.

SizeChanged()

voidSizeChanged()[private, virtual]

UpdateCommandObserverL(TInt, MEikCommandObserver &)

IMPORT_C voidUpdateCommandObserverL(TIntaPos,
MEikCommandObserver &aCommandObserver
)

Changes the command observer for the button at aPos to aCommandObserver. Panics if an updated observer is already present. This function should be followed by RemoveCommandObserver() when you need to put back the original observer.

Parameters

TInt aPosThe button's position.
MEikCommandObserver & aCommandObserverThe command observer.

UpdateHotKey(TInt, THotKeyFlags, TInt)

IMPORT_C voidUpdateHotKey(TIntaCommandId,
THotKeyFlagsaFlags,
TIntaKeyId
)

Updates a command's hotkey and whether the key is displayed. This function is only supported by containers being used for dialog buttons.

Parameters

TInt aCommandIdIdentifies the command to update.
THotKeyFlags aFlagsWhether to display the hotkey.
TInt aKeyIdHotkey identifier.

UpdateMSKCommandObserver(CEikListBox *, MEikCommandObserver *)

voidUpdateMSKCommandObserver(CEikListBox *aMSKObserverOwner,
MEikCommandObserver *aCommandObserver
)

Internal method for setting markable list's MSK observer. This observer is called before default CBA observer if MSK is pressed. Observer is removed by passing NULL as parameter.

S60 3.1

Parameters

CEikListBox * aMSKObserverOwner
MEikCommandObserver * aCommandObserver

UpdateRect()

voidUpdateRect()[private]

UpdatedCommandObserverExists(TCommandPosition)

IMPORT_C TBoolUpdatedCommandObserverExists(TCommandPositionaPosition)const

Checks for existence of updated command observer for the button at aPosition.

S60 3.2

ETrue, if updated command observer exists.

Parameters

TCommandPosition aPositionThe position for button to be checked.

WriteInternalStateL(RWriteStream &)

IMPORT_C voidWriteInternalStateL(RWriteStream &aWriteStream)const [virtual]

From CCoeControl. Writes the internal state of the control and its components to aStream. Does nothing in release mode.

Parameters

RWriteStream & aWriteStreamThe output stream.

Member Enumerations Documentation

Enum TCommandOp

Enumerators

ESet
EAdd
EPush

Enum TCommandPosition

Defines the positions for each command.

Enumerators

ELeftSoftkeyPosition = 0
ERightSoftkeyPosition = 2
EMiddleSoftkeyPosition = 3

Enum TFlags

Additional flags.

Enumerators

EAddToStack = 0x01
EDelayActivation = 0x02
EUseMaxSize = 0x04
EIsEmbedded = 0x08
EParentIsControl = 0x10

Enum THotKeyFlags

Flags for the display of hotkeys.

Enumerators

EShowHotKey = 0x01
EPlainHotKey = 0x02

Enum TLocation

Relative positions of the container and the control which uses it.

Enumerators

EInternal = SLafButtonGroupContainer::EInternal

The button group is internal to the control which is using it. E.g. dialog buttons.

EExternal = SLafButtonGroupContainer::EExternal

The button group is external to the control which is using it. E.g. toolbar or cba.

Enum TOrientation

Describes the orientation of the container.

Enumerators

EVertical = SLafButtonGroupContainer::EVertical
EHorizontal = SLafButtonGroupContainer::EHorizontal

Enum TUse

Describes how the container is being used.

The enumeration is used by the system to create the appropriate (UI variant-specific) button group for the specified type.

Enumerators

EView = SLafButtonGroupContainer::EView
EDialog = SLafButtonGroupContainer::EDialog
EToolbar = SLafButtonGroupContainer::EToolbar
ECba = SLafButtonGroupContainer::ECba
EDialogButtons = SLafButtonGroupContainer::EDialogButtons

Member Data Documentation

TDblQueLink iBtLink

TDblQueLink iBtLink[private]

MEikButtonGroup * iButtonGroup

MEikButtonGroup *iButtonGroup[private]

MEikCommandObserver * iCommandObserver

MEikCommandObserver *iCommandObserver[private]

CArrayFix< TCmdPos > * iCommandsCleanup

CArrayFix< TCmdPos > *iCommandsCleanup[private]

CEikListBox * iMSKObserverOwner

CEikListBox *iMSKObserverOwner[private]

CCmdObserverArray * iObserverArray

CCmdObserverArray *iObserverArray[private]

TInt iSpare

TInt iSpare[private]

TUse iUse

TUse iUse[private]

TInt iValid

TInt iValid[private]