CAknIndicatorContainer Class Reference

#include <mw/AknIndicatorContainer.h>

Link against: AspSyncUtil.lib

class CAknIndicatorContainer : public CAknControl

Inherits from

CAknIndicatorContainer
- CAknControl

Public Member Enumerations
enum	TCustomIndicatorFlags { EMultiColorIndicator, EIndicatorPositionInverted }
enum	TIndicatorAlignment { ELeft, ERight }
enum	TIndicatorContext { EUniversalIndicators, ENaviPaneEditorIndicators, EQueryEditorIndicators, EFindIndicators }
enum	TIndicatorPosition { ELeftSide, ERightSide, EMiddle }
enum	TLayoutMode { ELayoutModeUsual, ELayoutModeWide }
enum	TLayoutOrientation { EVertical, EHorizontal }

Public Member Functions
	CAknIndicatorContainer()
	CAknIndicatorContainer(TInt)
	~CAknIndicatorContainer()
virtual IMPORT_C void	ConstructFromResourceL(TResourceReader &)
IMPORT_C void	ConstructL()
IMPORT_C TUid	CreateIndicatorFromResourceL(TInt, TInt)
void	DrawPictographArea()
virtual IMPORT_C void	HandlePointerEventL(const TPointerEvent &)
IMPORT_C void	HandleStatusPaneSizeChange()
IMPORT_C TInt	IndicatorContext()
IMPORT_C TInt	IndicatorState(TUid)
CAknPictographInterface *	PictographInterface()
IMPORT_C void	ReplaceIndicatorIconL(TUid, TInt, TInt, CFbsBitmap , CFbsBitmap , TInt)
IMPORT_C void	SetIncallBubbleAllowedInIdle(TBool)
IMPORT_C void	SetIncallBubbleAllowedInUsual(TBool)
IMPORT_C void	SetIncallBubbleFlags(const TInt &)
IMPORT_C void	SetIndicatorObserver(MAknIndicatorObserver *, TUid)
IMPORT_C void	SetIndicatorState(TUid, TInt, TBool)
IMPORT_C void	SetIndicatorValue(TUid, TInt, TInt)
IMPORT_C void	SetIndicatorValueL(TUid, const TDesC &)

Protected Member Functions
virtual IMPORT_C CCoeControl *	ComponentControl(TInt)
virtual IMPORT_C TInt	CountComponentControls()
virtual IMPORT_C void	HandleResourceChange(TInt)
virtual IMPORT_C void	PositionChanged()
virtual IMPORT_C void	SizeChanged()

Inherited Attributes
	CCoeControl::iCoeEnv
	CCoeControl::iContext
	CCoeControl::iPosition
	CCoeControl::iSize

Inherited Enumerations
	CCoeControl:TZoomType

