CAknIndicatorContainer Class Reference
| class CAknIndicatorContainer : public CAknControl |
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.
| Public Member Functions |
|---|
| CAknIndicatorContainer() |
| CAknIndicatorContainer(TInt) |
| ~CAknIndicatorContainer() |
| IMPORT_C void | ConstructFromResourceL(TResourceReader &) |
| IMPORT_C void | ConstructL() |
| IMPORT_C TUid | CreateIndicatorFromResourceL(TInt, TInt) |
| void | DrawPictographArea() |
| 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 &) |
| 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::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() |
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.
Parameters
| TInt aIndicatorContext | Indicator container context. |
~CAknIndicatorContainer()
| IMPORT_C | ~CAknIndicatorContainer | ( | ) | |
Member Functions Documentation
ComponentControl(TInt)
| IMPORT_C CCoeControl * | ComponentControl | ( | TInt | aIndex | ) | const [protected, virtual] |
Returns a control determined by control index.
Parameters
| TInt aIndex | Index of a control to be returned. |
ConstructFromResourceL(TResourceReader &)
Constructs the object from resource.
ConstructL()
| IMPORT_C void | ConstructL | ( | ) | |
Second-phase constructor.
CountComponentControls()
| IMPORT_C TInt | CountComponentControls | ( | ) | const [protected, virtual] |
Returns number of controls inside the context pane control.
CountShownIndicator()
|
TInt
| CountShownIndicator | ( | ) | const [private] |
CreateIncallBubbleL()
| void | CreateIncallBubbleL | ( | ) | [private] |
CreateIndicatorFromPaneResourceL(TUid, TInt, TInt)
| void | CreateIndicatorFromPaneResourceL | ( | TUid | aUid, |
| | TInt | aIndicatorPaneResourceId, |
| | TInt | aCustomIndicatorFlags |
| | ) | [private] |
Parameters
| TUid aUid | |
| TInt aIndicatorPaneResourceId | |
| TInt aCustomIndicatorFlags | |
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.
Parameters
| TInt 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. |
| TInt 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. |
Draw(const TRect &)
| IMPORT_C void | Draw | ( | const TRect & | aRect | ) | const [private, virtual] |
DrawPictographArea()
Redraws those indicators that are visible and contain pictographs.
ExtensionInterface(TUid)
| IMPORT_C void * | ExtensionInterface | ( | TUid | aInterface | ) | [private, virtual] |
Virtual method provided to allow extensibility of virtual behaviour
HandlePointerEventL(const TPointerEvent &)
| IMPORT_C void | HandlePointerEventL | ( | const TPointerEvent & | aPointerEvent | ) | [virtual] |
Parameters
| const TPointerEvent & aPointerEvent | The pointer event. |
HandleResourceChange(TInt)
| IMPORT_C void | 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.
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.
IncallBubbleSizeChanged(TBool)
| void | IncallBubbleSizeChanged | ( | TBool | aAllowIdleStateBubble | ) | [private] |
Parameters
| TBool aAllowIdleStateBubble | |
IndicatorContext()
| IMPORT_C TInt | IndicatorContext | ( | ) | const |
Returns the context of the indicator container.
IndicatorExists(TUid)
|
TBool
| IndicatorExists | ( | TUid | aUid | ) | const [private] |
IndicatorState(TUid)
| IMPORT_C TInt | IndicatorState | ( | TUid | aIndicatorId | ) | |
Return the current state of an indicator.
Parameters
| TUid aIndicatorId | ID 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] |
Handles position change events.
PrioritizeIndicatorsL()
| void | PrioritizeIndicatorsL | ( | ) | [private] |
ReplaceIndicatorIconL(TUid, TInt, TInt, CFbsBitmap *, CFbsBitmap *, TInt)
Replaces the icon of the given indicator.
Parameters
| TUid aIndicator | UID of the indicator. |
| TInt aState | State which icon is replaced (EAknIndicatorStateOn or EAknIndicatorStateAnimate) |
| TInt aLayoutMode | Layout mode of the icon to be replaced (ELayoutModeUsual or ELayoutModeWide) |
| CFbsBitmap * aIconBitmap | Bitmap of the new icon. Ownership is transferred to CAknIndicatorContainer. |
| CFbsBitmap * aIconMask | Mask of the new icon. Ownership is transferred to CAknIndicatorContainer. |
| TInt aIconIndex = 0 | 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. |
Reserved_1()
| void | Reserved_1 | ( | ) | [private, virtual] |
ResetAnimTicker(TBool)
| void | ResetAnimTicker | ( | TBool | bForeground | ) | [private] |
SelectIndicatorLayoutMode()
|
TInt
| SelectIndicatorLayoutMode | ( | ) | [private] |
SetContainerWindowNonFading(TBool)
| void | SetContainerWindowNonFading | ( | TBool | aNonFading | ) | [private] |
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.
Parameters
| TBool 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.
Parameters
| TBool aAllowed | If true incall bubble is shown in usual statuspane. |
SetIncallBubbleDisabled(TBool)
| void | SetIncallBubbleDisabled | ( | TBool | aDisabled | ) | [private] |
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.
Parameters
| const TInt & aFlags | Mode of the bubble. |
SetIndicatorObserver(MAknIndicatorObserver *, TUid)
| IMPORT_C void | SetIndicatorObserver | ( | MAknIndicatorObserver * | aIndicatorObserver, |
| | TUid | aIndicatorUid |
| | ) | |
Sets observer for given indicator.
Parameters
| MAknIndicatorObserver * aIndicatorObserver | Observer of the indicator. |
| TUid 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:
Editor indicators do not support animation.
Parameters
| TUid aIndicatorId | ID of the indicator to be modified. |
| TInt aState | A state to be set to the indicator. |
| TBool aDrawNow = ETrue | 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.
Parameters
| TUid aIndicatorId | ID of the indicator to be modified. |
| TInt aValue | Current progress of the task that bar describes. |
| TInt 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).
Parameters
| TUid aIndicatorId | ID of the indicator to be modified. |
| const TDesC & aString | Value of the indicator. |
SetupIndicatorLayoutModes()
| void | SetupIndicatorLayoutModes | ( | ) | [private] |
SizeChanged()
| IMPORT_C void | SizeChanged | ( | ) | [protected, virtual] |
Handles size change events.
SizeChangedInExtendedStatusPane()
| void | SizeChangedInExtendedStatusPane | ( | ) | [private] |
SizeChangedInFlatStatusPane()
| void | SizeChangedInFlatStatusPane | ( | ) | [private] |
SizeChangedInIdleExtendedStatusPane()
| void | SizeChangedInIdleExtendedStatusPane | ( | ) | [private] |
SizeChangedInIdleVertical()
| void | SizeChangedInIdleVertical | ( | ) | [private] |
SizeChangedInNormalStatusPane()
| void | SizeChangedInNormalStatusPane | ( | ) | [private] |
SizeChangedInSmallStatusPane()
| void | SizeChangedInSmallStatusPane | ( | ) | [private] |
SizeChangedInStaconPane()
| void | SizeChangedInStaconPane | ( | ) | [private] |
TickerCallback(TAny *)
|
TInt
| TickerCallback | ( | TAny * | aThis | ) | [private, static] |
UpdateSmallLayoutL()
|
TBool
| UpdateSmallLayoutL | ( | ) | [private] |
Member Enumerations Documentation
Enum TCustomIndicatorFlags
Additional flags that can be used for custom indicators.
Enumerators
| EMultiColorIndicator = 0x1 | |
| EIndicatorPositionInverted = 0x2 | |
Enum TIndicatorAlignment
Alignment of the indicators.
Enum TIndicatorContext
Context of the indicator container. These are used to specify what type of status indicators the indicator container contains.
Enumerators
| EUniversalIndicators = 0 | |
| ENaviPaneEditorIndicators | |
| EQueryEditorIndicators | |
| EFindIndicators | |
Enum TIndicatorPosition
Position of a indicator. These are used for invidual indicators to coarsely specify where they are positioned inside the indicator container.
Enumerators
| ELeftSide | |
| ERightSide | |
| EMiddle | |
Enum TLayoutMode
Layout modes of indicator container.
Enumerators
| ELayoutModeUsual | |
| ELayoutModeWide | |
Enum TLayoutOrientation
Layout orientations of the indicator container. These are used to specify how the indicators are laid out inside the indicator container.
Member Type Definitions Documentation
Typedef CAknIndicatorQueue
| typedef
CArrayPtrFlat< CAknIndicator > | CAknIndicatorQueue | [private] |
Member Data Documentation
TIndicatorAlignment
iAlignment
Alignment of the indicators.
TInt
iAnimatedIndicatorsShown
|
TInt
| iAnimatedIndicatorsShown | [private] |
Number of animated indicators shown.
CAknIndicatorContainerExtension * iExtension
| CAknIndicatorContainerExtension * | iExtension | [private] |
CIncallStatusBubble * iIncallBubble
| CIncallStatusBubble * | iIncallBubble | [private] |
Small incall status bubble.
TInt
iIndicatorContext
|
TInt
| iIndicatorContext | [private] |
Context of the indicators.
CAknIndicatorQueue * iIndicators
TInt
iIndicatorsShown
|
TInt
| iIndicatorsShown | [private] |
Number of indicators shown.
TLayoutOrientation
iLayoutOrientation
TLayoutOrientation
iPreviousLayoutOrientation
TInt
iSynchronizingValue
|
TInt
| iSynchronizingValue | [private] |
Synchronization value used in the indicator animations.
CPeriodic * iTicker
Indicator animation timer.
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.