Class TWsPriorityKeyEvent

TWsEvent

Support

Supported from 5.0

Description

Priority key events.

These events are configured using RWindowGroup::AddPriorityKey(), and obtained by the client using the functions RWsSession::PriorityKeyReady() and RWsSession::GetPriorityKey().

Defined in TWsPriorityKeyEvent:
Handle(), Key(), SetHandle()

inline TKeyEvent* Key() const;

Description

Gets the priority key event.

Return value

TKeyEvent* Structure containing priority key event data

inline TUint Handle() const;

Description

Gets the handle for the window group which added the priority key.

This is the handle that was passed to the window group's Construct() function. Since most applications have only one window group, however, this function is rarely used.

Return value

TUint The window group handle.

inline void SetHandle(TUint aHandle);

Description

Sets the window group event handle.

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

Parameters

TUint aHandle The event handle.