Collapse all Symbian^3 Application Developer Library

MCoeView Class Reference

class MCoeView

Specifies an interface for views.

This class should be implemented by all application views.

Public Member Functions
TVwsViewId	ViewId ()

Protected Member Functions
	MCoeView ()
IMPORT_C TVwsViewIdAndMessage	ViewScreenDeviceChangedL ()
IMPORT_C TBool	ViewScreenModeCompatible ( TInt )

Private Member Functions
IMPORT_C void	MCoeView_Reserved_2 ()
IMPORT_C void	MCoeView_Reserved_3 ()
IMPORT_C void	PrepareForViewActivation ()
void	ViewActivatedL (const TVwsViewId &, TUid , const TDesC8 &)
IMPORT_C void	ViewConstructL ()
void	ViewDeactivated ()

Private Attributes
TInt	iMCoeView_Reserved1

Constructor & Destructor Documentation

MCoeView()

IMPORT_C

MCoeView

(

)

[protected]

Member Functions Documentation

MCoeView_Reserved_2()

IMPORT_C void

MCoeView_Reserved_2

(

)

[private, virtual]

MCoeView_Reserved_3()

IMPORT_C void

MCoeView_Reserved_3

(

)

[private, virtual]

PrepareForViewActivation()

IMPORT_C void

PrepareForViewActivation

(

)

[private, virtual]

Checks whether the view being activated has the preferred screen mode or not. Empty by default.

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

void	ViewActivatedL	(	const TVwsViewId &	aPrevViewId,
			TUid	aCustomMessageId,
			const TDesC8 &	aCustomMessage
		)	[private, pure virtual]

Takes any action required when a view is activated. Reimplemented versions should read the contents of aCustomMessage for any message type identified by aCustomMessageId that the view understands.

The ID of the previously active view aPrevViewId is supplied so that the activated view can subsequently switch back to the caller if required.

Parameters

const TVwsViewId & aPrevViewId	The UID of the previously active view.
TUid aCustomMessageId	Message type.
const TDesC8 & aCustomMessage	Message contents.

ViewConstructL()

IMPORT_C void

ViewConstructL

(

)

[private, virtual]

Constructs the view. The view architecture can construct registered views in the background or on first activation. Empty by default.

ViewDeactivated()

void

ViewDeactivated

(

)

[private, pure virtual]

Takes any action that is required following deactivation of the view.

This reduces the work required of the window server.

ViewId()

TVwsViewId

ViewId

(

)

const [pure virtual]

Returns a TVwsViewId uniquely identifying the view.

ViewScreenDeviceChangedL()

IMPORT_C TVwsViewIdAndMessage

ViewScreenDeviceChangedL

(

)

[protected, virtual]

Handles a change to the screen device returning the value of the TVwsViewIdAndMessage object that describes what the view arcitecture should do next. Returns the id of the active view by default.

ViewScreenModeCompatible(TInt)

IMPORT_C TBool

ViewScreenModeCompatible

(

TInt

aScreenMode

)

[protected, virtual]

By default, Views are compatible with all screen modes.

Parameters

TInt aScreenMode

Member Data Documentation

TInt iMCoeView_Reserved1

TInt

iMCoeView_Reserved1

[private]