CAknIndicatorContainer Class Reference

API published in: S60 1st Ed

Link against: avkon.lib

Capability Information

Required Capabilities

None

#include <aknindicatorcontainer.h>

Inherits CAknControl, and MEikStatusPaneObserver.

Detailed Description

A default control in the status pane's small indicator pane.


Public Types
enum	TLayoutOrientation { EVertical, EHorizontal }
enum	TIndicatorAlignment { ELeft, ERight }
enum	TIndicatorContext { EUniversalIndicators = 0, ENaviPaneEditorIndicators, EQueryEditorIndicators, EFindIndicators }
enum	TIndicatorPosition { ELeftSide, ERightSide, EMiddle }
enum	TCustomIndicatorFlags { EMultiColorIndicator = 0x1, EIndicatorPositionInverted = 0x2 }
enum	TLayoutMode { ELayoutModeUsual, ELayoutModeWide }
Public Member Functions
IMPORT_C	CAknIndicatorContainer ()
	Constructor.
IMPORT_C	CAknIndicatorContainer (TInt aIndicatorContext)
	Constructor.
IMPORT_C	~CAknIndicatorContainer ()
	Destructor.
IMPORT_C void	ConstructL ()
	2nd phase constructor.
IMPORT_C void	SetIndicatorState (TUid aIndicatorId, TInt aState, TBool aDrawNow=ETrue)
	Sets indicator state.
IMPORT_C TInt	IndicatorState (TUid aIndicatorId)
	Return a current state of the indicator.
IMPORT_C void	SetIndicatorValueL (TUid aIndicatorId, const TDesC &aString)
	Sets value to the message length indicator (EAknNaviPaneEditorIndicatorMessageLength).
IMPORT_C void	SetIncallBubbleFlags (const TInt &aFlags)
	Sets value to the incall status bubble indicator on the top of the status pane.
IMPORT_C void	ConstructFromResourceL (TResourceReader &aReader)
	Constructs the object from resource.
IMPORT_C TInt	IndicatorContext () const
	Return the context of the indicator.
IMPORT_C void	HandleStatusPaneSizeChange ()
	From MEikStatusPaneObserver.
IMPORT_C void	HandlePointerEventL (const TPointerEvent &aPointerEvent)
	From CCoeControl.
IMPORT_C void	SetIndicatorValue (TUid aIndicatorId, TInt aValue, TInt aMaxValue)
	Sets value to the progress bar indicator (EAknNaviPaneEditorIndicatorProgressBar).
void	DrawPictographArea ()
	Redraws those indicators that are visible and contain pictographs.
CAknPictographInterface *	PictographInterface () const
	Returns the pictograph interface owned by the indicator container, or NULL if pictographs are not supported.
IMPORT_C void	SetIncallBubbleAllowedInIdle (TBool aAllowed)
	Sets wheter incall bubble is shown also on the top of the idle status pane.
IMPORT_C void	SetIncallBubbleAllowedInUsual (TBool aAllowed)
	Sets wheter incall bubble is shown on the top of the usual status pane.
IMPORT_C void	SetIndicatorObserver (MAknIndicatorObserver *aIndicatorObserver, TUid aIndicatorUid)
	Sets observer for given indicator.
IMPORT_C TUid	CreateIndicatorFromResourceL (TInt aIndicatorResourceId, TInt aCustomIndicatorFlags)
	Creates a custom indicator.
IMPORT_C void	ReplaceIndicatorIconL (TUid aIndicator, TInt aState, TInt aLayoutMode, CFbsBitmap aIconBitmap, CFbsBitmap aIconMask, TInt aIconIndex=0)
	Replaces the icon of the given indicator.
Protected Member Functions
virtual IMPORT_C void	HandleResourceChange (TInt aType)
	Handles a change to the control's resources of type aType which are shared across the environment, e.g.
virtual IMPORT_C void	SizeChanged ()
	From CCoeControl.
virtual IMPORT_C void	PositionChanged ()
	From CCoeControl.
virtual IMPORT_C TInt	CountComponentControls () const
	From CCoeControl.
virtual IMPORT_C CCoeControl *	ComponentControl (TInt aIndex) const
	From CCoeControl.
Friends
class	CAknIndicatorDataObserver

Member Enumeration Documentation

enum CAknIndicatorContainer::TCustomIndicatorFlags

Enumerator:

EMultiColorIndicator
EIndicatorPositionInverted

