Class TWsEvent

class TWsEvent;

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(TWsEvent &). The type of data contained in the TWsEvent depends on the type of event. The client can inquire the event type using TWsEvent::Type()const, and then retrieve the appropriate type of data.

Members

Defined in TWsEvent:

• EWsEventDataSizeThe size of a TPointerEvent.
• ErrorMessage()constGets an error event.
• EventData()constGets information about the event.
• Handle()constGets the window handle.
• Int()constGets the event data as a TInt.
• Key()constGets the key event.
• ModifiersChanged()constGets information about the modifier changed event.
• Pointer()constGets the pointer event.
• SetHandle(TUint)Sets the event handle.
• SetTimeNow()Sets the event time to the current time.
• SetType(TInt)Sets the event type.
• Time()constGets the time when the event occurred.
• Type()constGets the type of event that occurred.
• VisibilityChanged()Gets information about the visibility changed event.
• VisibilityChanged()constGets information about the visibility changed event.
• anonymousEvent data size.

inline TPointerEvent* Pointer() const;

Description

Gets the pointer event.

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

Return value

inline TKeyEvent* Key() const;

Description

Gets the key event.

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

Return value

inline TModifiersChangedEvent* ModifiersChanged() const;

Description

Gets information about the modifier changed event.

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

Return value

inline TWsVisibilityChangedEvent* VisibilityChanged();

Description

Gets information about the visibility changed event.

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

Return value

inline const TWsVisibilityChangedEvent* VisibilityChanged() const;

Description

Gets information about the visibility changed event.

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

Return value

inline TWsErrorMessage* ErrorMessage() const;

Description

Gets an error event.

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

Return value

inline TUint8* EventData() const;

Description

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.

Return value

inline TInt Type() const;

Description

Gets the type of event that occurred.

Return value

inline TUint Handle() const;

Description

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.

Return value

inline TTime Time() const;

Description

Gets the time when the event occurred.

Return value

inline void SetType(TInt aType);

Description

Sets the event type.

Parameters

inline void SetHandle(TUint aHandle);

Description

Sets the event handle.

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

Parameters

inline void SetTimeNow();

Description

Sets the event time to the current time.

inline TInt* Int() const;

Description

Gets the event data as a TInt.

Return value

n/a

Description

Event data size.