MEikButtonGroup Class Reference

API published in: S60 1st Ed

Link against: eikcoctl.lib avkon.lib

Capability Information

Required Capabilities

None

#include <eikbtgrp.h>

Inherited by CEikButtonPanel, CEikToolBar, and MEikEnhancedButtonGroup.

Detailed Description

Abstract base class for EIKON button group.


Public Member Functions
void	Release ()
	Deletes the object.
virtual void	SetCommandL (TInt aPosition, TInt aCommandId, const TDesC aText, const CFbsBitmap aBitmap, const CFbsBitmap *aMask)=0
	Sets a command button's bitmap, text and command ID.
virtual void	SetCommandL (TInt aPosition, TInt aResourceId)=0
	Sets a command button's bitmap, text label and command ID.
virtual void	SetCommandSetL (TInt aResourceId)=0
	Initialises the group of command buttons from a resource.
virtual void	AddCommandL (TInt aPosition, TInt aCommandId, const TDesC aText, const CFbsBitmap aBitmap, const CFbsBitmap *aMask)=0
	Adds a command button with a command ID and a label containing both a bitmap and text.
virtual void	AddCommandToStackL (TInt aPosition, TInt aCommandId, const TDesC aText, const CFbsBitmap aBitmap, const CFbsBitmap *aMask)=0
	Pushes a command button with text, bitmap, mask and a command ID onto a position's button stack.
virtual void	AddCommandToStackL (TInt aPosition, TInt aResourceId)=0
	Pushes a command button onto a position's button stack.
virtual void	AddCommandSetToStackL (TInt aResourceId)=0
	As with SetCommandL() but for a set of buttons, also allows the previous command button to be retrieved by calling RemoveCommand().
virtual void	SetDefaultCommand (TInt aCommandId)=0
	Sets the default command ID for buttons in this button group.
virtual TSize	CalcMinimumSizeL (TInt aResourceId)=0
	Calculates minimum size required to display the buttons defined in the specified resource structure.
virtual void	RemoveCommandFromStack (TInt aPosition, TInt aCommandId)=0
	Removes the command identified by aCommandId, in position aPosition in the group, from the command stack.
virtual TInt	CommandPos (TInt aCommandId) const =0
	Returns the command position by command id.
virtual void	DimCommand (TInt aCommandId, TBool aDimmed)=0
	Dims or undims a button without drawing it.
virtual TBool	IsCommandDimmed (TInt aCommandId) const =0
	Determines whether the button with the specified command ID is dimmed.
virtual void	MakeCommandVisible (TInt aCommandId, TBool aVisible)=0
	Makes the button with the specified id either visible, or invisible.
virtual TBool	IsCommandVisible (TInt aCommandId) const =0
	Tests whether the button with the specified command ID is visible.
virtual IMPORT_C void	AnimateCommand (TInt aCommandId)
	Animates the button with the specified id.
virtual CCoeControl *	AsControl ()=0
	Returns the button group as a control.
virtual const CCoeControl *	AsControl () const =0
	Returns the button group as a control.
virtual void	SetBoundingRect (const TRect &aBoundingRect)=0
	Sets the boundary rectangle for externally-positioned button groups.
virtual void	ReduceRect (TRect &aBoundingRect) const =0
	Subtracts the area occupied by the button group from the specified bounding rectangle.
virtual CCoeControl *	GroupControlById (TInt aCommandId) const =0
	Returns a group control (a button) as a control.
virtual CEikCommandButton *	GroupControlAsButton (TInt aCommandId) const =0
	Returns a group control (a button) as a command button.
virtual TInt	CommandId (TInt aCommandPos) const =0
	Returns the command id by position.
virtual TInt	ButtonCount () const =0
	Gets the total number of buttons currently present in the group.
virtual TUint	ButtonGroupFlags () const =0
	Gets the button group flags.
virtual void	SetMSKCommandObserver (MEikCommandObserver *aCommandObserver)=0
	Sets the middle softkey command observer.
