FIFE::InputEvent Class Reference

#include <ec_inputevent.h>

Inheritance diagram for FIFE::InputEvent:
Inheritance graph
[legend]
Collaboration diagram for FIFE::InputEvent:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 InputEvent ()
 ~InputEvent ()
virtual bool isAltPressed () const
virtual bool isControlPressed () const
virtual bool isMetaPressed () const
virtual bool isShiftPressed () const
virtual void consumedByWidgets ()
virtual void consume ()
virtual bool isConsumed () const
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
virtual std::string getAttrStr () const

Detailed Description

Base class for input events (like mouse and keyboard)

Definition at line 41 of file ec_inputevent.h.


Constructor & Destructor Documentation

FIFE::InputEvent::InputEvent (  )  [inline]

Constructor.

Definition at line 41 of file ec_inputevent.h.

FIFE::InputEvent::~InputEvent (  )  [inline]

Destructor.

Definition at line 51 of file ec_inputevent.h.


Member Function Documentation

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

Marks the event as consumed.

Reimplemented from FIFE::Event.

Reimplemented in FIFE::KeyEvent, and FIFE::MouseEvent.

Definition at line 78 of file ec_inputevent.h.

Referenced by setTimeStamp().

Here is the caller graph for this function:

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

Marks events as consumed by widget library.

Reimplemented in FIFE::KeyEvent, and FIFE::MouseEvent.

Definition at line 75 of file ec_inputevent.h.

virtual std::string FIFE::InputEvent::getAttrStr (  )  const [inline, virtual]

Gets attribute string of the event

Reimplemented from FIFE::Event.

Reimplemented in FIFE::MouseEvent.

Definition at line 91 of file ec_inputevent.h.

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

Gets the debugstring of the event

Reimplemented from FIFE::Event.

Reimplemented in FIFE::KeyEvent, and FIFE::MouseEvent.

Definition at line 89 of file ec_inputevent.h.

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

Gets the name of the event

Reimplemented from FIFE::Event.

Reimplemented in FIFE::KeyEvent, and FIFE::MouseEvent.

Definition at line 85 of file ec_inputevent.h.

References FIFE::Event::getSource().

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

Gets the timestamp of the event

Reimplemented from FIFE::Event.

Reimplemented in FIFE::KeyEvent, and FIFE::MouseEvent.

Definition at line 82 of file ec_inputevent.h.

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

Checks whether alt is pressed.

Reimplemented in FIFE::KeyEvent, and FIFE::MouseEvent.

Definition at line 55 of file ec_inputevent.h.

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

Checks if the event is consumed.

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

Reimplemented from FIFE::Event.

Reimplemented in FIFE::KeyEvent, and FIFE::MouseEvent.

Definition at line 79 of file ec_inputevent.h.

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

Checks whether control is pressed.

Reimplemented in FIFE::KeyEvent, and FIFE::MouseEvent.

Definition at line 60 of file ec_inputevent.h.

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

Checks whether meta is pressed.

Reimplemented in FIFE::KeyEvent, and FIFE::MouseEvent.

Definition at line 65 of file ec_inputevent.h.

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

Checks whether shift is pressed.

Reimplemented in FIFE::KeyEvent, and FIFE::MouseEvent.

Definition at line 70 of file ec_inputevent.h.

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

Sets the source of the event.

Reimplemented from FIFE::Event.

Reimplemented in FIFE::KeyEvent, and FIFE::MouseEvent.

Definition at line 81 of file ec_inputevent.h.

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

Sets the timestamp of the event

Reimplemented from FIFE::Event.

Reimplemented in FIFE::KeyEvent, and FIFE::MouseEvent.

Definition at line 83 of file ec_inputevent.h.

References consume().


The documentation for this class was generated from the following file:
Generated on Wed Nov 23 13:04:52 2011 for FIFE by  doxygen 1.6.3