FIFE 2008.0
FIFE::KeyEvent Class Reference

#include <ec_keyevent.h>

Inheritance diagram for FIFE::KeyEvent:
Collaboration diagram for FIFE::KeyEvent:

List of all members.

Public Member Functions

 KeyEvent ()
virtual ~KeyEvent ()
virtual bool isAltPressed () const
virtual bool isControlPressed () const
virtual bool isMetaPressed () const
virtual bool isShiftPressed () const
virtual void consume ()
virtual bool isConsumed () const
virtual void consumedByWidgets ()
virtual void setSource (IEventSource *source)
virtual int getTimeStamp () const
virtual void setTimeStamp (int timestamp)
virtual const std::string & getName () const
virtual std::string getDebugString () const

Detailed Description

Class for key events

Definition at line 45 of file ec_keyevent.h.


Constructor & Destructor Documentation

FIFE::KeyEvent::KeyEvent ( ) [inline]

Constructor

Definition at line 55 of file ec_keyevent.h.

virtual FIFE::KeyEvent::~KeyEvent ( ) [inline, virtual]

Destructor.

Definition at line 63 of file ec_keyevent.h.


Member Function Documentation

virtual void FIFE::KeyEvent::consume ( ) [inline, virtual]

Marks the event as consumed.

Reimplemented from FIFE::InputEvent.

Definition at line 83 of file ec_keyevent.h.

virtual void FIFE::KeyEvent::consumedByWidgets ( ) [inline, virtual]

Marks events as consumed by widget library.

Reimplemented from FIFE::InputEvent.

Definition at line 85 of file ec_keyevent.h.

virtual std::string FIFE::KeyEvent::getDebugString ( ) const [inline, virtual]

Gets the debugstring of the event

Reimplemented from FIFE::InputEvent.

Definition at line 96 of file ec_keyevent.h.

virtual const std::string& FIFE::KeyEvent::getName ( ) const [inline, virtual]

Gets the name of the event

Reimplemented from FIFE::InputEvent.

Definition at line 92 of file ec_keyevent.h.

virtual int FIFE::KeyEvent::getTimeStamp ( ) const [inline, virtual]

Gets the timestamp of the event

Reimplemented from FIFE::InputEvent.

Definition at line 89 of file ec_keyevent.h.

virtual bool FIFE::KeyEvent::isAltPressed ( ) const [inline, virtual]

Checks whether alt is pressed.

Reimplemented from FIFE::InputEvent.

Definition at line 74 of file ec_keyevent.h.

virtual bool FIFE::KeyEvent::isConsumed ( ) const [inline, virtual]

Checks if the event is consumed.

Returns:
true if the event is consumed, false otherwise.

Reimplemented from FIFE::InputEvent.

Definition at line 84 of file ec_keyevent.h.

virtual bool FIFE::KeyEvent::isControlPressed ( ) const [inline, virtual]

Checks whether control is pressed.

Reimplemented from FIFE::InputEvent.

Definition at line 76 of file ec_keyevent.h.

virtual bool FIFE::KeyEvent::isMetaPressed ( ) const [inline, virtual]

Checks whether meta is pressed.

Reimplemented from FIFE::InputEvent.

Definition at line 78 of file ec_keyevent.h.

virtual bool FIFE::KeyEvent::isShiftPressed ( ) const [inline, virtual]

Checks whether shift is pressed.

Reimplemented from FIFE::InputEvent.

Definition at line 80 of file ec_keyevent.h.

virtual void FIFE::KeyEvent::setSource ( IEventSource source) [inline, virtual]

Sets the source of the event.

Reimplemented from FIFE::InputEvent.

Definition at line 88 of file ec_keyevent.h.

virtual void FIFE::KeyEvent::setTimeStamp ( int  timestamp) [inline, virtual]

Sets the timestamp of the event

Reimplemented from FIFE::InputEvent.

Definition at line 90 of file ec_keyevent.h.


The documentation for this class was generated from the following file:
 All Classes Namespaces Functions Variables Enumerations Enumerator