MEikButtonGroup Class Reference

#include <mw/eikbtgrp.h>

Link against: eikcoctl.lib

class MEikButtonGroup

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

Detailed Description

Abstract base class for EIKON button group.

Since: S60 0.9

Member Function 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.

Parameter	Description
aPosition	The position in the button group for the new button.
aCommandId	Command ID for the new button.
aText	Text for the button.
aBitmap	Bitmap for the button.
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().

Parameter	Description
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.

Parameter	Description
aPosition	The position in the button group at which to add the command button.
aCommandId	Command ID the button will send.
aText	Text for the button.
aBitmap	Bitmap for the button.
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.

Parameter	Description
aPosition	The position in the button group at which to push the command button.
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.

Parameter	Description
aCommandId	The button to animate.

AnimateCommandByPosition ( TInt )

void

AnimateCommandByPosition

(

TInt

aPosition

)

[pure virtual]

Animates the button with position aPosition.

Parameter	Description
aPosition	The position for command to be animated.

AsControl ( )

CCoeControl *

AsControl

(

)

[pure virtual]

Returns the button group as a control.

Returns: The button group as a control.

AsControl ( )

const CCoeControl *

AsControl

(

)

const [pure virtual]

Returns the button group as a control.

Returns: The button group as a control.

ButtonCount ( )

TInt

ButtonCount

(

)

const [pure virtual]

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

Returns: The number of buttons.

ButtonGroupFlags ( )

TUint

ButtonGroupFlags

(

)

const [pure virtual]

Gets the button group flags.

Returns: 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.

Parameter	Description
aResourceId	The ID of the resource structure describing the button group.

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

CommandId ( TInt )

TInt

CommandId

(

TInt

aCommandPos

)

const [pure virtual]

Returns the command id by position.

Parameter	Description
aCommandPos	The command's position.

Returns: The command id.

CommandPos ( TInt )

TInt

CommandPos

(

TInt

aCommandId

)

const [pure virtual]

Returns the command position by command id.

Parameter	Description
aCommandId	The button's command id.

Returns: The command position in the button group.

DimCommand ( TInt, TBool )

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

Dims or undims a button without drawing it.

Parameter	Description
aCommandId	Command ID of the button to change.
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.

Parameter	Description
aPosition	The position for command to be dimmed.
aDimmed	ETrue for dimming.

GroupControlAsButton ( TInt )

CEikCommandButton *

GroupControlAsButton

(

TInt

aCommandId

)

const [pure virtual]

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

Parameter	Description
aCommandId	The button's command id.

Returns: The group control as a command button.

GroupControlById ( TInt )

CCoeControl *

GroupControlById

(

TInt

aCommandId

)

const [pure virtual]

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

Parameter	Description
aCommandId	The button's command id.

Returns: The group control as a control.

IsCommandDimmed ( TInt )

TBool

IsCommandDimmed

(

TInt

aCommandId

)

const [pure virtual]

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

Parameter	Description
aCommandId	The command ID.

Returns: ETrue if the specified command is dimmed. EFalse if the specified command is not dimmed.

IsCommandDimmedByPosition ( TInt )

TBool

IsCommandDimmedByPosition

(

TInt

aPosition

)

const [pure virtual]

Returns ETrue if the button with position aPosition is dimmed.

Parameter	Description
aPosition	The position for command to be checked.

Returns: The state of the button.

IsCommandVisible ( TInt )

TBool

IsCommandVisible

(

TInt

aCommandId

)

const [pure virtual]

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

Parameter	Description
aCommandId	Specifies the button.

Returns: ETrue if the specified button is visible. EFalse if the specified button is not visible.

IsCommandVisibleByPosition ( TInt )

TBool

IsCommandVisibleByPosition

(

TInt

aPosition

)

const [pure virtual]

Returns ETrue if the button with position aPosition is visible.

Parameter	Description
aPosition	The position for command to be checked.

Returns: The state of the button.

MakeCommandVisible ( TInt, TBool )

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

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

Parameter	Description
aCommandId	Specifies the button to alter.
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.

Parameter	Description
aPosition	The position for command to be made visible.
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.

Parameter	Description
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.

Parameter	Description
aPosition	The position in the button group from which to remove the command button.
aCommandId	Command ID.

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.

Parameter	Description
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.

Parameter	Description
aPosition	The position within the button group of the button to change.
aCommandId	Command ID the button will send.
aText	The text for the button.
aBitmap	The bitmap for the button.
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.

Parameter	Description
aPosition	The position within the button group of the button to change.
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.

Parameter	Description
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.

Parameter	Description
aCommandId	Command to issue if no other is specified.

SetMSKCommandObserver ( MEikCommandObserver * )

void

SetMSKCommandObserver

(

MEikCommandObserver *

aCommandObserver

)

[pure virtual]

Sets the middle softkey command observer.

Parameter	Description
aCommandObserver	The middle softkey command observer.

MEikButtonGroup Class Reference

Detailed Description

Member Function Documentation

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

AddCommandSetToStackL ( TInt )

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

AddCommandToStackL ( TInt, TInt )

AnimateCommand ( TInt )

AnimateCommandByPosition ( TInt )

AsControl ( )

AsControl ( )

ButtonCount ( )

ButtonGroupFlags ( )

CalcMinimumSizeL ( TInt )

CommandId ( TInt )

CommandPos ( TInt )

DimCommand ( TInt, TBool )

DimCommandByPosition ( TInt, TBool )

GroupControlAsButton ( TInt )

GroupControlById ( TInt )

IsCommandDimmed ( TInt )

IsCommandDimmedByPosition ( TInt )

IsCommandVisible ( TInt )

IsCommandVisibleByPosition ( TInt )

MakeCommandVisible ( TInt, TBool )

MakeCommandVisibleByPosition ( TInt, TBool )

ReduceRect ( TRect & )

Release ( )

RemoveCommandFromStack ( TInt, TInt )

SetBoundingRect ( const TRect & )

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

SetCommandL ( TInt, TInt )

SetCommandSetL ( TInt )

SetDefaultCommand ( TInt )

SetMSKCommandObserver ( MEikCommandObserver * )

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

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

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