enum CAknIndicatorContainer::TIndicatorAlignment

Enumerator:

ELeft
ERight

enum CAknIndicatorContainer::TIndicatorContext

Enumerator:

EUniversalIndicators
ENaviPaneEditorIndicators
EQueryEditorIndicators
EFindIndicators

enum CAknIndicatorContainer::TIndicatorPosition

Enumerator:

ELeftSide
ERightSide
EMiddle

enum CAknIndicatorContainer::TLayoutMode

Enumerator:

ELayoutModeUsual
ELayoutModeWide

enum CAknIndicatorContainer::TLayoutOrientation

Enumerator:

EVertical
EHorizontal

Constructor & Destructor Documentation

IMPORT_C CAknIndicatorContainer::CAknIndicatorContainer

(

)

Constructor.

Creates EUniversalIndicators object.

IMPORT_C CAknIndicatorContainer::CAknIndicatorContainer

Constructor.

Creates EUniversalIndicators, ENaviPaneEditorIndicators or EQueryEditorIndicators object.

Parameters:

aIndicatorContext

Indicator container context.

IMPORT_C CAknIndicatorContainer::~CAknIndicatorContainer

(

)

Destructor.

Member Function Documentation

virtual IMPORT_C CCoeControl* CAknIndicatorContainer::ComponentControl ( TInt aIndex ) const [protected, virtual]

From CCoeControl.

Returns a control determined by control id.

Parameters:

anIndex

Index of a control to be returned.

Returns:: Pointer to control

IMPORT_C void CAknIndicatorContainer::ConstructFromResourceL

Constructs the object from resource.

Parameters:

aReader

Resource reader.

IMPORT_C void CAknIndicatorContainer::ConstructL

(

)

2nd phase constructor.

virtual IMPORT_C TInt CAknIndicatorContainer::CountComponentControls ( ) const [protected, virtual]

From CCoeControl.

Returns number of controls inside the context pane control.

Returns:: Number of component controls.

IMPORT_C TUid CAknIndicatorContainer::CreateIndicatorFromResourceL	(	TInt	aIndicatorResourceId,
		TInt	aCustomIndicatorFlags
	)

Creates a custom indicator.

Indicators created with this method can be used in addition to default indicators.

Parameters:

	aIndicatorResourceId	Resource id of INDICATOR struct to be used in costructing indicator. Uid in the resource is ignored, a dynamic uid is given to indicator and returned to caller.
	aCustomIndicatorFlags	Flags that can be used to set additional indicator properties.

EMultiColorIndicator: Indicator is shown as multicolor (default is 2-color).

EIndicatorPositionInverted: Indicator is aligned to the opposite side than default (default is right side). Note that this flag does not quarantee exact location for the indicator, indicators are shown in priority order and location may vary and look different in different layouts.

Returns:: Uid of the new indicator.

void CAknIndicatorContainer::DrawPictographArea

(

)

Redraws those indicators that are visible and contain pictographs.

IMPORT_C void CAknIndicatorContainer::HandlePointerEventL

(

const TPointerEvent &

aPointerEvent

)

From CCoeControl.

Handles pointer events

virtual IMPORT_C void CAknIndicatorContainer::HandleResourceChange ( TInt aType ) [protected, virtual]

Handles a change to the control's resources of type aType which are shared across the environment, e.g.

color scheme change. Responds fade events and fades incall status bubble window group.

Parameters:

aType

Event type.

IMPORT_C void CAknIndicatorContainer::HandleStatusPaneSizeChange ( ) [virtual]

From MEikStatusPaneObserver.

The MEikStatusPaneObserver interface allows a status pane observer to pick up changes in the size or position of the status pane. Such events will be as a result of layout changes which cause an actual change in the status pane rectangle.

Implements MEikStatusPaneObserver.

IMPORT_C TInt CAknIndicatorContainer::IndicatorContext

(

)

const

Return the context of the indicator.

Returns:: context of the indicator.

IMPORT_C TInt CAknIndicatorContainer::IndicatorState

Return a current state of the indicator.

Parameters:

aIndicatorId

ID of the indicator.

Returns:: Current state of the indicator.

CAknPictographInterface* CAknIndicatorContainer::PictographInterface

(

)

const

Returns the pictograph interface owned by the indicator container, or NULL if pictographs are not supported.

