FIFE  2008.0
 All Classes Namespaces Functions Variables Enumerations Enumerator Pages
FIFE::Event Class Reference

#include <ec_event.h>

Inheritance diagram for FIFE::Event:
Inheritance graph
Collaboration diagram for FIFE::Event:
Collaboration graph

Public Member Functions

 Event ()
 
virtual ~Event ()
 
virtual void consume ()
 
virtual bool isConsumed () const
 
virtual IEventSourcegetSource () const
 
virtual void setSource (IEventSource *source)
 
virtual int32_t getTimeStamp () const
 
virtual void setTimeStamp (int32_t 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 ( )
inlinevirtual

Destructor.

Definition at line 60 of file ec_event.h.

Member Function Documentation

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

Marks the event as consumed.

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

Definition at line 64 of file ec_event.h.

Referenced by FIFE::Command::consume(), and FIFE::InputEvent::consume().

Here is the caller graph for this function:

virtual std::string FIFE::Event::getAttrStr ( ) const
inlinevirtual

Gets attribute string of the event

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

Definition at line 96 of file ec_event.h.

Referenced by FIFE::InputEvent::getAttrStr(), and getDebugString().

Here is the caller graph for this function:

virtual std::string FIFE::Event::getDebugString ( ) const
inlinevirtual

Gets the debugstring of the event

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

Definition at line 106 of file ec_event.h.

References getAttrStr(), and getName().

Referenced by FIFE::Command::getDebugString(), and FIFE::InputEvent::getDebugString().

Here is the caller graph for this function:

virtual const std::string& FIFE::Event::getName ( ) const
inlinevirtual

Gets the name of the event

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

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
inlinevirtual

Gets the source of the event.

Definition at line 73 of file ec_event.h.

virtual int32_t FIFE::Event::getTimeStamp ( ) const
inlinevirtual

Gets the timestamp of the event

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

Definition at line 81 of file ec_event.h.

Referenced by FIFE::Command::getTimeStamp(), and FIFE::InputEvent::getTimeStamp().

Here is the caller graph for this function:

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

Checks if the event is consumed.

Returns
true if the event is consumed, false otherwise.

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

Definition at line 69 of file ec_event.h.

Referenced by FIFE::Command::isConsumed(), and FIFE::InputEvent::isConsumed().

Here is the caller graph for this function:

virtual void FIFE::Event::setSource ( IEventSource source)
inlinevirtual

Sets the source of the event.

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

Definition at line 77 of file ec_event.h.

Referenced by FIFE::Command::setSource(), and FIFE::InputEvent::setSource().

Here is the caller graph for this function:

virtual void FIFE::Event::setTimeStamp ( int32_t  timestamp)
inlinevirtual

Sets the timestamp of the event

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

Definition at line 85 of file ec_event.h.

Referenced by FIFE::Command::setTimeStamp(), and FIFE::InputEvent::setTimeStamp().

Here is the caller graph for this function:


The documentation for this class was generated from the following file: