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

#include <ec_inputevent.h>

Inheritance diagram for FIFE::InputEvent:
Inheritance graph
Collaboration diagram for FIFE::InputEvent:
Collaboration graph

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

Detailed Description

Base class for input events (like mouse and keyboard)

Definition at line 42 of file ec_inputevent.h.

Constructor & Destructor Documentation

FIFE::InputEvent::InputEvent ( )
inline

Constructor.

Definition at line 46 of file ec_inputevent.h.

FIFE::InputEvent::~InputEvent ( )
inline

Destructor.

Definition at line 56 of file ec_inputevent.h.

Member Function Documentation

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

Marks the event as consumed.

Reimplemented from FIFE::Event.

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

Definition at line 83 of file ec_inputevent.h.

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

Marks events as consumed by widget library.

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

Definition at line 80 of file ec_inputevent.h.

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

Gets attribute string of the event

Reimplemented from FIFE::Event.

Reimplemented in FIFE::MouseEvent.

Definition at line 96 of file ec_inputevent.h.

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

Gets the debugstring of the event

Reimplemented from FIFE::Event.

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

Definition at line 94 of file ec_inputevent.h.

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

Gets the name of the event

Reimplemented from FIFE::Event.

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

Definition at line 90 of file ec_inputevent.h.

virtual int FIFE::InputEvent::getTimeStamp ( ) const
inlinevirtual

Gets the timestamp of the event

Reimplemented from FIFE::Event.

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

Definition at line 87 of file ec_inputevent.h.

virtual bool FIFE::InputEvent::isAltPressed ( ) const
inlinevirtual

Checks whether alt is pressed.

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

Definition at line 60 of file ec_inputevent.h.

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

Checks if the event is consumed.

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

Reimplemented from FIFE::Event.

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

Definition at line 84 of file ec_inputevent.h.

virtual bool FIFE::InputEvent::isControlPressed ( ) const
inlinevirtual

Checks whether control is pressed.

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

Definition at line 65 of file ec_inputevent.h.

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

Checks whether meta is pressed.

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

Definition at line 70 of file ec_inputevent.h.

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

Checks whether shift is pressed.

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

Definition at line 75 of file ec_inputevent.h.

virtual void FIFE::InputEvent::setSource ( IEventSource *  source)
inlinevirtual

Sets the source of the event.

Reimplemented from FIFE::Event.

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

Definition at line 86 of file ec_inputevent.h.

virtual void FIFE::InputEvent::setTimeStamp ( int  timestamp)
inlinevirtual

Sets the timestamp of the event

Reimplemented from FIFE::Event.

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

Definition at line 88 of file ec_inputevent.h.

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