FIFE  2008.0
 All Classes Namespaces Functions Variables Enumerations Enumerator Pages
Public Member Functions
FIFE::KeyEvent Class Reference

#include <ec_keyevent.h>

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

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
- Public Member Functions inherited from FIFE::InputEvent
 InputEvent ()
 ~InputEvent ()
virtual std::string getAttrStr () const
- Public Member Functions inherited from FIFE::Event
 Event ()
virtual ~Event ()
virtual IEventSource * getSource () 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 ( )
inlinevirtual

Destructor.

Definition at line 63 of file ec_keyevent.h.

Member Function Documentation

virtual void FIFE::KeyEvent::consume ( )
inlinevirtual

Marks the event as consumed.

Reimplemented from FIFE::InputEvent.

Definition at line 83 of file ec_keyevent.h.

virtual void FIFE::KeyEvent::consumedByWidgets ( )
inlinevirtual

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
inlinevirtual

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
inlinevirtual

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
inlinevirtual

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
inlinevirtual

Checks whether alt is pressed.

Reimplemented from FIFE::InputEvent.

Definition at line 74 of file ec_keyevent.h.

virtual bool FIFE::KeyEvent::isConsumed ( ) const
inlinevirtual

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
inlinevirtual

Checks whether control is pressed.

Reimplemented from FIFE::InputEvent.

Definition at line 76 of file ec_keyevent.h.

virtual bool FIFE::KeyEvent::isMetaPressed ( ) const
inlinevirtual

Checks whether meta is pressed.

Reimplemented from FIFE::InputEvent.

Definition at line 78 of file ec_keyevent.h.

virtual bool FIFE::KeyEvent::isShiftPressed ( ) const
inlinevirtual

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)
inlinevirtual

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)
inlinevirtual

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: