Collapse all Symbian^3 Product Developer Library

CAknView Class Reference

class CAknView : public CBase

This is an abstract base class for a Series 60 application view.

Since: Series 60 0.9

Inherits from

CAknView
- CBase

Nested Classes and Structures

CAknView::SAknViewInfo

Public Member Functions
	CAknView()
	~CAknView()
IMPORT_C void	ActivateViewL(const TVwsViewId &)
IMPORT_C void	ActivateViewL(const TVwsViewId &, TUid, const TDesC8 &)
IMPORT_C void	AknViewActivatedL(const TVwsViewId &, TUid, const TDesC8 &)
void	AknViewDeactivated()
IMPORT_C void	BaseConstructL(TInt)
IMPORT_C TRect	ClientRect()
IMPORT_C void	ConstructMenuAndCbaEarlyL()
IMPORT_C void	CreateAndSetToolbarL(TInt)
IMPORT_C void	HandleCommandL(TInt)
IMPORT_C void	HandleStatusPaneSizeChange()
IMPORT_C void	HandleViewRectChange()
IMPORT_C TUid	Id()
IMPORT_C TBool	IsForeground()
IMPORT_C CEikMenuBar *	MenuBar()
IMPORT_C void	ProcessCommandL(TInt)
void	ProcessForegroundEventL(TBool)
IMPORT_C void	Redraw()
void	SaveToolbarStatus(TBool, TBool)
IMPORT_C void	SetToolbar(CAknToolbar *)
IMPORT_C void	ShowToolbarOnViewActivation(TBool)
IMPORT_C void	StopDisplayingMenuBar()
IMPORT_C void	StopDisplayingToolbar()
IMPORT_C CAknToolbar *	Toolbar()
IMPORT_C TBool	ToolbarShownOnViewActivation()
IMPORT_C TVwsViewId	ViewId()

Protected Member Functions
IMPORT_C CAknViewAppUi *	AppUi()
IMPORT_C CEikButtonGroupContainer *	Cba()
IMPORT_C void	DoActivateL(const TVwsViewId &, TUid, const TDesC8 &)
void	DoDeactivate()
IMPORT_C void	HandleForegroundEventL(TBool)
IMPORT_C MObjectProvider *	MopNext()
IMPORT_C TTypeUid::Ptr	MopSupplyObject(TTypeUid)
IMPORT_C void	SetEmphasis(CCoeControl *, TBool)
IMPORT_C CEikStatusPane *	StatusPane()
IMPORT_C void	ViewActivatedL(const TVwsViewId &, TUid, const TDesC8 &)
IMPORT_C void	ViewDeactivated()
IMPORT_C TVwsViewIdAndMessage	ViewScreenDeviceChangedL()

Private Member Functions
void	ConstructMenuAndCbaL(TBool)
CAknViewExtension *	Extension()
IMPORT_C void	Reserved_MtsmObject()
IMPORT_C void	Reserved_MtsmPosition()

Inherited Functions
	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()

Protected Attributes
CCoeEnv *	iCoeEnv

Private Attributes
CAknViewAppUi *	iAppUi
CEikButtonGroupContainer *	iCba
CAknViewExtension *	iExtension
TBitFlags	iFlags
CEikMenuBar *	iMenu
SAknViewInfo	iViewInfo

Constructor & Destructor Documentation

CAknView()

IMPORT_C

CAknView

(

)

Standard constructor.

~CAknView()

IMPORT_C

~CAknView

(

)

Standard destructor.

Member Functions Documentation

ActivateViewL(const TVwsViewId &)

IMPORT_C void

ActivateViewL

(

const TVwsViewId &

aViewId

)

Activate any view in the product. Calls CCoeAppUi::ActivateViewL( aViewId)

Parameters

const TVwsViewId & aViewId

Identifies the view to activate.

ActivateViewL(const TVwsViewId &, TUid, const TDesC8 &)

IMPORT_C void	ActivateViewL	(	const TVwsViewId &	aViewId,
			TUid	aCustomMessageId,
			const TDesC8 &	aCustomMessage
		)

Activate any view, then passes the message text aCustomMessage of type aCustomMessageId. Calls CCoeAppUi::ActivateViewL( aViewId,aCustomMessageId,aCustomMessage)

Parameters

const TVwsViewId & aViewId	Identifies the view to activate.
TUid aCustomMessageId	Specifies the message type.
const TDesC8 & aCustomMessage	The message passed to the activated view.

AknViewActivatedL(const TVwsViewId &, TUid, const TDesC8 &)

IMPORT_C void	AknViewActivatedL	(	const TVwsViewId &	aPrevViewId,
			TUid	aCustomMessageId,
			const TDesC8 &	aCustomMessage
		)	[virtual]

Avkon view architecture system. Internal use only. Calls DoActivateL.

Parameters

const TVwsViewId & aPrevViewId
TUid aCustomMessageId
const TDesC8 & aCustomMessage

AknViewDeactivated()

void

AknViewDeactivated

(

)

Avkon view architecture system. Internal use only. Function is called by CAknViewAppUi::~CAknViewAppUi() for immediate view deactivation. Calls DoDeactivate.