Inherited Functions
	CAknControl::CAknControl()
	CAknControl::~CAknControl()
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()
	CCoeControl::AccumulatedZoom()const
	CCoeControl::ActivateGc()const
	CCoeControl::ActivateL()
	CCoeControl::BackedUpWindow()const
	CCoeControl::Background()const
	CCoeControl::CCoeControl()
	CCoeControl::CCoeControl(CCoeEnv *)
	CCoeControl::CCoeControl(const CCoeControl &)
	CCoeControl::CCoeControlArray
	CCoeControl::CapturesPointer()const
	CCoeControl::ClaimPointerGrab(TBool)
	CCoeControl::ClaimPointerGrab(TInt,TBool)
	CCoeControl::CloseWindow()
	CCoeControl::ComponentArrayExists()const
	CCoeControl::Components()
	CCoeControl::Components()const
	CCoeControl::ControlContext()const
	CCoeControl::ControlEnv()const
	CCoeControl::CopyControlContextFrom(const CCoeControl *)
	CCoeControl::CreateBackedUpWindowL(RWindowTreeNode &)
	CCoeControl::CreateBackedUpWindowL(RWindowTreeNode &,TDisplayMode)
	CCoeControl::CreateWindowL()
	CCoeControl::CreateWindowL(RWindowGroup *)
	CCoeControl::CreateWindowL(RWindowTreeNode &)
	CCoeControl::CreateWindowL(const CCoeControl *)
	CCoeControl::CustomGc()const
	CCoeControl::DeactivateGc()const
	CCoeControl::DrawBackground(const TRect &)const
	CCoeControl::DrawDeferred()const
	CCoeControl::DrawForeground(const TRect &)const
	CCoeControl::DrawNow()const
	CCoeControl::DrawNow(const TRect &)const
	CCoeControl::DrawableWindow()const
	CCoeControl::EnableDragEvents()
	CCoeControl::EnableReportControlStateChange(TBool)
	CCoeControl::EnableWindowTransparency()
	CCoeControl::FindBackground()const
	CCoeControl::FindFontProvider()const
	CCoeControl::FocusChanged(TDrawNow)
	CCoeControl::GetColor(TInt,TRgb &)const
	CCoeControl::GetColorUseListL(CArrayFix< TCoeColorUse > &)const
	CCoeControl::GetGc()const
	CCoeControl::GetHelpContext(TCoeHelpContext &)const
	CCoeControl::GrabbingComponent()const
	CCoeControl::GrabbingComponent(TInt)const
	CCoeControl::HandleComponentControlsResourceChange(TInt)
	CCoeControl::HandleControlArrayEventL(CCoeControlArray::TEvent,const CCoeControlArray ,CCoeControl ,TInt)
	CCoeControl::HandlePointerBufferReadyL()
	CCoeControl::HandleRedrawEvent(const TRect &)const
	CCoeControl::HasBorder()const
	CCoeControl::HitTest()const
	CCoeControl::IgnoreEventsUntilNextPointerUp()
	CCoeControl::Index(const CCoeControl *)const
	CCoeControl::InitComponentArrayL()
	CCoeControl::InputCapabilities()const
	CCoeControl::IsActivated()const
	CCoeControl::IsBackedUp()const
	CCoeControl::IsBeingDestroyed()const
	CCoeControl::IsBlank()const
	CCoeControl::IsDimmed()const
	CCoeControl::IsFocused()const
	CCoeControl::IsNonFocusing()const
	CCoeControl::IsReadyToDraw()const
	CCoeControl::IsVisible()const
	CCoeControl::LayoutManager()const
	CCoeControl::MakeVisible(TBool)
	CCoeControl::MaximumWidth()const
	CCoeControl::MinimumSize()
	CCoeControl::MopSupplyObject(TTypeUid)
	CCoeControl::NotifyFontChange(const CCoeFontProvider *)
	CCoeControl::Observer()const
	CCoeControl::OfferKeyEventL(const TKeyEvent &,TEventCode)
	CCoeControl::OverrideColorL(TInt,TRgb)
	CCoeControl::OwnsWindow()const
	CCoeControl::Parent()
	CCoeControl::Parent()const
	CCoeControl::Position()const
	CCoeControl::PositionRelativeToScreen()const
	CCoeControl::PrepareForFocusGainL()
	CCoeControl::PrepareForFocusLossL()
	CCoeControl::ProcessPointerBufferReadyL()
	CCoeControl::ProcessPointerEventL(const TPointerEvent &)
	CCoeControl::Rect()const
	CCoeControl::RecursivelyMergeInputCapabilities(TCoeInputCapabilities &)const
	CCoeControl::RecursivelyMergedInputCapabilities()const
	CCoeControl::RefetchPixelMappingL()
	CCoeControl::RemoveFromParent()
	CCoeControl::ReportEventL(MCoeControlObserver::TCoeEvent)
	CCoeControl::RequestRelayout(const CCoeControl *)
	CCoeControl::ResetGc()const
	CCoeControl::ScreenFont(const TCoeFont &)const
	CCoeControl::SetAdjacent(TInt)
	CCoeControl::SetAllowStrayPointers()
	CCoeControl::SetBackground(const MCoeControlBackground *)
	CCoeControl::SetBlank()
	CCoeControl::SetCanDrawOutsideRect()
	CCoeControl::SetComponentsToInheritVisibility(TBool)
	CCoeControl::SetContainerWindowL(RBackedUpWindow &)
	CCoeControl::SetContainerWindowL(RWindow &)
	CCoeControl::SetContainerWindowL(const CCoeControl &)
	CCoeControl::SetControlContext(MCoeControlContext *)
	CCoeControl::SetCornerAndSize(TGulAlignment,const TSize &)
	CCoeControl::SetCustomGc(CWindowGc *)
	CCoeControl::SetDimmed(TBool)
	CCoeControl::SetExtent(const TPoint &,const TSize &)
	CCoeControl::SetExtentToWholeScreen()
	CCoeControl::SetFocus(TBool,TDrawNow)
	CCoeControl::SetFocusing(TBool)
	CCoeControl::SetFontProviderL(const CCoeFontProvider &)
	CCoeControl::SetGc(CWindowGc *)const
	CCoeControl::SetGloballyCapturing(TBool)
	CCoeControl::SetHitTest(const MCoeControlHitTest *)
	CCoeControl::SetLayoutManagerL(MCoeLayoutManager *)
	CCoeControl::SetMaximumWidth(TInt)
	CCoeControl::SetMopParent(MObjectProvider *)
	CCoeControl::SetNeighbor(CCoeControl *)
	CCoeControl::SetNonFocusing()
	CCoeControl::SetObserver(MCoeControlObserver *)
	CCoeControl::SetParent(CCoeControl *)
	CCoeControl::SetPointerCapture(TBool)
	CCoeControl::SetPosition(const TPoint &)
	CCoeControl::SetRect(const TRect &)
	CCoeControl::SetSize(const TSize &)
	CCoeControl::SetSizeWithoutNotification(const TSize &)
	CCoeControl::SetTextBaselineSpacing(TInt)
	CCoeControl::SetUniqueHandle(TInt)
	CCoeControl::SetZoomFactorL(TInt,TZoomType)
	CCoeControl::Size()const
	CCoeControl::SystemGc()const
	CCoeControl::TextBaselineOffset(const TSize &)const
	CCoeControl::TextDrawer(TInt)const
	CCoeControl::UniqueHandle()const
	CCoeControl::Window()const
	CCoeControl::WriteInternalStateL(RWriteStream &)const
	CCoeControl::WriteInternalStateNowL(RWriteStream &)const
	CCoeControl::ZoomWithType()const
	CCoeControl::operator=(const CCoeControl &)
	CCoeControl::~CCoeControl()

