FIFE::Event Class Reference

#include <ec_event.h>

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

List of all members.

Public Member Functions

 Event ()
virtual ~Event ()
virtual void consume ()
virtual bool isConsumed () const
virtual IEventSourcegetSource () const
virtual void setSource (IEventSource *source)
virtual int getTimeStamp () const
virtual void setTimeStamp (int timestamp)
virtual const std::string & getName () const
virtual std::string getAttrStr () const
virtual std::string getDebugString () const

Detailed Description

Base class for all events

Definition at line 49 of file ec_event.h.


Constructor & Destructor Documentation

FIFE::Event::Event (  )  [inline]

Constructor.

Definition at line 53 of file ec_event.h.

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

Destructor.

Definition at line 60 of file ec_event.h.


Member Function Documentation

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

Marks the event as consumed.

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

Definition at line 64 of file ec_event.h.

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

Gets attribute string of the event

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

Definition at line 96 of file ec_event.h.

Referenced by getDebugString().

Here is the caller graph for this function:

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

Gets the debugstring of the event

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

Definition at line 106 of file ec_event.h.

References getAttrStr(), and getName().

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

Gets the name of the event

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

Definition at line 89 of file ec_event.h.

Referenced by getDebugString().

Here is the caller graph for this function:

virtual IEventSource* FIFE::Event::getSource (  )  const [inline, virtual]

Gets the source of the event.

Definition at line 73 of file ec_event.h.

Referenced by FIFE::InputEvent::getName().

Here is the caller graph for this function:

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

Gets the timestamp of the event

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

Definition at line 81 of file ec_event.h.

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

Checks if the event is consumed.

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

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

Definition at line 69 of file ec_event.h.

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

Sets the source of the event.

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

Definition at line 77 of file ec_event.h.

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

Sets the timestamp of the event

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

Definition at line 85 of file ec_event.h.


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