virtual void	DimCommandByPosition (TInt aPosition, TBool aDimmed)=0
	Dims (but doesn't draw) the button with position aPosition.
virtual TBool	IsCommandDimmedByPosition (TInt aPosition) const =0
	Returns ETrue if the button with position aPosition is dimmed.
virtual void	MakeCommandVisibleByPosition (TInt aPosition, TBool aVisible)=0
	Sets the the button with position aPosition to be visible if aVisible is ETrue.
virtual TBool	IsCommandVisibleByPosition (TInt aPosition) const =0
	Returns ETrue if the button with position aPosition is visible.
virtual void	AnimateCommandByPosition (TInt aPosition)=0
	Animates the button with position aPosition.

Member Function Documentation

virtual void MEikButtonGroup::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:

	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.

Implemented in CEikCba.

virtual void MEikButtonGroup::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:

aResourceId

Resource describing the set of command buttons.

Implemented in CEikCba.

virtual void MEikButtonGroup::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:

	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.

Implemented in CEikCba.

virtual void MEikButtonGroup::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:

	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.

Implemented in CEikCba.

virtual IMPORT_C void MEikButtonGroup::AnimateCommand ( TInt aCommandId ) [virtual]

Animates the button with the specified id.

Parameters:

aCommandId

The button to animate.

Reimplemented in CEikCba.

virtual void MEikButtonGroup::AnimateCommandByPosition ( TInt aPosition ) [pure virtual]

Animates the button with position aPosition.

Parameters:

aPosition

The position for command to be animated.

Implemented in CEikCba.

virtual const CCoeControl* MEikButtonGroup::AsControl ( ) const [pure virtual]

Returns the button group as a control.

Returns:: The button group as a control.

Implemented in CEikCba.

virtual CCoeControl* MEikButtonGroup::AsControl ( ) [pure virtual]

Returns the button group as a control.

Returns:: The button group as a control.

Implemented in CEikCba.

virtual TInt MEikButtonGroup::ButtonCount ( ) const [pure virtual]

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

Returns:: The number of buttons.

Implemented in CEikCba.

virtual TUint MEikButtonGroup::ButtonGroupFlags ( ) const [pure virtual]

Gets the button group flags.

Returns:: The button group flags.

Implemented in CEikCba.

virtual TSize MEikButtonGroup::CalcMinimumSizeL ( TInt aResourceId ) [pure virtual]

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

Parameters:

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.

Implemented in CEikCba.

virtual TInt MEikButtonGroup::CommandId ( TInt aCommandPos ) const [pure virtual]

Returns the command id by position.

Parameters:

aCommandPos

The command's position.

Returns:: The command id.

Implemented in CEikCba.

virtual TInt MEikButtonGroup::CommandPos ( TInt aCommandId ) const [pure virtual]

Returns the command position by command id.

Parameters:

aCommandId

The button's command id.

Returns:: The command position in the button group.

Implemented in CEikCba.

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

Dims or undims a button without drawing it.

Parameters:

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

Implemented in CEikCba.

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

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

Parameters:

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

Implemented in CEikCba.

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

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

Parameters:

aCommandId

The button's command id.

Returns:: The group control as a command button.

Implemented in CEikCba.

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

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

Parameters:

aCommandId

The button's command id.

Returns:: The group control as a control.

Implemented in CEikCba.

virtual TBool MEikButtonGroup::IsCommandDimmed ( TInt aCommandId ) const [pure virtual]

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

Parameters:

aCommandId

The command ID.

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

Implemented in CEikCba.

virtual TBool MEikButtonGroup::IsCommandDimmedByPosition ( TInt aPosition ) const [pure virtual]

Returns ETrue if the button with position aPosition is dimmed.

Parameters:

aPosition

The position for command to be checked.

Returns:: The state of the button.

Implemented in CEikCba.

virtual TBool MEikButtonGroup::IsCommandVisible ( TInt aCommandId ) const [pure virtual]

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

Parameters:

aCommandId

Specifies the button.

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

Implemented in CEikCba.

virtual TBool MEikButtonGroup::IsCommandVisibleByPosition ( TInt aPosition ) const [pure virtual]

Returns ETrue if the button with position aPosition is visible.

Parameters:

aPosition

The position for command to be checked.

Returns:: The state of the button.

Implemented in CEikCba.

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

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

Parameters:

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

Implemented in CEikCba.

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

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

Parameters:

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

Implemented in CEikCba.

virtual void MEikButtonGroup::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:

aBoundingRect

Rectangle to be modified.

Implemented in CEikCba, and CEikToolBar.

void MEikButtonGroup::Release

(

)

Deletes the object.

virtual void MEikButtonGroup::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:

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

Implemented in CEikCba.

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

Sets the boundary rectangle for externally-positioned button groups.

For use by EExternal button groups only.

Parameters:

aBoundingRect

The boundary rectangle to use. The button group attaches itself to the inside of this rectangle.

Implemented in CEikCba, and CEikToolBar.

virtual void MEikButtonGroup::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:

	aPosition	The position within the button group of the button to change.
	aResourceId	Resource ID specifying the text, bitmaps and command ID.

Implemented in CEikCba.

virtual void MEikButtonGroup::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:

	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.