Symbian^3 Application Developer Library >

MEikButtonGroup Class Reference

class MEikButtonGroup

Abstract base class for EIKON button group.

eikcoctl.lib
Since
S60 0.9
Public Member Functions
void AddCommandL ( TInt , TInt , const TDesC *, const CFbsBitmap *, const CFbsBitmap *)
void AddCommandSetToStackL ( TInt )
void AddCommandToStackL ( TInt , TInt , const TDesC *, const CFbsBitmap *, const CFbsBitmap *)
void AddCommandToStackL ( TInt , TInt )
IMPORT_C void AnimateCommand ( TInt )
void AnimateCommandByPosition ( TInt )
CCoeControl * AsControl ()
const CCoeControl * AsControl ()
TInt ButtonCount ()
TUint ButtonGroupFlags ()
TSize CalcMinimumSizeL ( TInt )
TInt CommandId ( TInt )
TInt CommandPos ( TInt )
void DimCommand ( TInt , TBool )
void DimCommandByPosition ( TInt , TBool )
CEikCommandButton * GroupControlAsButton ( TInt )
CCoeControl * GroupControlById ( TInt )
TBool IsCommandDimmed ( TInt )
TBool IsCommandDimmedByPosition ( TInt )
TBool IsCommandVisible ( TInt )
TBool IsCommandVisibleByPosition ( TInt )
void MakeCommandVisible ( TInt , TBool )
void MakeCommandVisibleByPosition ( TInt , TBool )
void ReduceRect ( TRect &)
void Release ()
void RemoveCommandFromStack ( TInt , TInt )
void SetBoundingRect (const TRect &)
void SetCommandL ( TInt , TInt , const TDesC *, const CFbsBitmap *, const CFbsBitmap *)
void SetCommandL ( TInt , TInt )
void SetCommandSetL ( TInt )
void SetDefaultCommand ( TInt )
void SetMSKCommandObserver ( MEikCommandObserver *)
Private Member Functions
IMPORT_C void Reserved_1 ()

Member Functions Documentation

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