Detailed Description

The default control in the status pane's small indicator pane. This container is also used for the status indicators in navi pane and for editor indicators in queries.

Member Enumeration Documentation

Enum TCustomIndicatorFlags

Additional flags that can be used for custom indicators.

Enumerator	Value	Description
EMultiColorIndicator	0x1	Indicator is multi-colored.
EIndicatorPositionInverted	0x2	Indicator's position is inverted.

Enum TIndicatorAlignment

Alignment of the indicators.

Enumerator	Value	Description
ELeft		Indicators are aligned on the left side.
ERight		Indicators are aligned on the right side.

Enum TIndicatorContext

Context of the indicator container. These are used to specify what type of status indicators the indicator container contains.

Enumerator	Value	Description
EUniversalIndicators	0	Universal status indicators.
ENaviPaneEditorIndicators		Editor indicators shown in navi pane.
EQueryEditorIndicators		Editor indicators shown in queries.
EFindIndicators		Search field indicators.

Enum TIndicatorPosition

Position of a indicator. These are used for invidual indicators to coarsely specify where they are positioned inside the indicator container.

Enumerator	Value	Description
ELeftSide		Indicator positioned on the left side.
ERightSide		Indicator positioned on the right side.
EMiddle		Indicator positioned in the middle.

Enum TLayoutMode

