MEikButtonGroup Class Reference

class MEikButtonGroup

Abstract base class for EIKON button group.

eikcoctl.lib
Since
S60 0.9

Member Functions Documentation

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

voidAddCommandL(TIntaPosition,
TIntaCommandId,
const TDesC *aText,
const CFbsBitmap *aBitmap,
const CFbsBitmap *aMask
)[pure virtual]

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.

AddCommandSetToStackL(TInt)

voidAddCommandSetToStackL(TIntaResourceId)[pure virtual]

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 *, const CFbsBitmap *, const CFbsBitmap *)

voidAddCommandToStackL(TIntaPosition,
TIntaCommandId,
const TDesC *aText,
const CFbsBitmap *aBitmap,
const CFbsBitmap *aMask
)[pure virtual]

Pushes a command button with text, bitmap, mask and a command ID onto a position's button stack.

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)

voidAddCommandToStackL(TIntaPosition,
TIntaResourceId
)[pure virtual]

Pushes a command button onto a position's button stack. The text, bitmap, mask and command ID are all read from resource.

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)[virtual]

Animates the button with the specified id.

Parameters

TInt aCommandIdThe button to animate.

AnimateCommandByPosition(TInt)

voidAnimateCommandByPosition(TIntaPosition)[pure virtual]

Animates the button with position aPosition.

Parameters

TInt aPositionThe position for command to be animated.

AsControl()

CCoeControl *AsControl()[pure virtual]

Returns the button group as a control.

AsControl()

const CCoeControl *AsControl()const [pure virtual]

Returns the button group as a control.

ButtonCount()

TInt ButtonCount()const [pure virtual]

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

ButtonGroupFlags()

TUint ButtonGroupFlags()const [pure virtual]

Gets the button group flags.

CalcMinimumSizeL(TInt)

TSize CalcMinimumSizeL(TIntaResourceId)[pure virtual]

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

Parameters

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

CommandId(TInt)

TInt CommandId(TIntaCommandPos)const [pure virtual]

Returns the command id by position.

Parameters

TInt aCommandPosThe command's position.

CommandPos(TInt)

TInt CommandPos(TIntaCommandId)const [pure virtual]

Returns the command position by command id.

Parameters

TInt aCommandIdThe button's command id.

DimCommand(TInt, TBool)

voidDimCommand(TIntaCommandId,
TBoolaDimmed
)[pure virtual]

Dims or undims a button without drawing it.

Parameters

TInt aCommandIdCommand ID of the button to change.
TBool aDimmedETrue to dim the specified command. EFalse to undim the specified command.

DimCommandByPosition(TInt, TBool)

voidDimCommandByPosition(TIntaPosition,
TBoolaDimmed
)[pure virtual]

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

Parameters

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

GroupControlAsButton(TInt)

CEikCommandButton *GroupControlAsButton(TIntaCommandId)const [pure virtual]

Returns a group control (a button) as a command button.

Parameters

TInt aCommandIdThe button's command id.

GroupControlById(TInt)

CCoeControl *GroupControlById(TIntaCommandId)const [pure virtual]

Returns a group control (a button) as a control.

Parameters

TInt aCommandIdThe button's command id.

IsCommandDimmed(TInt)

TBool IsCommandDimmed(TIntaCommandId)const [pure virtual]

Determines whether the button with the specified command ID is dimmed.

Parameters

TInt aCommandIdThe command ID.

IsCommandDimmedByPosition(TInt)

TBool IsCommandDimmedByPosition(TIntaPosition)const [pure virtual]

Returns ETrue if the button with position aPosition is dimmed.

Parameters

TInt aPositionThe position for command to be checked.

IsCommandVisible(TInt)

TBool IsCommandVisible(TIntaCommandId)const [pure virtual]

Tests whether the button with the specified command ID is visible.

Parameters

TInt aCommandIdSpecifies the button.

IsCommandVisibleByPosition(TInt)

TBool IsCommandVisibleByPosition(TIntaPosition)const [pure virtual]

Returns ETrue if the button with position aPosition is visible.

Parameters

TInt aPositionThe position for command to be checked.

MakeCommandVisible(TInt, TBool)

voidMakeCommandVisible(TIntaCommandId,
TBoolaVisible
)[pure virtual]

Makes the button with the specified id either visible, or invisible.

Parameters

TInt aCommandIdSpecifies the button to alter.
TBool aVisibleETrue to make the specified button visible. EFalse to make the specified button invisible.

MakeCommandVisibleByPosition(TInt, TBool)

voidMakeCommandVisibleByPosition(TIntaPosition,
TBoolaVisible
)[pure virtual]

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

Parameters

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

ReduceRect(TRect &)

voidReduceRect(TRect &aBoundingRect)const [pure virtual]

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.

Release()

voidRelease()

Deletes the object.

RemoveCommandFromStack(TInt, TInt)

voidRemoveCommandFromStack(TIntaPosition,
TIntaCommandId
)[pure virtual]

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.

Reserved_1()

IMPORT_C voidReserved_1()[private]

SetBoundingRect(const TRect &)

voidSetBoundingRect(const TRect &aBoundingRect)[pure virtual]

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

Parameters

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

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

voidSetCommandL(TIntaPosition,
TIntaCommandId,
const TDesC *aText,
const CFbsBitmap *aBitmap,
const CFbsBitmap *aMask
)[pure virtual]

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

Parameters

TInt aPositionThe position within the button group of the button to change.
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)

voidSetCommandL(TIntaPosition,
TIntaResourceId
)[pure virtual]

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.
TInt aResourceIdResource ID specifying the text, bitmaps and command ID.

SetCommandSetL(TInt)

voidSetCommandSetL(TIntaResourceId)[pure virtual]

Initialises the group of command buttons from a resource.

Parameters

TInt aResourceIdID of the resource structure specifying the command buttons.

SetDefaultCommand(TInt)

voidSetDefaultCommand(TIntaCommandId)[pure virtual]

Sets the default command ID for buttons in this button group.

Parameters

TInt aCommandIdCommand to issue if no other is specified.

SetMSKCommandObserver(MEikCommandObserver *)

voidSetMSKCommandObserver(MEikCommandObserver *aCommandObserver)[pure virtual]

Sets the middle softkey command observer.

Parameters

MEikCommandObserver * aCommandObserverThe middle softkey command observer.