CGUIEvent Class Reference

Base class for Guiliani Events. More...

#include <GUIEvent.h>

Inheritance diagram for CGUIEvent:

Public Types
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 }

Public Member Functions
	CGUIEvent (EventType_t eType, eC_UInt uiModifiers)
virtual	~CGUIEvent ()
	Destructor.
EventSource_t	GetEventSource () const
eC_UInt	GetModifiers () const
EventType_t	GetType () const

Detailed Description

Base class for Guiliani Events.

Guiliani abstracts user input through the use of an internal platform-independent event system. The CGUIEvent class is the base class from which all specific events are derived. This ensures that every event which is delivered to the event handler has got an event type (EventType_t) and a get method (CGUIEvent::GetType) to access it, so that the event handler is able to safely identify and handle it.

Member Enumeration Documentation

enum CGUIEvent::EventSource_t

Specifies the class of an event (keyboard, mouse).

Enumerator
ES_NONE	Class of event unknown.
ES_KEYBOARD	Class of event is keyboard event.
ES_MOUSE	Class of event is mous event.

enum CGUIEvent::Modifier_t

The modifier keys that are supported by Guiliani, but not necessarily by each CGUIInputMedia implementation.

Enumerator
GKM_NONE	No Modifier.
GKM_SHIFT	Shift key.
GKM_CONTROL	Control key.
GKM_ALT	Alt key.
GKM_META	Additional modifier, depends on CGUIInputMedia implementation.

Constructor & Destructor Documentation

CGUIEvent::CGUIEvent ( EventType_t  eType, eC_UInt  uiModifiers  )

inline

Constructs a CGUIEvent object.

Parameters

eType	The type of event.
uiModifiers	Logical OR combination of Modifier_t values that represent the modifier keys that were pressed when the event occurred.

Member Function Documentation

EventSource_t CGUIEvent::GetEventSource ( ) const

inline

Returns the source of the event (Mouse, Keyboard or neither of them).

Returns

Enum representing the source.

eC_UInt CGUIEvent::GetModifiers ( ) const

inline

Returns the modifier keys that were pressed when the event occurred.

Returns

Logical OR combination of Modifier_t values.

EventType_t CGUIEvent::GetType ( ) const

inline

Get the type of the event.

Returns

The type of the derived event.

---

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

• GUIEvent.h