TWsPriorityKeyEvent Class Reference

#include <w32std.h>

class TWsPriorityKeyEvent
Protected Attributes
TUint8 iEventData
TUint iHandle
Public Member Functions
TUint Handle()
TKeyEvent *Key()
voidSetHandle(TUint)

Detailed Description

Priority key events.

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

Member Attribute Documentation

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.

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.

Member Function Documentation

Handle ( )

TUint Handle()const [inline]

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.

Returns: The window group handle.

Key ( )

TKeyEvent *Key()const [inline]

Gets the priority key event.

Returns: Structure containing priority key event data

SetHandle ( TUint )

voidSetHandle(TUintaHandle)[inline]

Sets the window group event handle.

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

ParameterDescription
aHandleThe event handle.