Layout modes of indicator container.

Enumerator	Value	Description
ELayoutModeUsual		Used for universal indicators when not in idle.
ELayoutModeWide		Used for navi pane indicators and universal indicators in idle.

Enum TLayoutOrientation

Layout orientations of the indicator container. These are used to specify how the indicators are laid out inside the indicator container.

Enumerator	Value	Description
EVertical		Indicators are arranged vertically.
EHorizontal		Indicators are arranged horizontally.

Constructor & Destructor Documentation

CAknIndicatorContainer ( )

IMPORT_C

CAknIndicatorContainer

(

)

Default constructor. Creates an EUniversalIndicators object.

CAknIndicatorContainer ( TInt )

IMPORT_C

CAknIndicatorContainer

(

TInt

aIndicatorContext

)

Constructor. Creates EUniversalIndicators, ENaviPaneEditorIndicators or EQueryEditorIndicators object.

Parameter	Description
aIndicatorContext	Indicator container context.

~CAknIndicatorContainer ( )

IMPORT_C

~CAknIndicatorContainer

(

)

Destructor.

Member Function Documentation

ComponentControl ( TInt )

IMPORT_C CCoeControl *

ComponentControl

(

TInt

aIndex

)

const [protected, virtual]

Reimplemented from CCoeControl::ComponentControl(TInt)const

Returns a control determined by control index.

Parameter	Description
aIndex	Index of a control to be returned.

Returns: Pointer to control

ConstructFromResourceL ( TResourceReader & )

IMPORT_C void

ConstructFromResourceL

(

TResourceReader &

aReader

)

[virtual]

Reimplemented from CCoeControl::ConstructFromResourceL(TResourceReader &)

Constructs the object from resource.

Parameter	Description
aReader	Resource reader.

ConstructL ( )

IMPORT_C void

ConstructL

(

)

Second-phase constructor.

CountComponentControls ( )

IMPORT_C TInt

CountComponentControls

(

)

const [protected, virtual]

Reimplemented from CCoeControl::CountComponentControls()const

Returns number of controls inside the context pane control.

Returns: Amount of component controls.

CreateIndicatorFromResourceL ( TInt, TInt )

IMPORT_C TUid	CreateIndicatorFromResourceL	(	TInt	aIndicatorResourceId,
			TInt	aCustomIndicatorFlags
		)

Creates a custom indicator. Indicators created with this method can be used in addition to default indicators.

Since: 3.1

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

Parameter

Description

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.

DrawPictographArea ( )

void

DrawPictographArea

(

)

Redraws those indicators that are visible and contain pictographs.

HandlePointerEventL ( const TPointerEvent & )

IMPORT_C void

HandlePointerEventL

(

const TPointerEvent &

aPointerEvent

)

[virtual]

Reimplemented from CCoeControl::HandlePointerEventL(const TPointerEvent &)

Handles pointer events.

Parameter	Description
aPointerEvent	The pointer event.

HandleResourceChange ( TInt )

IMPORT_C void

HandleResourceChange

(

TInt

aType

)

[protected, virtual]

Reimplemented from CCoeControl::HandleResourceChange(TInt)

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.

Parameter	Description
aType	Event type.

HandleStatusPaneSizeChange ( )

IMPORT_C void

HandleStatusPaneSizeChange

(

)

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.

IndicatorContext ( )

IMPORT_C TInt

IndicatorContext

(

)

const

Returns the context of the indicator container.

Returns: Context of the indicator container.

IndicatorState ( TUid )

IMPORT_C TInt

IndicatorState

(

TUid

aIndicatorId

)

Return the current state of an indicator.

Parameter	Description
aIndicatorId	ID of the indicator.

Returns: Current state of the indicator.

PictographInterface ( )

CAknPictographInterface *

PictographInterface

(

)

const

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

PositionChanged ( )