virtual IMPORT_C void CAknIndicatorContainer::PositionChanged ( ) [protected, virtual]

From CCoeControl.

Handle the position change events.

IMPORT_C void CAknIndicatorContainer::ReplaceIndicatorIconL	(	TUid	aIndicator,
		TInt	aState,
		TInt	aLayoutMode,
		CFbsBitmap *	aIconBitmap,
		CFbsBitmap *	aIconMask,
		TInt	aIconIndex = `0`
	)

Replaces the icon of the given indicator.

Parameters:

	aIndicator	Uid of the indicator
	aState	State which icon is replaced (EAknIndicatorStateOn or EAknIndicatorStateAnimate)
	aLayoutMode	Layout mode of the icon to be replaced (ELayoutModeUsual or ELayoutModeWide)
	aIconBitmap	Bitmap of the new icon. Ownership is transferred to CAknIndicatorContainer.
	aIconMask	Mask of the new icon. Ownership is transferred to CAknIndicatorContainer.
	aIconIndex	If parameter aState is EAknIndicatorStateAnimate, then this parameter must contain the index of the icon to be replaced in the animation sequence. Old icon must exist for given index so that the number of animation frames does not change.

IMPORT_C void CAknIndicatorContainer::SetIncallBubbleAllowedInIdle

Sets wheter incall bubble is shown also on the top of the idle status pane.

Normally it is shown only in usual statuspane layouts, but with this method it can be set to shown also in idle.

NOTE: This method works only if indicatorcontainer is used as container for universalindicators.

Parameters:

aAllowed

If true incall bubble is shown also in idle statuspane. Otherwise bubble is shown only in usual statuspane layouts.

IMPORT_C void CAknIndicatorContainer::SetIncallBubbleAllowedInUsual

Sets wheter incall bubble is shown on the top of the usual status pane.

Normally it is shown in usual statuspane layouts, but with this method it can prevent it to be shown.

NOTE: This method works only if indicatorcontainer is used as container for universalindicators.

Parameters:

aAllowed

If true incall bubble is shown in usual statuspane.

IMPORT_C void CAknIndicatorContainer::SetIncallBubbleFlags

Sets value to the incall status bubble indicator on the top of the status pane.

Parameters:

aFlags

Mode of the bubble.

IMPORT_C void CAknIndicatorContainer::SetIndicatorObserver	(	MAknIndicatorObserver *	aIndicatorObserver,
		TUid	aIndicatorUid
	)

Sets observer for given indicator.

Parameters:

	aIndicatorObserver	observer of indicator
	aIndicatorUid	uid of indicator to be observed

IMPORT_C void CAknIndicatorContainer::SetIndicatorState	(	TUid	aIndicatorId,
		TInt	aState,
		TBool	aDrawNow = `ETrue`
	)

Sets indicator state.

The state can be one of the following: EAknIndicatorStateOff, EAknIndicatorStateOn or EAknIndicatorStateAnimate. Editor indicators do not support animation.

Parameters:

	aIndicatorId	ID of the indicator to be modified.
	aState	A state to be set to the indicator.
	aDrawNow	A flag to indicate if the indicator is redrawn with this call.

IMPORT_C void CAknIndicatorContainer::SetIndicatorValue	(	TUid	aIndicatorId,
		TInt	aValue,
		TInt	aMaxValue
	)

Sets value to the progress bar indicator (EAknNaviPaneEditorIndicatorProgressBar).

Panics if this is not progress bar indicator.

Parameters:

	aIndicatorId	ID of the indicator to be modified.
	aValue	current progress of the task that bar describes.
	aMaxValue	progress value when task is finished.

IMPORT_C void CAknIndicatorContainer::SetIndicatorValueL	(	TUid	aIndicatorId,
		const TDesC &	aString
	)

Sets value to the message length indicator (EAknNaviPaneEditorIndicatorMessageLength).

Parameters:

	aIndicatorId	ID of the indicator to be modified.
	aString	Value of the indicator.

virtual IMPORT_C void CAknIndicatorContainer::SizeChanged ( ) [protected, virtual]

From CCoeControl.

Handle the size change events.

Friends And Related Function Documentation

friend class CAknIndicatorDataObserver [friend]

The documentation for this class was generated from the following file:

aknindicatorcontainer.h

CAknIndicatorContainer Class Reference

Capability Information

Detailed Description

Public Types

Public Member Functions

Protected Member Functions

Friends

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation