CAknNavigationControlContainer Class Reference

API published in: S60 1st Ed

Link against: avkon.lib

Capability Information

Required Capabilities

None

#include <aknnavi.h>

Inherits CAknControl, and MAknNavigationContainerInterface.

Detailed Description

A default control in the status pane's navigation pane.


Public Member Functions
IMPORT_C void	ConstructL ()
	Handles 2nd phase construction.
IMPORT_C void	ConstructFromResourceL (TResourceReader &aReader)
	Constructs from a resource.
IMPORT_C CAknNavigationDecorator *	ConstructNavigationDecoratorFromResourceL (TResourceReader &aReader)
	Resource constructor that returns a new object to the application.
IMPORT_C CAknNavigationDecorator *	CreateTabGroupL ()
	Creates and returns a new navigation decorator object containing tab group.
IMPORT_C CAknNavigationDecorator *	CreateTabGroupL (MAknTabObserver *aObserver)
	Creates and returns a new navigation decorator object containing tab group.
IMPORT_C CAknNavigationDecorator *	CreateTabGroupL (TResourceReader &aReader)
	Creates from a resource and returns a new navigation decorator object containing tab group.
IMPORT_C CAknNavigationDecorator *	CreateTabGroupL (TResourceReader &aReader, MAknTabObserver *aObserver)
	Creates from a resource and returns a new navigation decorator object containing tab group.
IMPORT_C CAknNavigationDecorator *	CreateNavigationLabelL (const TDesC &aText=KNullDesC)
	Creates and returns a new navigation decorator object containing navigation label.
IMPORT_C CAknNavigationDecorator *	CreateNavigationLabelL (TResourceReader &aReader)
	Creates from a resource and returns a new navigation decorator object containing navigation label.
IMPORT_C CAknNavigationDecorator *	CreateNavigationImageL (const CFbsBitmap aBitmap=NULL, const CFbsBitmap aMaskBitmap=NULL)
	Creates and returns a new navigation decorator object containing navigation image.
IMPORT_C CAknNavigationDecorator *	CreateNavigationImageL (TResourceReader &aReader)
	Creates from a resource and returns a new navigation decorator object containing navigation image.
IMPORT_C CAknNavigationDecorator *	CreateMessageLabelL (const TDesC &aText=KNullDesC)
	Creates and returns a new navigation decorator object containing help text.
IMPORT_C CAknNavigationDecorator *	CreateMessageLabelL (TResourceReader &aReader)
	Creates from a resource and returns a new navigation decorator object containing help text.
IMPORT_C CAknNavigationDecorator *	CreateVolumeIndicatorL (TInt aResourceId)
	Creates volume control indicator to the navi pane.
IMPORT_C CAknNavigationDecorator *	CreateEditorIndicatorContainerL ()
	Creates editor indicator container control to the navi pane.
IMPORT_C void	PushDefaultL (TBool aAllowDuplicates=EFalse)
	Pushes default content (empty navigation pane) to the navigation pane's object stack.
IMPORT_C void	PushL (CAknNavigationDecorator &aNaviPaneControl)
	Pushes a navigation decorator object to the navigation pane's object stack.
IMPORT_C void	Pop ()
	Pops topmost object from the navigation pane's object stack.
IMPORT_C void	Pop (CAknNavigationDecorator *aControl)
	Pops (remove) certain object from the navigation pane's object stack.
IMPORT_C CAknNavigationDecorator *	Top ()
	Returns topmost object from navigation pane's object stack.
IMPORT_C CAknNavigationDecorator *	Top (TBool aIgnoreFepEditorIndicator) const
	Return topmost object from navigation pane's object stack.
IMPORT_C TInt	ReplaceL (CAknNavigationDecorator &aToBeReplaced, CAknNavigationDecorator &aReplacement)
	Replaces existing navigation decorator object in the navigation pane's object stack.
IMPORT_C CAknNavigationDecorator *	ResourceDecorator ()
	Returns the object constructed from resources with `ConstrucFromResourcesL()` -method to the application.
CFbsBitmap &	NaviArrowBitmap (TInt aId)
	This non-exported method returns reference to navi arrow bitmaps.
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.
void	NotifyNaviWipeStatusL ()
	Used by the UI framework.
IMPORT_C void	HandlePointerEventL (const TPointerEvent &aPointerEvent)
	From `CCoeControl`.
TBool	NaviWipeUsed () const
	Not used / implemented.
CFbsBitmap *	NaviColorBitmap () const
	Gets navi bitmap.
Static Public Member Functions
static IMPORT_C TInt	ColorScheme ()
	Static method to return current color scheme.
static TInt	CurrentNaviWipeBitmap ()
	Gets current wipe bitmap for navi pane.
static void	SetBackgroundContextAttributes (CCoeControl *aControl, TBool aNaviWipeUsed)
	Not used / implemented.
Data Fields
DECLARE_TYPE_ID(0x101F8740) public IMPORT_	~CAknNavigationControlContainer )()
	Destructor.
Protected Member Functions
virtual IMPORT_C void	SizeChanged ()
	From `CCoeControl`.
virtual IMPORT_C void	HandleResourceChange (TInt aType)
	From `CCoeControl`.
virtual IMPORT_C TInt	CountComponentControls () const
	From `CCoeControl`.
virtual IMPORT_C CCoeControl *	ComponentControl (TInt aIndex) const
	From `CCoeControl`.
IMPORT_C void	HandleControlEventL (CCoeControl *aControl, TCoeEvent aEventType)
	From `MCoeControlObserver`.
TTypeUid::Ptr	MopSupplyObject (TTypeUid aId)
	From `CCoeControl`.

Member Function Documentation

static IMPORT_C TInt CAknNavigationControlContainer::ColorScheme ( ) [static]

Static method to return current color scheme.

Returns:: Current color scheme value.

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

From CCoeControl.

Returns a control determined by control id.

Parameters:

aIndex

Index of a control to be returned.

Returns:: Pointer to control.

IMPORT_C void CAknNavigationControlContainer::ConstructFromResourceL

(

TResourceReader &

aReader

)

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.

Parameters:

aReader

Resource reader.

IMPORT_C void CAknNavigationControlContainer::ConstructL

(

)

Handles 2nd phase construction.

IMPORT_C CAknNavigationDecorator* CAknNavigationControlContainer::ConstructNavigationDecoratorFromResourceL

(

TResourceReader &

aReader

)

Resource constructor that returns a new object to the application.

Parameters:

aReader

Resource reader.

Returns:: Navigation decorator object that contains navigation pane control read from resources.

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

From CCoeControl.

Returns number of controls inside the context pane control.

Returns:: Number of component controls.

IMPORT_C CAknNavigationDecorator* CAknNavigationControlContainer::CreateEditorIndicatorContainerL

(

)

Creates editor indicator container control to the navi pane.

The ownership of the object is transferred to the application.

Returns:: Navigation decorator object that contains editor indicator container.

IMPORT_C CAknNavigationDecorator* CAknNavigationControlContainer::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.

Parameters:

aReader

Resource reader.

Returns:: Navigation decorator object that contains message label (=hint text).

IMPORT_C CAknNavigationDecorator* CAknNavigationControlContainer::CreateMessageLabelL ( const TDesC & aText = KNullDesC ) [virtual]

Creates and returns a new navigation decorator object containing help text.

The ownership of the object is transferred to the application.

Parameters:

aText

Help text label to be shown in the navigation pane.

Returns:: Navigation decorator object that contains message label (=hint text).

Implements MAknNavigationContainerInterface.

IMPORT_C CAknNavigationDecorator* CAknNavigationControlContainer::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.

Parameters:

aReader

Resource reader.

Returns:: Navigation decorator object that contains navigation image.

IMPORT_C CAknNavigationDecorator* CAknNavigationControlContainer::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.

Parameters:

	aBitmap	Image to be shown in the navigation pane.
	aMaskBitmap	Mask of the image to be shown in the navigation panel.

Returns:: Navigation decorator object that contains navigation image.

IMPORT_C CAknNavigationDecorator* CAknNavigationControlContainer::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.

Parameters:

aReader

Resource reader.

Returns:: Navigation decorator object that contains navigation label.

IMPORT_C CAknNavigationDecorator* CAknNavigationControlContainer::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.

Parameters:

aText

Label text to the navigation pane.

Returns:: Navigation decorator object that contains navigation label.

IMPORT_C CAknNavigationDecorator* CAknNavigationControlContainer::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.

Parameters:

	aReader	Resource reader.
	aObserver	Pointer to tab group observer.

Returns:: Navigation decorator object that contains tab group.

IMPORT_C CAknNavigationDecorator* CAknNavigationControlContainer::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.

Parameters:

aReader

Resource reader.

Returns:: Navigation decorator object that contains tab group.

IMPORT_C CAknNavigationDecorator* CAknNavigationControlContainer::CreateTabGroupL

(

MAknTabObserver *

aObserver

)

Creates and returns a new navigation decorator object containing tab group.

The ownership of the object is transferred to the application.

Parameters:

aObserver

Pointer to tab group observer

Returns:: Navigation decorator object that contains tab group.

IMPORT_C CAknNavigationDecorator* CAknNavigationControlContainer::CreateTabGroupL ( ) [virtual]

Creates and returns a new navigation decorator object containing tab group.

The ownership of the object is transferred to the application.

Returns:: Navigation decorator object that contains tab group.

Implements MAknNavigationContainerInterface.

IMPORT_C CAknNavigationDecorator* CAknNavigationControlContainer::CreateVolumeIndicatorL

