FIFE::InputEvent Class Reference

#include <ec_inputevent.h>

Inheritance diagram for FIFE::InputEvent:

Collaboration diagram for FIFE::InputEvent:

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 int32_t	getTimeStamp () const
virtual void	setTimeStamp (int32_t 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.

References FIFE::Event::consume().

Referenced by FIFE::KeyEvent::consume(), and FIFE::MouseEvent::consume().

Here is the caller graph for this function:

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.

Referenced by FIFE::KeyEvent::consumedByWidgets(), and FIFE::MouseEvent::consumedByWidgets().

Here is the caller graph for this function:

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.

References FIFE::Event::getAttrStr().

Referenced by FIFE::MouseEvent::getAttrStr().

Here is the caller graph for this function:

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.

References FIFE::Event::getDebugString().

Referenced by FIFE::KeyEvent::getDebugString(), and FIFE::MouseEvent::getDebugString().

Here is the caller graph for this function:

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 int32_t 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.

References FIFE::Event::getTimeStamp().

Referenced by FIFE::KeyEvent::getTimeStamp(), and FIFE::MouseEvent::getTimeStamp().

Here is the caller graph for this function:

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.

Referenced by FIFE::KeyEvent::isAltPressed(), and FIFE::MouseEvent::isAltPressed().

Here is the caller graph for this function:

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.

References FIFE::Event::isConsumed().

Referenced by FIFE::KeyEvent::isConsumed(), and FIFE::MouseEvent::isConsumed().

Here is the caller graph for this function:

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.

Referenced by FIFE::KeyEvent::isControlPressed(), and FIFE::MouseEvent::isControlPressed().

Here is the caller graph for this function:

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.

Referenced by FIFE::KeyEvent::isMetaPressed(), and FIFE::MouseEvent::isMetaPressed().

Here is the caller graph for this function:

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.

Referenced by FIFE::KeyEvent::isShiftPressed(), and FIFE::MouseEvent::isShiftPressed().

Here is the caller graph for this function:

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.

References FIFE::Event::setSource().

Referenced by FIFE::KeyEvent::setSource(), and FIFE::MouseEvent::setSource().

Here is the caller graph for this function:

virtual void FIFE::InputEvent::setTimeStamp ( int32_t  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.

References FIFE::Event::setTimeStamp().

Referenced by FIFE::KeyEvent::setTimeStamp(), and FIFE::MouseEvent::setTimeStamp().

Here is the caller graph for this function:

---

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

• engine/core/eventchannel/base/ec_inputevent.h