AppUi()

IMPORT_C CAknViewAppUi *

AppUi

(

)

const [protected]

Accessor for the applications user interface as a CAknViewAppUi.

BaseConstructL(TInt)

IMPORT_C void

BaseConstructL

(

TInt

aResId = 0

)

This is a second stage constructor initializing this view with standard values. Should be called from derived classes second stage construction functions.

Parameters

TInt aResId = 0

The numeric ID of the resource (iViewInfo) to be read. If aResId=0, resource file is not accessed.

Cba()

IMPORT_C CEikButtonGroupContainer *

Cba

(

)

const [protected]

Button group container (=CBA) accessor method. This returns the views CBA if there is one, and the applications user interfaces CBA otherwise.

ClientRect()

IMPORT_C TRect

ClientRect

(

)

const

Calculates the client rectangle of the view, taking the applications client rectangle and the views CBA into account. Calls CEikAppUi::ClientRect()

ConstructMenuAndCbaEarlyL()

IMPORT_C void

ConstructMenuAndCbaEarlyL

(

)

Constructs invisible button group container and menu if they don't exist yet. They are placed on the view stack. To be used by views which need to access the menu or cba before the view is activated for the first time.

ConstructMenuAndCbaL(TBool)

void

ConstructMenuAndCbaL

(

TBool

aVisible

)

[private]

Parameters

TBool aVisible

CreateAndSetToolbarL(TInt)

IMPORT_C void

CreateAndSetToolbarL

(

TInt

aResourceId

)

Creates a new toolbar object with the resource id given and sets it for the view. Deletes old toolbar. If the old toolbar was shown before deleting, then the new toolbar will also be shown.

Since: S60 5.0

Parameters

TInt aResourceId

Resource id of the new toolbar

DoActivateL(const TVwsViewId &, TUid, const TDesC8 &)

IMPORT_C void	DoActivateL	(	const TVwsViewId &	aPrevViewId,
			TUid	aCustomMessageId,
			const TDesC8 &	aCustomMessage
		)	[protected, pure virtual]

Handles a view activation and passes the message of type aCustomMessageId. This function is intended for overriding by sub classes. This function is called by AknViewActivatedL(). Views should not launch waiting or modal notes or dialogs in DoActivateL.

Parameters

const TVwsViewId & aPrevViewId	Specifies the view previously active.
TUid aCustomMessageId	Specifies the message type.
const TDesC8 & aCustomMessage	The activation message.

DoDeactivate()

void

DoDeactivate

(

)

[protected, pure virtual]

View deactivation function intended for overriding by sub classes. This function is called by AknViewDeactivated().

Extension()

CAknViewExtension *

Extension

(

)

const [private]

Asserts that extension class object exists.

HandleCommandL(TInt)

IMPORT_C void

HandleCommandL

(

TInt

aCommand

)

[virtual]

Command handling function intended for overriding by sub classes. Default implementation is empty.

Parameters

TInt aCommand

ID of the command to respond to.

HandleForegroundEventL(TBool)

IMPORT_C void

HandleForegroundEventL

(

TBool

aForeground

)

[protected, virtual]

From MEikMenuObserver. Foreground event handling function intended for overriding by sub classes.

Parameters

TBool aForeground

Indicates the required focus state of the control.

HandleStatusPaneSizeChange()

IMPORT_C void

HandleStatusPaneSizeChange

(

)

[virtual]

Event handler for status pane size changes. CAknView provides an empty implementation for sub classes that do not want to handle this event.

HandleViewRectChange()

IMPORT_C void

HandleViewRectChange

(

)

[virtual]

Called by the framework when view's rectangle changes. The default implementation is empty. This function is not used yet.

Since: Series 60 3.0

Id()

IMPORT_C TUid

(

)

const [pure virtual]

Returns views id, intended for overriding by sub classes.

IsForeground()

IMPORT_C TBool

IsForeground

(

)

const

Determines whether the application is foreground.

MenuBar()

IMPORT_C CEikMenuBar *

MenuBar

(

)

const [virtual]

Menu bar accessor method. This returns the views menu if available, otherwise it returns the applications menu bar.

MopNext()

IMPORT_C MObjectProvider *

MopNext

(

)

[protected]

From MObjectProvider. Gets the parent object provider.

MopSupplyObject(TTypeUid)

IMPORT_C TTypeUid::Ptr

MopSupplyObject

(

TTypeUid

aId

)

[protected]

From MObjectProvider. Gets an (MAknsControlContext) object whose type is encapsulated by the specified TTypeUid object. Calls SupplyMopObject( TTypeUid aId, CEikButtonGroupContainer* iCba, CEikMenuBar* iMenu ).

Parameters

TTypeUid aId

Encapsulates the Uid that identifies the type of object required.

ProcessCommandL(TInt)

IMPORT_C void

ProcessCommandL

(

TInt

aCommand

)

[virtual]

From MEikMenuObserver. This function processes user commands by handling aCommand values EAknSoftkeyOptions, EAknCmdExit, EEikCmdCanceled and passing the others to HandleCommandL() for sub class to decide the actions.

