CGUIKeyboardEvent Class Reference

Represents platform-independent keyboard events. More...

#include <GUIEvent.h>

Inheritance diagram for CGUIKeyboardEvent:

Public Member Functions
	CGUIKeyboardEvent (EventType_t eType, eC_UInt uiKey, GUIKeyIdentifier_t eKeyIdentifier, eC_UInt uiModifiers=0)
eC_UInt	GetKeyContent () const
GUIKeyIdentifier_t	GetKeyIdentifier () const
Public Member Functions inherited from CGUIEvent
	CGUIEvent (EventType_t eType, eC_UInt uiModifiers)
virtual	~CGUIEvent ()
	Destructor.
EventSource_t	GetEventSource () const
eC_UInt	GetModifiers () const
EventType_t	GetType () const

Additional Inherited Members
Public Types inherited from CGUIEvent
enum	EventSource_t { ES_NONE = 0x00000000 , ES_KEYBOARD , ES_MOUSE }
enum	Modifier_t {   GKM_NONE = 0x00000000 , GKM_SHIFT = 0x00000001 , GKM_CONTROL = 0x00000002 , GKM_ALT = 0x00000004 ,   GKM_META = 0x00000008 }

Detailed Description

Represents platform-independent keyboard events.

Keyboard events expand the functionality of the event base class by adding methods, which return the identifier (declared in GUIKeyIdentifier_t) and the character of the key, which was pressed.

Constructor & Destructor Documentation

CGUIKeyboardEvent()

CGUIKeyboardEvent::CGUIKeyboardEvent ( EventType_t  eType, eC_UInt  uiKey, GUIKeyIdentifier_t  eKeyIdentifier, eC_UInt  uiModifiers = 0  )

inline

Constructs a keyboard event.

Parameters

eType	The event type.
uiKey	Key 'value', usually the pressed key's character code.
eKeyIdentifier	The Guiliani identifier for special keys.
uiModifiers	Logical OR combination of CGUIEvent::Modifier_t values.

Member Function Documentation

GetKeyContent()

eC_UInt CGUIKeyboardEvent::GetKeyContent ( ) const

inline

Get the character code of the key, which was pressed.

Returns

the pressed key's character code.

GetKeyIdentifier()

GUIKeyIdentifier_t CGUIKeyboardEvent::GetKeyIdentifier ( ) const

inline

Get the key, which was pressed.

Returns

the Guiliani special key identifier.

---

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

• GUIEvent.h