void AddCommandL ( TInt aPosition,
TInt aCommandId,
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 aPosition The position in the button group for the new button.
TInt aCommandId Command ID for the new button.
const TDesC * aText Text for the button.
const CFbsBitmap * aBitmap Bitmap for the button.
const CFbsBitmap * aMask Mask bitmap for aBitmap.

AddCommandSetToStackL(TInt)

void AddCommandSetToStackL ( TInt aResourceId ) [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 aResourceId Resource describing the set of command buttons.

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

void AddCommandToStackL ( TInt aPosition,
TInt aCommandId,
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 aPosition The position in the button group at which to add the command button.
TInt aCommandId Command ID the button will send.
const TDesC * aText Text for the button.
const CFbsBitmap * aBitmap Bitmap for the button.
const CFbsBitmap * aMask Mask bitmap for aBitmap.

AddCommandToStackL(TInt, TInt)

void AddCommandToStackL ( TInt aPosition,
TInt aResourceId
) [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 aPosition The position in the button group at which to push the command button.
TInt aResourceId ID of a resource specifying the text, bitmaps and command ID.

AnimateCommand(TInt)

IMPORT_C void AnimateCommand ( TInt aCommandId ) [virtual]

Animates the button with the specified id.

Parameters

TInt aCommandId The button to animate.

AnimateCommandByPosition(TInt)

void AnimateCommandByPosition ( TInt aPosition ) [pure virtual]

Animates the button with position aPosition.

Parameters

TInt aPosition The 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 ( TInt aResourceId ) [pure virtual]

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

Parameters

TInt aResourceId The ID of the resource structure describing the button group.

CommandId(TInt)

TInt CommandId ( TInt aCommandPos ) const [pure virtual]

Returns the command id by position.

Parameters

TInt aCommandPos The command's position.

CommandPos(TInt)

TInt CommandPos ( TInt aCommandId ) const [pure virtual]

Returns the command position by command id.

Parameters

TInt aCommandId The button's command id.

DimCommand(TInt, TBool)

void DimCommand ( TInt aCommandId,
TBool aDimmed
) [pure virtual]

Dims or undims a button without drawing it.

Parameters

TInt aCommandId Command ID of the button to change.
TBool aDimmed ETrue to dim the specified command. EFalse to undim the specified command.

DimCommandByPosition(TInt, TBool)

void DimCommandByPosition ( TInt aPosition,
TBool aDimmed
) [pure virtual]

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

Parameters

TInt aPosition The position for command to be dimmed.
TBool aDimmed ETrue for dimming.

GroupControlAsButton(TInt)

CEikCommandButton * GroupControlAsButton ( TInt aCommandId ) const [pure virtual]

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

Parameters

TInt aCommandId The button's command id.

GroupControlById(TInt)

CCoeControl * GroupControlById ( TInt aCommandId ) const [pure virtual]

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

Parameters

TInt aCommandId The button's command id.

IsCommandDimmed(TInt)

TBool IsCommandDimmed ( TInt aCommandId ) const [pure virtual]

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

Parameters

TInt aCommandId The command ID.

IsCommandDimmedByPosition(TInt)

TBool IsCommandDimmedByPosition ( TInt aPosition ) const [pure virtual]

Returns ETrue if the button with position aPosition is dimmed.

Parameters

TInt aPosition The position for command to be checked.

IsCommandVisible(TInt)

TBool IsCommandVisible ( TInt aCommandId ) const [pure virtual]

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

Parameters

TInt aCommandId Specifies the button.

IsCommandVisibleByPosition(TInt)

TBool IsCommandVisibleByPosition ( TInt aPosition ) const [pure virtual]

Returns ETrue if the button with position aPosition is visible.

Parameters

TInt aPosition The position for command to be checked.

MakeCommandVisible(TInt, TBool)

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

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

Parameters

TInt aCommandId Specifies the button to alter.
TBool aVisible ETrue to make the specified button visible. EFalse to make the specified button invisible.

MakeCommandVisibleByPosition(TInt, TBool)

void MakeCommandVisibleByPosition ( TInt aPosition,
TBool aVisible
) [pure virtual]

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

Parameters

TInt aPosition The position for command to be made visible.
TBool aVisible EFalse for making button invisible.

ReduceRect(TRect &)

void ReduceRect ( 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 & aBoundingRect Rectangle to be modified.

Release()

void Release ( )

Deletes the object.

RemoveCommandFromStack(TInt, TInt)

void RemoveCommandFromStack ( TInt aPosition,
TInt aCommandId
) [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 aPosition The position in the button group from which to remove the command button.
TInt aCommandId Command ID.

Reserved_1()

IMPORT_C void Reserved_1 ( ) [private]

SetBoundingRect(const TRect &)

void SetBoundingRect ( const TRect & aBoundingRect ) [pure virtual]

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

Parameters

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

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

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

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

Parameters

TInt aPosition The position within the button group of the button to change.
TInt aCommandId Command ID the button will send.
const TDesC * aText The text for the button.
const CFbsBitmap * aBitmap The bitmap for the button.
const CFbsBitmap * aMask The mask bitmap for aBitmap.

SetCommandL(TInt, TInt)

void SetCommandL ( TInt aPosition,
TInt aResourceId
) [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 aPosition The position within the button group of the button to change.
TInt aResourceId Resource ID specifying the text, bitmaps and command ID.

SetCommandSetL(TInt)

void SetCommandSetL ( TInt aResourceId ) [pure virtual]

Initialises the group of command buttons from a resource.

Parameters

TInt aResourceId ID of the resource structure specifying the command buttons.

SetDefaultCommand(TInt)

void SetDefaultCommand ( TInt aCommandId ) [pure virtual]

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

Parameters

TInt aCommandId Command to issue if no other is specified.

SetMSKCommandObserver(MEikCommandObserver *)

void SetMSKCommandObserver ( MEikCommandObserver * aCommandObserver ) [pure virtual]

Sets the middle softkey command observer.

Parameters

MEikCommandObserver * aCommandObserver The middle softkey command observer.

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.