public

Inheritance Graph

graph BT
	EventContext
	click EventContext "classUtil_1_1UI_1_1EventContext"

Description

Context to store event-related data.

The event context stores an event queue and event state like the currently pressed keys.

Author: Benjamin Eikel

Date: 2012-09-26

Public Functions

   
   
  EventContext()
Create a new event context and associate it with the event queue.
   
EventQueue & getEventQueue()
Access to the associated event queue.
   
bool isKeyPressed( Key key) const
Returntrueif the givenkeyis currently pressed.
   
bool isAltPressed() const
Returntrueif the right or left alt key is pressed.
   
bool isCtrlPressed() const
Returntrueif the right or left control key is pressed.
   
bool isShiftPressed() const
Returntrueif the right or left shift key is pressed.

Documentation

function
Util::UI::EventContext::EventContext

public
   
   
EventContext( )

Create a new event context and associate it with the event queue.

Defined in Util/UI/EventContext.h:41


function
Util::UI::EventContext::getEventQueue

public inline
   
   
EventQueue & getEventQueue( )

Access to the associated event queue.

Defined in Util/UI/EventContext.h:44


function
Util::UI::EventContext::isKeyPressed

public const
     
     
bool isKeyPressed( Key key ) const

Returntrueif the givenkeyis currently pressed.

Defined in Util/UI/EventContext.h:49


function
Util::UI::EventContext::isAltPressed

public const inline
   
   
bool isAltPressed( ) const

Returntrueif the right or left alt key is pressed.

Defined in Util/UI/EventContext.h:52


function
Util::UI::EventContext::isCtrlPressed

public const inline
   
   
bool isCtrlPressed( ) const

Returntrueif the right or left control key is pressed.

Defined in Util/UI/EventContext.h:57


function
Util::UI::EventContext::isShiftPressed

public const inline
   
   
bool isShiftPressed( ) const

Returntrueif the right or left shift key is pressed.

Defined in Util/UI/EventContext.h:62