Parameters

TInt aCommand

ID of the command to respond to.

ProcessForegroundEventL(TBool)

void

ProcessForegroundEventL

(

TBool

aForeground

)

Avkon view architecture system. Internal use only.

Parameters

TBool aForeground

Redraw()

IMPORT_C void

Redraw

(

)

const [virtual]

Asks the view to redraw its area. Needs to be implemented only by views used in split view architecture. The default implementation is empty. This function is not used yet.

Since: Series 60 3.0

Reserved_MtsmObject()

IMPORT_C void

Reserved_MtsmObject

(

)

[private, virtual]

Reserved_MtsmPosition()

IMPORT_C void

Reserved_MtsmPosition

(

)

[private, virtual]

SaveToolbarStatus(TBool, TBool)

void	SaveToolbarStatus	(	TBool	aVisible,
			TBool	aFocused
		)

Saves toolbar status of this view according to values given. The values are used when view is activated.

Since: S60 3.2

Parameters

TBool aVisible	to determine if toolbar should be shown.
TBool aFocused	ETrue if toolbar is focused, EFalse if not

SetEmphasis(CCoeControl *, TBool)

IMPORT_C void	SetEmphasis	(	CCoeControl *	aMenuControl,
			TBool	aEmphasis
		)	[protected, virtual]

From MEikMenuObserver. Menu emphasising or de-emphasising function. CEikMenuBar objects call this on their observer. Updates the value of the flags for the (aMenuControl) on the control stack.

Parameters

CCoeControl * aMenuControl	The control to be emphasised or de-emphasisied.
TBool aEmphasis	ETrue to emphasize the menu, EFalse to refuse the focus.

SetToolbar(CAknToolbar *)

IMPORT_C void

SetToolbar

(

CAknToolbar *

aToolbar

)

Sets new toolbar for the view. Deletes old toolbar. If the old toolbar was shown before deleting, then the new toolbar will also be shown.

Since: S60 5.0

Parameters

CAknToolbar * aToolbar

pointer to new toolbar

ShowToolbarOnViewActivation(TBool)

IMPORT_C void

ShowToolbarOnViewActivation

(

TBool

aVisible

)

Sets toolbar visibility status of this view according to value given. The value is used when view is activated.

Since: S60 3.2

Parameters

TBool aVisible

to determine if toolbar should be shown.

StatusPane()

IMPORT_C CEikStatusPane *

StatusPane

(

)

const [protected]

Status pane accessor method.

StopDisplayingMenuBar()

IMPORT_C void

StopDisplayingMenuBar

(

)

This function causes the menu bar to disappear from the screen until it is invoked again by the user. Calls CEikAppUi::StopDisplayingMenuBar().

StopDisplayingToolbar()

IMPORT_C void

StopDisplayingToolbar

(

)

This function causes toolbar to be hidden

Since: Series 60 3.1

Toolbar()

IMPORT_C CAknToolbar *

Toolbar

(

)

const

Since: Series 60 3.1

ToolbarShownOnViewActivation()

IMPORT_C TBool

ToolbarShownOnViewActivation

(

)

const

Determines if the toolbar of this view is shown when the view is activated.

Since: S60 3.2

ViewActivatedL(const TVwsViewId &, TUid, const TDesC8 &)

IMPORT_C void	ViewActivatedL	(	const TVwsViewId &	aPrevViewId,
			TUid	aCustomMessageId,
			const TDesC8 &	aCustomMessage
		)	[protected]

From MCoeView. Takes any action required when this view is activated. Handles this view activation event from view server. Calls CAknViewAppUi::ViewActivatedL()

Parameters

const TVwsViewId & aPrevViewId	Specifies the view previously active.
TUid aCustomMessageId	Specifies the message type.
const TDesC8 & aCustomMessage	Activation message.

ViewDeactivated()

IMPORT_C void

ViewDeactivated

(

)

[protected]

From MCoeView. Takes any action that is required following deactivation of this view. Handles this view deactivation event from viewserver. Calls CAknViewAppUi::ViewDeactivated()

ViewId()

IMPORT_C TVwsViewId

ViewId

(

)

const

From MCoeView. The full view Id for this view. Calls Id()

ViewScreenDeviceChangedL()

IMPORT_C TVwsViewIdAndMessage

ViewScreenDeviceChangedL

(

)

[protected]

From MCoeView. Screen device changed function from viewserver.

Member Data Documentation

CAknViewAppUi * iAppUi

CAknViewAppUi *

iAppUi

[private]

CEikButtonGroupContainer * iCba

CEikButtonGroupContainer *

iCba

[private]

CCoeEnv * iCoeEnv

CCoeEnv *

iCoeEnv

[protected]

CAknViewExtension * iExtension

CAknViewExtension *

iExtension

[private]

TBitFlags iFlags

TBitFlags

iFlags

[private]

CEikMenuBar * iMenu

CEikMenuBar *

iMenu

[private]

SAknViewInfo iViewInfo

SAknViewInfo

iViewInfo

[private]