| class CAknNavigationControlContainer : public CAknControl |
A default control in the status pane's navigation pane.
| Protected Member Functions | |
|---|---|
| IMPORT_C CCoeControl * | ComponentControl(TInt) |
| IMPORT_C TInt | CountComponentControls() |
| IMPORT_C void | HandleControlEventL(CCoeControl *, TCoeEvent) |
| IMPORT_C void | HandleResourceChange(TInt) |
| TTypeUid::Ptr | MopSupplyObject(TTypeUid) |
| IMPORT_C void | SizeChanged() |
| Private Member Functions | |
|---|---|
| IMPORT_C void | Draw(const TRect &) |
| TBool | DrawDefaultNaviSolid(CWindowGc &, const TRect &) |
| TBool | DrawDefaultNaviWipe(CWindowGc &, const TRect &) |
| TBool | DrawSkinnedNaviSolid(CWindowGc &, const TRect &, MAknsSkinInstance *, MAknsControlContext *) |
| TBool | DrawSkinnedNaviWipe(CWindowGc &, const TRect &, MAknsSkinInstance *, MAknsControlContext *) |
| IMPORT_C void * | ExtensionInterface(TUid) |
| void | HandleVisibilityOfNonFepOwnedIndicatorControl(CAknNavigationDecorator *, TBool) |
| TBool | IsFepOwnedEditorIndicatorControl(CAknNavigationDecorator *) |
| void | LoadNaviColorBitmapL() |
| void | SetContainerWindowNonFading(TBool) |
| TRect | VolumePopupRect() |
| Inherited Enumerations | |
|---|---|
| CCoeControl:TZoomType | |
| Private Member Type Definitions | |
|---|---|
| typedef | CArrayPtrFlat< CAknNavigationDecorator > CAknNaviPaneStack |
| Private Attributes | |
|---|---|
| CAknNavigationControlContainerExtension * | iExtension |
| CFbsBitmap * | iNaviArrowBitmap |
| CAknNavigationDecorator * | iNaviDecoratorFromResource |
| CAknNaviPaneStack * | iNaviPaneControls |
| TInt | iSpare |
| CEikStatusPaneBase * | iStatusPane |
| Inherited Attributes | |
|---|---|
| CCoeControl::iCoeEnv | |
| CCoeControl::iContext | |
| CCoeControl::iPosition | |
| CCoeControl::iSize | |
| IMPORT_C | CAknNavigationControlContainer | ( | ) |
C++ default constructor.
This object does not own the contents of the navi pane controls stack.
| IMPORT_C | ~CAknNavigationControlContainer | ( | ) |
Destructor.
This object does not own the contents of the navi pane controls stack.
| IMPORT_C TInt | ColorScheme | ( | ) | [static] |
Static method to return current color scheme. Current color scheme value.
| IMPORT_C CCoeControl * | ComponentControl | ( | TInt | aIndex | ) | const [protected, virtual] |
| TInt aIndex | Index of a control to be returned. |
| IMPORT_C void | ConstructFromResourceL | ( | TResourceReader & | aReader | ) | [virtual] |
Constructs from a resource. Created object is owned by this object until ResourceDecorator() method is called. If the application does not fetch the object it is deleted in destructor.
| TResourceReader & aReader | Resource reader. |
| IMPORT_C CAknNavigationDecorator * | ConstructNavigationDecoratorFromResourceL | ( | TResourceReader & | aReader | ) |
Resource constructor that returns a new object to the application.
Navigation decorator object that contains navigation pane control read from resources.
| TResourceReader & aReader | Resource reader. |
| IMPORT_C TInt | CountComponentControls | ( | ) | const [protected, virtual] |
From CCoeControl.
Returns number of controls inside the context pane control.
Number of component controls.
| IMPORT_C CAknNavigationDecorator * | CreateEditorIndicatorContainerL | ( | ) |
Creates editor indicator container control to the navi pane. The ownership of the object is transferred to the application.
Navigation decorator object that contains editor indicator container.
| IMPORT_C CAknNavigationDecorator * | CreateMessageLabelL | ( | const TDesC & | aText = KNullDesC | ) |
Creates and returns a new navigation decorator object containing help text. The ownership of the object is transferred to the application.
Navigation decorator object that contains message label (=hint text).
| IMPORT_C CAknNavigationDecorator * | CreateMessageLabelL | ( | TResourceReader & | aReader | ) |
Creates from a resource and returns a new navigation decorator object containing help text. The ownership of the object is transferred to the application.
Navigation decorator object that contains message label (=hint text).
| TResourceReader & aReader | Resource reader. |
| IMPORT_C CAknNavigationDecorator * | CreateNavigationImageL | ( | const CFbsBitmap * | aBitmap = NULL, |
| const CFbsBitmap * | aMaskBitmap = NULL | |||
| ) | ||||
Creates and returns a new navigation decorator object containing navigation image. The ownership of the returned object is transferred to the application. Moves ownership of aBitmap and aMaskBitmap to the navigation decorator object at the end of the method.
Navigation decorator object that contains navigation image.
| const CFbsBitmap * aBitmap = NULL | Image to be shown in the navigation pane. |
| const CFbsBitmap * aMaskBitmap = NULL | Mask of the image to be shown in the navigation panel. |
| IMPORT_C CAknNavigationDecorator * | CreateNavigationImageL | ( | TResourceReader & | aReader | ) |
Creates from a resource and returns a new navigation decorator object containing navigation image. The ownership of the returned object is transferred to the application.
Navigation decorator object that contains navigation image.
| TResourceReader & aReader | Resource reader. |
| IMPORT_C CAknNavigationDecorator * | CreateNavigationLabelL | ( | const TDesC & | aText = KNullDesC | ) |
Creates and returns a new navigation decorator object containing navigation label. The ownership of the object is transferred to the application.
Navigation decorator object that contains navigation label.
| IMPORT_C CAknNavigationDecorator * | CreateNavigationLabelL | ( | TResourceReader & | aReader | ) |
Creates from a resource and returns a new navigation decorator object containing navigation label. The ownership of the object is transferred to the application.
Navigation decorator object that contains navigation label.
| TResourceReader & aReader | Resource reader. |
| IMPORT_C CAknNavigationDecorator * | CreateTabGroupL | ( | ) |
Creates and returns a new navigation decorator object containing tab group. The ownership of the object is transferred to the application.
Navigation decorator object that contains tab group.
| IMPORT_C CAknNavigationDecorator * | CreateTabGroupL | ( | MAknTabObserver * | aObserver | ) |
Creates and returns a new navigation decorator object containing tab group. The ownership of the object is transferred to the application.
Navigation decorator object that contains tab group.
| MAknTabObserver * aObserver | Pointer to tab group observer |
| IMPORT_C CAknNavigationDecorator * | CreateTabGroupL | ( | TResourceReader & | aReader | ) |
Creates from a resource and returns a new navigation decorator object containing tab group. The ownership of the object is transferred to the application.
Navigation decorator object that contains tab group.
| TResourceReader & aReader | Resource reader. |
| IMPORT_C CAknNavigationDecorator * | CreateTabGroupL | ( | TResourceReader & | aReader, |
| MAknTabObserver * | aObserver | |||
| ) | ||||
Creates from a resource and returns a new navigation decorator object containing tab group. The ownership of the object is transferred to the application.
Navigation decorator object that contains tab group.
| TResourceReader & aReader | Resource reader. |
| MAknTabObserver * aObserver | Pointer to tab group observer. |
| IMPORT_C CAknNavigationDecorator * | CreateVolumeIndicatorL | ( | TInt | aResourceId | ) |
Creates volume control indicator to the navi pane. The ownership of the object is transferred to the application.
Navigation decorator object that contains volume indicator.
Navi pane volume control is not supported anymore.
| TInt aResourceId | Resource file id for the volume control |
| TInt | CurrentNaviWipeBitmap | ( | ) | [static] |
Gets current wipe bitmap for navi pane.
Wipe bitmap Id
| IMPORT_C void | Draw | ( | const TRect & | aRect | ) | const [private, virtual] |
| const TRect & aRect |
| TBool | DrawDefaultNaviSolid | ( | CWindowGc & | aGc, |
| const TRect & | aRect | |||
| ) | const [private] | |||
Checks wheter default navi solid bitmap can be drawn to navipane and draws it if it is possible.
S60 2.6
ETrue if draw operation was done, otherwise EFalse.
| TBool | DrawDefaultNaviWipe | ( | CWindowGc & | aGc, |
| const TRect & | aRect | |||
| ) | const [private] | |||
Checks wheter default navi wipe bitmap can be drawn to navipane and draws it if it is possible.
S60 2.6
ETrue if draw operation was done, otherwise EFalse.
| TBool | DrawSkinnedNaviSolid | ( | CWindowGc & | aGc, |
| const TRect & | aRect, | |||
| MAknsSkinInstance * | aSkin, | |||
| MAknsControlContext * | aCc | |||
| ) | const [private] | |||
Checks wheter skinned navi solid bitmap can be drawn to navipane and draws it if it is possible. Also skinned background bitmap is drawn.
S60 2.6
ETrue if draw operation was done, otherwise EFalse.
| CWindowGc & aGc | Used graphics context. |
| const TRect & aRect | Rect of the navipane. |
| MAknsSkinInstance * aSkin | Used skin instance. |
| MAknsControlContext * aCc | Used skin control context. |
| TBool | DrawSkinnedNaviWipe | ( | CWindowGc & | aGc, |
| const TRect & | aRect, | |||
| MAknsSkinInstance * | aSkin, | |||
| MAknsControlContext * | aCc | |||
| ) | const [private] | |||
Checks wheter skinned navi wipe bitmap can be drawn to navipane and draws it if it is possible. Also skinned background bitmap is drawn.
S60 2.6
ETrue if draw operation was done, otherwise EFalse.
| CWindowGc & aGc | Used graphics context. |
| const TRect & aRect | Rect of the navipane. |
| MAknsSkinInstance * aSkin | Used skin instance. |
| MAknsControlContext * aCc | Used skin control context. |
| IMPORT_C void * | ExtensionInterface | ( | TUid | aInterface | ) | [private, virtual] |
From CAknControl
| TUid aInterface |
| IMPORT_C void | HandleControlEventL | ( | CCoeControl * | aControl, |
| TCoeEvent | aEventType | |||
| ) | [protected] | |||
From MCoeControlObserver.
Handles Control event.
| CCoeControl * aControl | Control that caused the event. |
| TCoeEvent aEventType | Type of the event. |
| void | HandleGainingForegroundL | ( | ) |
Used to notify the navi pane when it gains foreground.
| void | HandleLosingForeground | ( | ) |
Used to notify the navi pane when it goes to background.
| IMPORT_C void | HandlePointerEventL | ( | const TPointerEvent & | aPointerEvent | ) | [virtual] |
From CCoeControl.
Handles pointer events
| const TPointerEvent & aPointerEvent | The pointer event. |
| IMPORT_C void | HandleResourceChange | ( | TInt | aType | ) | [protected, virtual] |
From CCoeControl.
Handles a change to the control's resources of type aType which are shared across the environment, e.g. color scheme change.
| TInt aType | Event type. |
| void | HandleVisibilityOfNonFepOwnedIndicatorControl | ( | CAknNavigationDecorator * | aDecorator, |
| TBool | aVisible | |||
| ) | [private] | |||
| CAknNavigationDecorator * aDecorator | |
| TBool aVisible |
| TBool | IsFepOwnedEditorIndicatorControl | ( | CAknNavigationDecorator * | aDecorator | ) | const [private] |
| CAknNavigationDecorator * aDecorator |
| void | LoadNaviColorBitmapL | ( | ) | [private] |
Loads a color bitmap for CAknNavigationDecorator. S60 2.8
| TTypeUid::Ptr | MopSupplyObject | ( | TTypeUid | aId | ) | [protected] |
From CCoeControl.
Retrieves an object of the same type as that encapsulated in aId.
This function is used to allow controls to ask their owners for access to other objects that they own.
Other than in the case where NULL is returned, the object returned must be of the same object type - that is, the ETypeId member of the object pointed to by the pointer returned by this function must be equal to the iUid member of aId.
Encapsulated pointer to the provided object. Note that the encapsulated pointer may be NULL.
| TTypeUid aId | An encapsulated object type ID. |
| CFbsBitmap & | NaviArrowBitmap | ( | TInt | aId | ) |
This non-exported method returns reference to navi arrow bitmaps.
Reference to the navi arrow bitmap.
| TInt aId | Id of the bitmap. |
| void | NotifyNaviWipeStatusL | ( | ) |
Used by the UI framework. Notifies context and signal panes wheter navi wipe graphichs is to be drawn or not.
| IMPORT_C void | Pop | ( | ) |
Pops topmost object from the navigation pane's object stack. If editor indicator control is topmost, it is not popped. The next control is popped instead. It is not possible to pop editor indicator object with this method. Use Pop(CAknNavigationDecorator* aControl) or delete(aControl) instead if editor indicator control is needed to be popped.
| IMPORT_C void | Pop | ( | CAknNavigationDecorator * | aControl | ) |
Pops (remove) certain object from the navigation pane's object stack. The removed object does not need to be topmost.
| CAknNavigationDecorator * aControl | Object to be removed from the stack. |
| IMPORT_C void | PushDefaultL | ( | TBool | aAllowDuplicates = EFalse | ) |
Pushes default content (empty navigation pane) to the navigation pane's object stack. This operation also draws default content to the navigation pane.
| TBool aAllowDuplicates = EFalse | If this is ETrue, duplicate default navi pane contents are allowed. |
| IMPORT_C void | PushL | ( | CAknNavigationDecorator & | aNaviPaneControl | ) |
Pushes a navigation decorator object to the navigation pane's object stack. This operation also draws the control to the navigation pane. An object can be on the stack only once. If the object already exists in the stack it is moved to topmost object. Ownership is not transfered. Editor indicator control has priority over others. It is always at the top if it exists. In this case all other controls are pushed under the editor indicator object.
| CAknNavigationDecorator & aNaviPaneControl | Object to be added at the top of the stack. |
| IMPORT_C TInt | ReplaceL | ( | CAknNavigationDecorator & | aToBeReplaced, |
| CAknNavigationDecorator & | aReplacement | |||
| ) | ||||
Replaces existing navigation decorator object in the navigation pane's object stack. Any object can be on the stack only once. If the replacement object already exists in the stack, previous copy is removed from the stack. Ownership is not transfered. Navi pane is redrawn if top item is changed.
Error number. KErrNone if the operation succeeds. KErrNotFound if 'aToBeReplaced' object cannot be found from the stack.
| CAknNavigationDecorator & aToBeReplaced | An object to be replaced. |
| CAknNavigationDecorator & aReplacement | An object that is put to the stack instead. |
| IMPORT_C CAknNavigationDecorator * | ResourceDecorator | ( | ) |
Returns the object constructed from resources with ConstrucFromResourcesL() -method to the application. Ownership of the object is transferred to the application.
Navigation Decorator object that was created from resources.
| void | SetBackgroundContextAttributes | ( | CCoeControl * | aControl, |
| TBool | aNaviWipeUsed | |||
| ) | [static] | |||
Not used / implemented
S60 3.0
| CCoeControl * aControl | |
| TBool aNaviWipeUsed |
| void | SetContainerWindowNonFading | ( | TBool | aNonFading | ) | [private] |
| TBool aNonFading |
| IMPORT_C void | SetPreferredNaviDecoratorLayoutStyle | ( | TInt | aLayoutStyle | ) |
This method can be used to set preferred layout style for navi decorator objects that are pushed into navistack. Given layout is applied to objects only if that object supports it and status pane layout allows that mode to be used.
3.1
| TInt aLayoutStyle | CAknNavigationDecorator::ENaviControlLayoutNormal, CAknNavigationDecorator::ENaviControlLayoutNarrow or CAknNavigationDecorator::ENaviControlLayoutWide |
| IMPORT_C void | SizeChanged | ( | ) | [protected, virtual] |
From CCoeControl.
Handles the size change events.
| IMPORT_C CAknNavigationDecorator * | Top | ( | ) |
Returns topmost object from navigation pane's object stack. Editor indicator object is transparent for this operation. If editor indicators exist on the navi pane, next object on the stack is returned.
Navigation decorator object that is topmost in navigation pane's object stack.
| IMPORT_C CAknNavigationDecorator * | Top | ( | TBool | aIgnoreFepEditorIndicator | ) | const |
Return topmost object from navigation pane's object stack. FEP Editor indicator object is transparent or visible for this operation depending on the given parameter value. If editor indicator object is to be ignored and it exist on the navi pane, next object on the stack is returned. Note that generally FEP does all the needed visibility etc. handling for FEP editor indicators, so by default applications should ignore FEP editor indicators.
3.1
Navigation decorator object that is topmost in navigation pane's object stack.
| TBool aIgnoreFepEditorIndicator | Tells if editor indicator object is ignored. |
| typedef CArrayPtrFlat< CAknNavigationDecorator > | CAknNaviPaneStack | [private] |
| CAknNavigationControlContainerExtension * | iExtension | [private] |
| CAknNavigationDecorator * | iNaviDecoratorFromResource | [private] |