#include <mw/aknnavide.h>
| class CAknNavigationDecorator : public CAknControl |
| Protected Attributes | |
|---|---|
| CAknNavigationControlContainer * | iContainer |
| CCoeControl * | iDecoratedControl |
| MAknNaviDecoratorObserver * | iNaviDecoratorObserver |
| Public Member Enumerations | |
|---|---|
| enum | TAknNaviControlLayoutMode { ENaviControlLayoutModeAutomatic, ENaviControlLayoutModeForced } |
| enum | TAknNaviControlLayoutStyle { ENaviControlLayoutNormal, ENaviControlLayoutNarrow, ENaviControlLayoutWide } |
| enum | TControlType { ENotSpecified, ETabGroup, ENaviLabel, ENaviImage, ..., ENaviVolume } |
| enum | TScrollButton { ELeftButton, ERightButton } |
| Protected Member Functions | |
|---|---|
| virtual IMPORT_C CCoeControl * | ComponentControl(TInt) |
| virtual IMPORT_C TInt | CountComponentControls() |
| IMPORT_C void | HandleControlEventL(CCoeControl *, TCoeEvent) |
| virtual IMPORT_C void | SizeChanged() |
| Inherited Attributes | |
|---|---|
| CCoeControl::iCoeEnv | |
| CCoeControl::iContext | |
| CCoeControl::iPosition | |
| CCoeControl::iSize | |
| Inherited Enumerations | |
|---|---|
| CCoeControl:TZoomType | |
Decorator class for navigation pane controls. The class, for example, decorates navigation pane controls with navi arrows.
| MAknNaviDecoratorObserver * | iNaviDecoratorObserver | [protected] |
Observer for handling decorator events.
Defines the navigation control layout mode.
Defines the navigation control layout style.
| IMPORT_C CCoeControl * | ComponentControl | ( | TInt | aIndex | ) | const [protected, virtual] |
Reimplemented from CCoeControl::ComponentControl(TInt)const
From CCoeControl.
Returns a control determined by control id.
| Parameter | Description |
|---|---|
| aIndex | Index of a control to be returned. |
Returns: Pointer to the control.
| IMPORT_C TControlType | ControlType | ( | ) | const |
Returns the type of the decorated control.
Returns: Control type.
| IMPORT_C TInt | CountComponentControls | ( | ) | const [protected, virtual] |
Reimplemented from CCoeControl::CountComponentControls()const
From CCoeControl.
Returns the number of controls inside the context pane control.
Returns: Number of controls.
| IMPORT_C CCoeControl * | DecoratedControl | ( | ) |
Returns the control inside a navigation decorator object. Ownership of the control is not changed.
Returns: Control that is decorated with the decorator.
Gets the default rectangle of the given control type.
| Parameter | Description |
|---|---|
| aControlType | The control type from which default rectangle is asked. |
| aArrowsUsed | Whether or not the navigation arrows are used for the control. This is only used for the tab group control. If arrows are not used with tab group, then the whole navi pane area is provided to the tab group control. |
Returns: Rectangle which tells the default area for given controltype. Coordinates are relative to navi pane.
Gets the default rect of tab group control type relative to navipane in normal (ENaviControlLayoutNormal) or wide (ENaviControlLayoutWide) layout style.
| Parameter | Description |
|---|---|
| aTopAdjacent | ETrue to return a rectangle adjacent to the top of navi pane, EFalse for a rectangle adjacent to the bottom of navi pane. |
| aArrowsUsed | Whether or not the navigation arrows are used for the tab group. If arrows are not used, then the whole navi pane area is provided to the tab group control. |
Returns: Rectangle which tells the default area for a tab group.
| IMPORT_C void | HandleControlEventL | ( | CCoeControl * | aControl, |
| TCoeEvent | aEventType | |||
| ) | [protected] | |||
From MCoeControlObserver.
Handles an event from an observed control.
| Parameter | Description |
|---|---|
| aControl | Control that caused the event. |
| aEventType | Type of the event. |
| IMPORT_C void | HandlePointerEventL | ( | const TPointerEvent & | aPointerEvent | ) | [virtual] |
Reimplemented from CCoeControl::HandlePointerEventL(const TPointerEvent &)
From CCoeControl.
Handle pointer events.
| Parameter | Description |
|---|---|
| aPointerEvent | Pointer event to be handled. |
| IMPORT_C void | HandleResourceChange | ( | TInt | aType | ) | [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.
| Parameter | Description |
|---|---|
| aType | Event type. |
| IMPORT_C TBool | IsScrollButtonDimmed | ( | TScrollButton | aButton | ) | const |
Is button dimmed or highlighted.
| Parameter | Description |
|---|---|
| aButton | Navigation arrow. |
Returns: ETrue If the navigation arrow is dimmed, EFalse if it is highlighted.
| IMPORT_C void | MakeScrollButtonVisible | ( | TBool | aVisible | ) |
Shows or hides the navigation arrows at the both ends of the navigation pane when current object is shown.
| Parameter | Description |
|---|---|
| aVisible | Boolean value if navigation arrows are shown with the decorated control. Visible if ETrue. |
| IMPORT_C TAknNaviControlLayoutMode | NaviControlLayoutMode | ( | ) |
Gets the current layout mode of decorated control. Can be ENaviControlLayoutModeAutomatic (default) or ENaviControlLayoutModeForced (usually set by the application).
Returns: Decorated control's current layout mode.
| IMPORT_C TAknNaviControlLayoutStyle | NaviControlLayoutStyle | ( | ) |
Gets the current layout style of this objects decorated control (ENaviControlLayoutNormalm ENaviControlLayoutNarrow or ENaviControlLayoutWide).
Returns: Current layout style of the navicontrol
| IMPORT_C TBool | NaviControlLayoutStyleSupported | ( | TAknNaviControlLayoutStyle | aStyle | ) |
Tells if decorated control supports given layout style at the current statuspane layout. For ENotSpecified type of controls this always returns EFalse (just for safety) because their implementation is not known.
| Parameter | Description |
|---|---|
| aStyle | The layout style. |
Returns: ETrue if the control supports given layout style otherwise returns EFalse.
| IMPORT_C CAknNavigationDecorator * | NewL | ( | CAknNavigationControlContainer * | aNavigationControlContainer, |
| CCoeControl * | aDecoratedControl, | |||
| TControlType | aType = ENotSpecified | |||
| ) | [static] | |||
Creates a new navigation decorator. The object takes ownership of the decorated object at the beginning of the method before any leaving functions.
| Parameter | Description |
|---|---|
| aNavigationControlContainer | Container control. |
| aDecoratedControl | Control to be decorated. |
| aType | = ENotSpecified Control type. |
Returns: Navigation Decorator object that contains decorated object.
| IMPORT_C TBool | ScrollButtonVisible | ( | ) | const |
Gets the State of the visibility of navigation arrows.
Returns: ETrue if visible.
| IMPORT_C void | SetControlType | ( | TControlType | aType | ) |
Sets the type of the decorated control.
| Parameter | Description |
|---|---|
| aType | Type of the control. |
| IMPORT_C void | SetNaviControlLayoutMode | ( | TAknNaviControlLayoutMode | aMode | ) |
Sets the layout mode ENaviControlLayoutModeAutomatic or ENaviControlLayoutModeForced. See TAknNaviControlLayoutMode for more information.
| Parameter | Description |
|---|---|
| aMode | New layout mode. |
| IMPORT_C void | SetNaviControlLayoutStyle | ( | TAknNaviControlLayoutStyle | aStyle | ) |
Sets the layout style for this objects decorated control. The layout style can be normal or narrow style.
The style is really applied if the decorated control supports it or if the layout mode has been set to forced mode (ENaviControlLayoutModeForced). Additionally narrow mode may not be supported at all in some statuspane configurations (even if forced).
Whether decorated control supports or does not support given style at the currently active statuspane layout can be queried using NaviControlLayoutStyleSupported() method.
| Parameter | Description |
|---|---|
| aStyle | Can be normal (ENaviControlLayoutNormal), narrow (ENaviControlLayoutNarrow) or wide (ENaviControlLayoutWide). |
| IMPORT_C void | SetNaviDecoratorObserver | ( | MAknNaviDecoratorObserver * | aObserver | ) | [virtual] |
Sets observer for navigation decorator events in the decorated control.
| Parameter | Description |
|---|---|
| aObserver | Pointer to observer. |
| void | SetNaviStack | ( | CAknNavigationControlContainer * | aContainer | ) |
Sets the pointer to the default navigation pane control.
| Parameter | Description |
|---|---|
| aContainer | Pointer to default control in navigation pane. |
| IMPORT_C void | SetScrollButtonDimmed | ( | TScrollButton | aButton, |
| TBool | aDimmed | |||
| ) | ||||
Sets the navigation arrow dimmed (and highlighted). Arrows have to be visible so that the dimmed arrow is shown on the screen.
| Parameter | Description |
|---|---|
| aButton | Navigation arrow to be set (ELeftButton or ERightButton). |
| aDimmed | ETrue is the button is dimmed, EFalse if the button is set highlighted. |
| IMPORT_C void | SizeChanged | ( | ) | [protected, virtual] |
Reimplemented from CCoeControl::SizeChanged()
From CCoeControl.
Handles the size change events.