(

TInt

aResourceId

)

Creates volume control indicator to the navi pane.

The ownership of the object is transferred to the application.

Parameters:

aResourceId

Resource file id for the volume control

Returns:: Navigation decorator object that contains volume indicator.

static TInt CAknNavigationControlContainer::CurrentNaviWipeBitmap ( ) [static]

Gets current wipe bitmap for navi pane.

Returns:: Wipe bitmap Id

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

From MCoeControlObserver.

Handles Control event.

Parameters:

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

IMPORT_C void CAknNavigationControlContainer::HandlePointerEventL

(

const TPointerEvent &

aPointerEvent

)

From CCoeControl.

Handles pointer events

Parameters:

aPointerEvent

The pointer event.

virtual IMPORT_C void CAknNavigationControlContainer::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.

Parameters:

aType

Event type.

TTypeUid::Ptr CAknNavigationControlContainer::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.

Parameters:

aId

An encapsulated object type ID.

Returns:: Encapsulated pointer to the provided object. Note that the encapsulated pointer may be NULL.

CFbsBitmap& CAknNavigationControlContainer::NaviArrowBitmap

(

TInt

aId

)

This non-exported method returns reference to navi arrow bitmaps.

Parameters:

aId

Id of the bitmap.

Returns:: Reference to the navi arrow bitmap.

CFbsBitmap* CAknNavigationControlContainer::NaviColorBitmap

(

)

const

Gets navi bitmap.

Returns:: Bitmap's colour.

TBool CAknNavigationControlContainer::NaviWipeUsed

(

)

const

Not used / implemented.

Deprecated:

Returns:: EFalse

void CAknNavigationControlContainer::NotifyNaviWipeStatusL

(

)

Used by the UI framework.

Notifies context and signal panes wheter navi wipe graphichs is to be drawn or not.

IMPORT_C void CAknNavigationControlContainer::Pop

(

CAknNavigationDecorator *

aControl

)

Pops (remove) certain object from the navigation pane's object stack.

The removed object does not need to be topmost.

Parameters:

aControl

Object to be removed from the stack.

IMPORT_C void CAknNavigationControlContainer::Pop ( ) [virtual]

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.

Implements MAknNavigationContainerInterface.

IMPORT_C void CAknNavigationControlContainer::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.

Parameters:

aAllowDuplicates If this is ETrue, duplicate default navi pane contents are allowed.

IMPORT_C void CAknNavigationControlContainer::PushL ( CAknNavigationDecorator & aNaviPaneControl ) [virtual]

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.

Parameters:

aNaviPaneControl

Object to be added at the top of the stack.

Implements MAknNavigationContainerInterface.

IMPORT_C TInt CAknNavigationControlContainer::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.

Parameters:

	aToBeReplaced	An object to be replaced.
	aReplacement	An object that is put to the stack instead.

Returns:: Error number. KErrNone if the operation succeeds. KErrNotFound if 'aToBeReplaced' object cannot be found from the stack.

IMPORT_C CAknNavigationDecorator* CAknNavigationControlContainer::ResourceDecorator

(

)

Returns the object constructed from resources with ConstrucFromResourcesL() -method to the application.

Ownership of the object is transferred to the application.

Returns:: Navigation Decorator object that was created from resources.

static void CAknNavigationControlContainer::SetBackgroundContextAttributes	(	CCoeControl *	aControl,
		TBool	aNaviWipeUsed
	)	`[static]`

Not used / implemented.

Deprecated:

IMPORT_C void CAknNavigationControlContainer::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.

Parameters:

aLayoutStyle

CAknNavigationDecorator::ENaviControlLayoutNormal, CAknNavigationDecorator::ENaviControlLayoutNarrow or CAknNavigationDecorator::ENaviControlLayoutWide

virtual IMPORT_C void CAknNavigationControlContainer::SizeChanged ( ) [protected, virtual]

From CCoeControl.

Handles the size change events.

IMPORT_C CAknNavigationDecorator* CAknNavigationControlContainer::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.

Parameters:

aIgnoreFepEditorIndicator

Tells if editor indicator object is ignored.

Returns:: Navigation decorator object that is topmost in navigation pane's object stack.

IMPORT_C CAknNavigationDecorator* CAknNavigationControlContainer::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.

Returns:: Navigation decorator object that is topmost in navigation pane's object stack.

Field Documentation

DECLARE_TYPE_ID ( 0x101F8740 ) public IMPORT_ CAknNavigationControlContainer::~CAknNavigationControlContainer)()

Destructor.

This object does not own the contents of the navi pane controls stack.

The documentation for this class was generated from the following file:

aknnavi.h

CAknNavigationControlContainer Class Reference

Capability Information

Detailed Description

Public Member Functions

Static Public Member Functions

Data Fields

Protected Member Functions

Member Function Documentation

Field Documentation