Window server event. More...

#include <w32std.h>

Public Types
enum	{ EWsEventDataSize =sizeof(TAdvancedPointerEvent) }
	Event data size. More...

Public Member Functions
	TWsEvent ()
	Constructor.

TAdvancedPointerEvent *	Pointer () const
	Gets the pointer event.

TKeyEvent *	Key () const
	Gets the key event.

TModifiersChangedEvent *	ModifiersChanged () const
	Gets information about the modifier changed event.

TWsVisibilityChangedEvent *	VisibilityChanged ()
	Gets information about the visibility changed event.

const TWsVisibilityChangedEvent *	VisibilityChanged () const
	Gets information about the visibility changed event.

TWsDisplayChangedEvent *	DisplayChanged ()
	Gets information about the display changed event.

const TWsDisplayChangedEvent *	DisplayChanged () const
	Gets information about the display changed event.

TWsErrorMessage *	ErrorMessage () const
	Gets an error event.

TUint8 *	EventData () const
	Gets information about the event.

TInt	Type () const
	Gets the type of event that occurred.

TUint	Handle () const
	Gets the window handle.

TTime	Time () const
	Gets the time when the event occurred.

void	SetType (TInt aType)
	Sets the event type.

void	SetHandle (TUint aHandle)
	Sets the event handle.

void	SetTimeNow ()
	Sets the event time to the current time.

TInt *	Int () const
	Gets the event data as a TInt.

IMPORT_C void	InitAdvancedPointerEvent (TPointerEvent::TType aType, TUint aModifiers, const TPoint3D &aPoint3D, TUint8 aPointerNumber)
	Dummy implementation in order to preserve compatibility with WSERV NGA.

IMPORT_C void	SetPointerNumber (TUint8 aPointerNumber)
	Dummy implementation in order to preserve compatibility with WSERV NGA.

IMPORT_C void	SetPointerZ (TInt aZ)
	Dummy implementation in order to preserve compatibility with WSERV NGA.

Protected Attributes
TInt	iType
	WARNING: Member variable for internal use ONLY.

TUint	iHandle
	WARNING: Member variable for internal use ONLY.

TTime	iTime
	WARNING: Member variable for internal use ONLY.

TUint8	iEventData [EWsEventDataSize]
	WARNING: Member variable for internal use ONLY.

Detailed Description

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.

API status: Published to all clients. Released API.

Definition at line 1052 of file w32std.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Event data size.

Enumerator

EWsEventDataSize

This is the maximum number of bytes of data that can be returned by EventData().

Note: this value is 32 bytes.

Definition at line 1068 of file w32std.h.

Constructor & Destructor Documentation

◆ TWsEvent()

TWsEvent::TWsEvent ( )

inline

Constructor.

Zero Initialise Data

API status: Published to all clients. Released API.

Definition at line 2861 of file w32std.h.

Member Function Documentation

◆ DisplayChanged() [1/2]

TWsDisplayChangedEvent * TWsEvent::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.

Returns: Structure containing display changed event data

Definition at line 3032 of file w32std.h.

◆ DisplayChanged() [2/2]

const TWsDisplayChangedEvent * TWsEvent::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.

Returns: Structure containing display changed event data

Definition at line 3041 of file w32std.h.

◆ ErrorMessage()

TWsErrorMessage * TWsEvent::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.

Returns: The error event.

Definition at line 3059 of file w32std.h.

◆ EventData()

TUint8 * TWsEvent::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.

Returns: A pointer to the event data.

Definition at line 3068 of file w32std.h.

◆ Handle()

TUint TWsEvent::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.

Returns: The window handle.

Definition at line 3085 of file w32std.h.

◆ InitAdvancedPointerEvent()

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

Dummy implementation in order to preserve compatibility with WSERV NGA.

(generated from Symbian Developer Library)

◆ Int()

TInt * TWsEvent::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.

See also: HALData::EPointerNumberOfPointers; HAL::Get(TAttribute,TInt&)

Definition at line 3119 of file w32std.h.

◆ Key()

TKeyEvent * TWsEvent::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.

Returns: Structure containing key event data

Definition at line 3005 of file w32std.h.

◆ ModifiersChanged()

TModifiersChangedEvent * TWsEvent::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.

Returns: Structure containing modifier changed event data

Definition at line 3050 of file w32std.h.

◆ Pointer()

TAdvancedPointerEvent * TWsEvent::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.

Returns: Structure containing advanced pointer event data.

See also: TPointerEvent::AdvancedPointerEvent(); RWindowBase::EnableAdvancedPointers()

Definition at line 2875 of file w32std.h.

◆ SetHandle()

void TWsEvent::SetHandle ( TUint aHandle )

inline

Sets the event handle.

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

Parameters

aHandle The event handle.

Definition at line 3107 of file w32std.h.

◆ SetPointerNumber()

IMPORT_C void TWsEvent::SetPointerNumber ( TUint8 aPointerNumber )

Dummy implementation in order to preserve compatibility with WSERV NGA.

(generated from Symbian Developer Library)

◆ SetPointerZ()

IMPORT_C void TWsEvent::SetPointerZ ( TInt aZ )

Dummy implementation in order to preserve compatibility with WSERV NGA.

(generated from Symbian Developer Library)

◆ SetTimeNow()

void TWsEvent::SetTimeNow ( )

inline

Sets the event time to the current time.

Definition at line 3115 of file w32std.h.

◆ SetType()

void TWsEvent::SetType ( TInt aType )

inline

Sets the event type.

Parameters

aType The event type. Event types are defined in TEventCode.

Definition at line 3101 of file w32std.h.

◆ Time()

TTime TWsEvent::Time ( ) const

inline

Gets the time when the event occurred.

Returns: The time when the event occurred.

Definition at line 3095 of file w32std.h.

◆ Type()

TInt TWsEvent::Type ( ) const

inline

Gets the type of event that occurred.

Returns: The event type. Event types are defined in TEventCode.

Definition at line 3079 of file w32std.h.

◆ VisibilityChanged() [1/2]

TWsVisibilityChangedEvent * TWsEvent::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.

Returns: Structure containing visibility changed event data

Definition at line 3014 of file w32std.h.

◆ VisibilityChanged() [2/2]

const TWsVisibilityChangedEvent * TWsEvent::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.

Returns: Structure containing visibility changed event data

Definition at line 3023 of file w32std.h.

Member Data Documentation

◆ iEventData

TUint8 TWsEvent::iEventData[EWsEventDataSize]

protected

WARNING: Member variable for internal use ONLY.

Compatibility is not guaranteed in future releases. Please access using the provided get/set APIs only.

Definition at line 1100 of file w32std.h.

◆ iHandle

TUint TWsEvent::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.

Definition at line 1098 of file w32std.h.

◆ iTime

TTime TWsEvent::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.

Definition at line 1099 of file w32std.h.

◆ iType

TInt TWsEvent::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.

Definition at line 1097 of file w32std.h.

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

Public Types

Public Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ TWsEvent()

Member Function Documentation

◆ DisplayChanged() [1/2]

◆ DisplayChanged() [2/2]

◆ ErrorMessage()

◆ EventData()

◆ Handle()

◆ InitAdvancedPointerEvent()

◆ Int()

◆ Key()

◆ ModifiersChanged()

◆ Pointer()

◆ SetHandle()

◆ SetPointerNumber()

◆ SetPointerZ()

◆ SetTimeNow()

◆ SetType()

◆ Time()

◆ Type()

◆ VisibilityChanged() [1/2]

◆ VisibilityChanged() [2/2]

Member Data Documentation

◆ iEventData

◆ iHandle

◆ iTime

◆ iType