TWsPriorityKeyEvent Class Reference

Priority key events. More...

#include <w32std.h>

Public Member Functions
TKeyEvent *	Key () const
	Gets the priority key event.
TUint	Handle () const
	Gets the handle for the window group which added the priority key.
void	SetHandle (TUint aHandle)
	Sets the window group event handle.

Protected Attributes
TUint	iHandle
	WARNING: Member variable for internal use ONLY.
TUint8	iEventData [sizeof(TKeyEvent)]
	WARNING: Member variable for internal use ONLY.

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().

API status

Published to all clients. Released API.

Definition at line 1032 of file w32std.h.

Member Function Documentation

Handle()

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

Definition at line 3135 of file w32std.h.

Key()

TKeyEvent * TWsPriorityKeyEvent::Key ( ) const

inline

Gets the priority key event.

Returns

Structure containing priority key event data

Definition at line 3145 of file w32std.h.

SetHandle()

void TWsPriorityKeyEvent::SetHandle ( TUint  aHandle )

inline

Sets the window group event handle.

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

Parameters

aHandle

The event handle.

Definition at line 3151 of file w32std.h.

Member Data Documentation

iEventData

TUint8 TWsPriorityKeyEvent::iEventData[sizeof(TKeyEvent)]

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 1049 of file w32std.h.

iHandle

TUint TWsPriorityKeyEvent::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 1048 of file w32std.h.

---

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

• w32std.h