Collapse all Symbian^3 Product Developer Library

TWsEvent Class Reference

class TWsEvent

Window server event.

All events generated by the window server, except redraw events and priority key events, are delivered to the client in a TWsEvent. The client obtains the TWsEvent by calling RWsSession::GetEvent(). The type of data contained in the TWsEvent depends on the type of event. The client can inquire the event type using Type(), and then retrieve the appropriate type of data.

Public Member Functions
	TWsEvent()
TWsDisplayChangedEvent *	DisplayChanged()
const TWsDisplayChangedEvent *	DisplayChanged()
TWsErrorMessage *	ErrorMessage()
TUint8 *	EventData()
TUint	Handle()
IMPORT_C void	InitAdvancedPointerEvent(TPointerEvent::TType, TUint, const TPoint3D &, TUint8)
TInt *	Int()
TKeyEvent *	Key()
TModifiersChangedEvent *	ModifiersChanged()
TAdvancedPointerEvent *	Pointer()
void	SetHandle(TUint)
IMPORT_C void	SetPointerNumber(TUint8)
IMPORT_C void	SetPointerZ(TInt)
void	SetTimeNow()
void	SetType(TInt)
TTime	Time()
TInt	Type()
TWsVisibilityChangedEvent *	VisibilityChanged()
const TWsVisibilityChangedEvent *	VisibilityChanged()

Public Member Enumerations
enum	anonymous { EWsEventDataSize = sizeof(TAdvancedPointerEvent) }

Protected Attributes
TUint8	iEventData
TUint	iHandle
TTime	iTime
TInt	iType

Constructor & Destructor Documentation

TWsEvent()

TWsEvent

(

)

[inline]

Constructor. Zero Initialise Data

Member Functions Documentation

DisplayChanged()

TWsDisplayChangedEvent *

DisplayChanged

(

)

[inline]

Gets information about the display changed event.

This function can be used to get information about the display changed event if Type() returns an event of type EEventDisplayChanged.

DisplayChanged()

const TWsDisplayChangedEvent *

DisplayChanged

(

)

const [inline]

Gets information about the display changed event.

This function can be used to get information about the display changed event if Type() returns an event of type EEventDisplayChanged.

ErrorMessage()

TWsErrorMessage *

ErrorMessage

(

)

const [inline]

Gets an error event.

This function can be used to get information about the error event if Type() returns an event of type EEventErrorMessage.

EventData()

TUint8 *

EventData

(

)

const [inline]

Gets information about the event.

This function gives you direct access to the event data as a whole. The event can be a key or pointer event or it could be a new special event that only you and another application know about. You are limited to EWsEventDataSize bytes worth of data.

Handle()

TUint

Handle

(

)

const [inline]

Gets the window handle.

This is the handle that was passed to the window's Construct() function: typically it will be a pointer to the client-side object owning the window, providing access to its member functions.

InitAdvancedPointerEvent(TPointerEvent::TType, TUint, const TPoint3D &, TUint8)

IMPORT_C void	InitAdvancedPointerEvent	(	TPointerEvent::TType	aType,
			TUint	aModifiers,
			const TPoint3D &	aPoint3D,
			TUint8	aPointerNumber
		)

Dummy implementation in order to preserve compatibility with WSERV NGA.

Parameters

TPointerEvent::TType aType
TUint aModifiers
const TPoint3D & aPoint3D
TUint8 aPointerNumber

Int()

TInt *

Int

(

)

const [inline]

Gets the event data as a TInt.

For TWsEvents of type EEventPointerEnter and EEventPointerExit this is the pointer number of the pointer that entered/exited the window. Please note that on platforms that use the older Symbian OS, without multipointer support, pointer number is not initialized for EEventPointerEnter and EEventPointerExit and thus it is random.

If the value of the attribute returned from HALData::EPointerNumberOfPointers is greater than 1, then the system has multipointer support.

HALData::EPointerNumberOfPointers HAL::Get(TAttribute,TInt&)

Key()

TKeyEvent *

Key

(

)

const [inline]

Gets the key event.

This function can be used to get information about the key event if Type() returns an event of type EEventKey, EEventKeyUp or EEventKeyDown.

ModifiersChanged()

TModifiersChangedEvent *

ModifiersChanged

(

)

const [inline]

Gets information about the modifier changed event.

This function can be used to get information about the modifier changed event if Type() returns an event of type EEventModifiersChanged.

Pointer()

TAdvancedPointerEvent *

Pointer

(

)

const [inline]

Gets the pointer event.

This method can be used to get information about the pointer event if Type() returns an event of type EEventPointer or EEventDragDrop.

If the event has been received by the window without advanced pointer events enabled, this method will return a pointer to TPointerEvent with additional fields of TAdvancedPointerEvent being cleared to 0.

TPointerEvent::AdvancedPointerEvent() RWindowBase::EnableAdvancedPointers()

SetHandle(TUint)

void

SetHandle

(

TUint

aHandle

)

[inline]

Sets the event handle.

This is the client handle of the window that is being sent the event.

Parameters

TUint aHandle

The event handle.

SetPointerNumber(TUint8)

IMPORT_C void

SetPointerNumber

(

TUint8

aPointerNumber

)

Dummy implementation in order to preserve compatibility with WSERV NGA.

Parameters

TUint8 aPointerNumber

SetPointerZ(TInt)

IMPORT_C void

SetPointerZ

(

TInt

)

Dummy implementation in order to preserve compatibility with WSERV NGA.

Parameters

TInt aZ

SetTimeNow()

void

SetTimeNow

(

)

[inline]

Sets the event time to the current time.

SetType(TInt)

void

SetType

(

TInt

aType

)

[inline]

Sets the event type.

Parameters

TInt aType

The event type. Event types are defined in TEventCode.

Time()

TTime

Time

(

)

const [inline]

Gets the time when the event occurred.

Type()

TInt

Type

(

)

const [inline]

Gets the type of event that occurred.

VisibilityChanged()

TWsVisibilityChangedEvent *

VisibilityChanged

(

)

[inline]

Gets information about the visibility changed event.

This function can be used to get information about the visibility changed event if Type() returns an event of type EEventWindowVisibilityChanged.

VisibilityChanged()

const TWsVisibilityChangedEvent *

VisibilityChanged

(

)

const [inline]

Gets information about the visibility changed event.

This function can be used to get information about the visibility changed event if Type() returns an event of type EEventWindowVisibilityChanged.

Member Enumerations Documentation

Enum anonymous

Event data size.

Enumerators

EWsEventDataSize = sizeof(TAdvancedPointerEvent)

This is the maximum number of bytes of data that can be returned by EventData(). Note: this value is 32 bytes.

Member Data Documentation

TUint8 iEventData

TUint8

iEventData

[protected]

WARNING: Member variable for internal use ONLY. Compatibility is not guaranteed in future releases. Please access using the provided get/set APIs only.

TUint iHandle

TUint

iHandle

[protected]

WARNING: Member variable for internal use ONLY. Compatibility is not guaranteed in future releases. Please access using the provided get/set APIs only.

TTime iTime

TTime

iTime

[protected]

WARNING: Member variable for internal use ONLY. Compatibility is not guaranteed in future releases. Please access using the provided get/set APIs only.

TInt iType

TInt

iType

[protected]

WARNING: Member variable for internal use ONLY. Compatibility is not guaranteed in future releases. Please access using the provided get/set APIs only.