Collapse all Symbian^3 Application Developer Library

TVwsViewEvent Class Reference

class TVwsViewEvent

The TVwsViewEvent class encapsulates the attributes of a view server event. These are:

The event type
The view ids of the two views associated with the event
The attributes of any message which can go with the event.

Public Member Functions
	TVwsViewEvent ()
	TVwsViewEvent ( TVwsViewEventType )
	TVwsViewEvent ( TVwsViewEventType , const TVwsViewId &)
	TVwsViewEvent ( TVwsViewEventType , const TVwsViewId &, const TVwsViewId &)
	TVwsViewEvent ( TVwsViewEventType , const TVwsViewId &, const TVwsViewId &, TUid , TInt )

Public Member Enumerations
enum	TVwsViewEventType { EVwsActivateView , EVwsDeactivateView , EVwsScreenDeviceChanged , EVwsDeactivationNotification , EVwsActivationNotification , EVwsDeactivateViewDifferentInstance }

Public Attributes
TUid	iCustomMessageId
TInt	iCustomMessageLength
TVwsViewEventType	iEventType
TVwsViewId	iViewOneId
TVwsViewId	iViewTwoId

Constructor & Destructor Documentation

TVwsViewEvent()

TVwsViewEvent

(

)

[inline]

TVwsViewEvent(TVwsViewEventType)

TVwsViewEvent

(

TVwsViewEventType

aEventType

)

[inline]

Parameters

TVwsViewEventType aEventType

TVwsViewEvent(TVwsViewEventType, const TVwsViewId &)

TVwsViewEvent	(	TVwsViewEventType	aEventType,
		const TVwsViewId &	aViewOneId
	)	[inline]

Parameters

TVwsViewEventType aEventType
const TVwsViewId & aViewOneId

TVwsViewEvent(TVwsViewEventType, const TVwsViewId &, const TVwsViewId &)

TVwsViewEvent	(	TVwsViewEventType	aEventType,
		const TVwsViewId &	aViewOneId,
		const TVwsViewId &	aViewTwoId
	)	[inline]

Parameters

TVwsViewEventType aEventType
const TVwsViewId & aViewOneId
const TVwsViewId & aViewTwoId

TVwsViewEvent(TVwsViewEventType, const TVwsViewId &, const TVwsViewId &, TUid, TInt)

TVwsViewEvent	(	TVwsViewEventType	aEventType,
		const TVwsViewId &	aViewOneId,
		const TVwsViewId &	aViewTwoId,
		TUid	aCustomMessageId,
		TInt	aCustomMessageLength
	)	[inline]

Parameters

TVwsViewEventType aEventType
const TVwsViewId & aViewOneId
const TVwsViewId & aViewTwoId
TUid aCustomMessageId
TInt aCustomMessageLength

Member Enumerations Documentation

Enum TVwsViewEventType

Enumerators

EVwsActivateView
EVwsDeactivateView
EVwsScreenDeviceChanged
EVwsDeactivationNotification
EVwsActivationNotification
EVwsDeactivateViewDifferentInstance

Member Data Documentation

TUid iCustomMessageId

TUid	iCustomMessageId

The type of message being passed in the custom message buffer

TInt iCustomMessageLength

TInt	iCustomMessageLength

The length of the custom message being held by the server. To retrieve the message itself from the server, a buffer of this length must be allocated

TVwsViewEventType iEventType

TVwsViewEventType

iEventType

The event type.

TVwsViewId iViewOneId

TVwsViewId

iViewOneId

The first view id associated with the event. This has a different meaning for each of the event types:

For ActivateView events, it is the view to activate
For DeactivateView events, it is the view to deactivate
For ScreenDeviceChange events, it is the id of the currently active view
For ActivationNotification events, it is the id of the activated view
For DeactivationNotification events, it is the id of the deactivated view

TVwsViewId iViewTwoId

TVwsViewId

iViewTwoId

The second view id associated with the event. This has a different meaning for each of the event types:

For ActivateView events, it is the view that will be deactivated
For DeactivateView events, it is the view that has been activated
For ScreenDeviceChange events, it is unused
For ActivationNotification events, it is the view that will be deactivated
For DeactivationNotification events, it is the id of the view that has been activated