CAknNavigationDecorator Class Reference

enum CAknNavigationDecorator::TAknNaviControlLayoutStyle

Defines the navigation control layout mode.

Enumerator:

ENaviControlLayoutModeAutomatic�	This is the default layout mode. It lets UI framework to decide the proper layout style which is applied to decorated controls in all situations.
ENaviControlLayoutModeForced�	`ENaviControlLayoutModeForced` layout mode can be used to lock the layout style to the current style.

enum CAknNavigationDecorator::TControlType

Defines the navigation control layout style.

Enumerator:

ENaviControlLayoutNormal�	Normal layout style.
ENaviControlLayoutNarrow�	Narrow layout style.

enum CAknNavigationDecorator::TScrollButton

Defines type of the decorated control.

Enumerator:

ENotSpecified�	Type not specified.
ETabGroup�	Tab group.
ENaviLabel�	Label.
ENaviImage�	Image.
EHintText�	Text.
EEditorIndicator�	Indicator.
ENaviVolume�	Volume.

IMPORT_C CAknNavigationDecorator::~CAknNavigationDecorator

Defines scroll buttons.

Enumerator:

ELeftButton�	Scroll left.
ERightButton�	Scroll right.

Constructor & Destructor Documentation

�	Destructor.

Member Function Documentation

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

Index of a control to be returned.

From CCoeControl.

Returns a control determined by control id.

Parameters:

aIndex�

Returns:: Pointer to the control.

IMPORT_C TControlType CAknNavigationDecorator::ControlType

const

�	Returns the type of the decorated control. Returns: Control type.

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

�	From `CCoeControl`. Returns the number of controls inside the context pane control. Returns: Number of controls.

IMPORT_C CCoeControl* CAknNavigationDecorator::DecoratedControl (� �)� [virtual]

�	Returns the control inside a navigation decorator object. Ownership of the control is not changed. Returns: Control that is decorated with the decorator. Implements MAknNavigationDecoratorInterface.

static TRect CAknNavigationDecorator::DecoratedControlNarrowRect (� TInt� aControlType �)� [static]

Gets the default rectangle of the navigation pane's default control.

Parameters:

aControlType�

Not used.

Returns:: Rectangle of the navigation pane's default control.

static TRect CAknNavigationDecorator::DecoratedControlRect (� TInt� aControlType �)� [static]

The control type from which default rectangle is asked.

Gets the default rectangle of the given control type.

Parameters:

aControlType�

Returns:: Rectangle which tells the default area for given controltype. Coordinates are relative to navipane.

IMPORT_C void CAknNavigationDecorator::HandleControlEventL	(�	CCoeControl *�	aControl,
		TCoeEvent�	aEventType
	)�	`[protected]`

IMPORT_C void CAknNavigationDecorator::HandlePointerEventL

From MCoeControlObserver.

Handles an event from an observed control.

Parameters:

	aControl�	Control that caused the event.
	aEventType�	Type of the event.

const TPointerEvent &�

aPointerEvent

Pointer event to be handled.

From CCoeControl.

Handle pointer events.

Parameters:

aPointerEvent�

virtual IMPORT_C void CAknNavigationDecorator::HandleResourceChange (� TInt� aType �)� [virtual]

IMPORT_C TBool CAknNavigationDecorator::IsScrollButtonDimmed

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

color scheme change. Public since 3rd Ed FP1

Parameters:

aType�

Event type.

Is button dimmed or highlighted.

Parameters:

aButton�

Navigation arrow.

Returns:: ETrue If the navigation arrow is dimmed, EFalse if it is highlighted.

IMPORT_C void CAknNavigationDecorator::MakeScrollButtonVisible

Shows or hides the navigation arrows at the both ends of the navigation pane when current object is shown.

Parameters:

aVisible� Boolean value if navigation arrows are shown with the decorated control. Visible if ETrue.

IMPORT_C TAknNaviControlLayoutMode CAknNavigationDecorator::NaviControlLayoutMode

IMPORT_C TAknNaviControlLayoutStyle CAknNavigationDecorator::NaviControlLayoutStyle

�	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 TBool CAknNavigationDecorator::NaviControlLayoutStyleSupported

�	Gets the current layout style of this objects decorated control (ENaviControlLayoutNormal or ENaviControlLayoutNarrow). Returns: Current layout style of the navicontrol

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.

Parameters:

aStyle�

The layout style.

Returns:: ETrue if the control supports given layout style otherwise returns EFalse.

static IMPORT_C CAknNavigationDecorator* CAknNavigationDecorator::NewL	(�	CAknNavigationControlContainer *�	aNavigationControlContainer,
		CCoeControl *�	aDecoratedControl,
		TControlType�	aType = `ENotSpecified`
	)�	`[static]`

IMPORT_C TBool CAknNavigationDecorator::ScrollButtonVisible

Creates a new navigation decorator.

The object takes ownership of the decorated object at the beginning of the method before any leaving functions.

Parameters:

	aNavigationControlContainer�	Container control.
	aDecoratedControl�	Control to be decorated.
	aType�	= `ENotSpecified` Control type.

Returns:: Navigation Decorator object that contains decorated object.

IMPORT_C void CAknNavigationDecorator::SetControlType

const

�	Gets the State of the visibility of navigation arrows. Returns: `ETrue` if visible.

Sets the type of the decorated control.

Parameters:

aType�

Type of the control.

IMPORT_C void CAknNavigationDecorator::SetNaviControlLayoutMode

TAknNaviControlLayoutMode�

aMode

IMPORT_C void CAknNavigationDecorator::SetNaviControlLayoutStyle

Sets the layout mode ENaviControlLayoutModeAutomatic or ENaviControlLayoutModeForced.

See TAknNaviControlLayoutMode for more information.

Parameters:

aMode�

New layout mode.

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.

Parameters:

aStyle� Can be either normal (ENaviControlLayoutNormal) or narrow style (ENaviControlLayoutNarrow).

virtual IMPORT_C void CAknNavigationDecorator::SetNaviDecoratorObserver (� MAknNaviDecoratorObserver *� aObserver �)� [virtual]

void CAknNavigationDecorator::SetNaviStack

Sets observer for navigation decorator events in the decorated control.

Parameters:

aObserver�

Pointer to observer.

CAknNavigationControlContainer *�

aContainer

Pointer to default control in navigation pane.

Sets the pointer to the default navigation pane control.

Parameters:

aContainer�

IMPORT_C void CAknNavigationDecorator::SetScrollButtonDimmed	(�	TScrollButton�	aButton,
		TBool�	aDimmed
	)�

friend class CAknNavigationControlContainer [friend]

Sets the navigation arrow dimmed (and highlighted).

Arrows have to be visible so that the dimmed arrow is shown on the screen.

Parameters:

	aButton�	Navigation arrow to be set (`ELeftButton` or `ERightButton`).
	aDimmed�	`ETrue` is the button is dimmed, `EFalse` if the button is set highlighted.

virtual IMPORT_C void CAknNavigationDecorator::SizeChanged (� �)� [protected, virtual]

�	From `CCoeControl`. Handles the size change events.

Friends And Related Function Documentation