IMPORT_C void

PositionChanged

(

)

[protected, virtual]

Reimplemented from CCoeControl::PositionChanged()

Handles position change events.

ReplaceIndicatorIconL ( TUid, TInt, TInt, CFbsBitmap , CFbsBitmap , TInt )

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

Replaces the icon of the given indicator.

Since: 3.1

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

SetIncallBubbleAllowedInIdle ( TBool )

IMPORT_C void

SetIncallBubbleAllowedInIdle

(

TBool

aAllowed

)

Sets whether 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 universal indicators.

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

SetIncallBubbleAllowedInUsual ( TBool )

IMPORT_C void

SetIncallBubbleAllowedInUsual

(

TBool

aAllowed

)

Sets whether 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 universal indicators.

Parameter	Description
aAllowed	If true incall bubble is shown in usual statuspane.

SetIncallBubbleFlags ( const TInt & )

IMPORT_C void

SetIncallBubbleFlags

(

const TInt &

aFlags

)

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

Parameter	Description
aFlags	Mode of the bubble.

SetIndicatorObserver ( MAknIndicatorObserver *, TUid )

IMPORT_C void	SetIndicatorObserver	(	MAknIndicatorObserver *	aIndicatorObserver,
			TUid	aIndicatorUid
		)

Sets observer for given indicator.

Parameter	Description
aIndicatorObserver	Observer of the indicator.
aIndicatorUid	UID of indicator to be observed.

SetIndicatorState ( TUid, TInt, TBool )

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

Sets indicator state. The state can be one of the following:

EAknIndicatorStateOff

EAknIndicatorStateOn

EAknIndicatorStateAnimate

Editor indicators do not support animation.

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

SetIndicatorValue ( TUid, TInt, TInt )

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

Sets value to the progress bar indicator (EAknNaviPaneEditorIndicatorProgressBar). Panics if the specified indicator is not a progress bar indicator.

Since: 2.1

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

SetIndicatorValueL ( TUid, const TDesC & )

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

Sets value to the message length indicator (EAknNaviPaneEditorIndicatorMessageLength).

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

SizeChanged ( )

IMPORT_C void

SizeChanged

(

)

[protected, virtual]

Reimplemented from CCoeControl::SizeChanged()

Handles size change events.

CAknIndicatorContainer Class Reference

Inherits from

Detailed Description

Member Enumeration Documentation

Enum TCustomIndicatorFlags

Enum TIndicatorAlignment

Enum TIndicatorContext

Enum TIndicatorPosition

Enum TLayoutMode

Enum TLayoutOrientation

Constructor & Destructor Documentation

CAknIndicatorContainer ( )

CAknIndicatorContainer ( TInt )

~CAknIndicatorContainer ( )

Member Function Documentation

ComponentControl ( TInt )

ConstructFromResourceL ( TResourceReader & )

ConstructL ( )

CountComponentControls ( )

CreateIndicatorFromResourceL ( TInt, TInt )

DrawPictographArea ( )

HandlePointerEventL ( const TPointerEvent & )

HandleResourceChange ( TInt )

HandleStatusPaneSizeChange ( )

IndicatorContext ( )

IndicatorState ( TUid )

PictographInterface ( )

PositionChanged ( )

ReplaceIndicatorIconL ( TUid, TInt, TInt, CFbsBitmap *, CFbsBitmap *, TInt )

SetIncallBubbleAllowedInIdle ( TBool )

SetIncallBubbleAllowedInUsual ( TBool )

SetIncallBubbleFlags ( const TInt & )

SetIndicatorObserver ( MAknIndicatorObserver *, TUid )

SetIndicatorState ( TUid, TInt, TBool )

SetIndicatorValue ( TUid, TInt, TInt )

SetIndicatorValueL ( TUid, const TDesC & )

SizeChanged ( )

ReplaceIndicatorIconL ( TUid, TInt, TInt, CFbsBitmap , CFbsBitmap , TInt )