FIFE  6e1afdbeda11afe9ac53e6023a4be96ef88f1dc6
FIFE::TextEvent Class Reference

Class for text events. More...

#include <textevent.h>

+ Inheritance diagram for FIFE::TextEvent:
+ Collaboration diagram for FIFE::TextEvent:

Public Types

Public Member Functions

 TextEvent ()
 Constructor. More...
 
virtual ~TextEvent ()
 Destructor. More...
 
TextEventType getType () const
 
void setType (TextEventType type)
 
const TextgetText () const
 
void setText (const Text &text)
 
virtual void consume ()
 Marks events as consumed. More...
 
virtual bool isConsumed () const
 Checks whether event is consumed. More...
 
virtual void consumedByWidgets ()
 Marks events as consumed by widget library. More...
 
virtual bool isConsumedByWidgets () const
 Checks whether event is consumed by widget library. More...
 
virtual IEventSourcegetSource () const
 Gets the source of the event. More...
 
virtual void setSource (IEventSource *source)
 Sets the source of the event. More...
 
virtual int32_t getTimeStamp () const
 Gets the timestamp of the event. More...
 
virtual void setTimeStamp (int32_t timestamp)
 Sets the timestamp of the event. More...
 
virtual const std::string & getName () const
 Gets the name of the event. More...
 
virtual std::string getDebugString () const
 Gets the debugstring of the event. More...
 
- Public Member Functions inherited from FIFE::InputEvent
 InputEvent ()
 Constructor. More...
 
 ~InputEvent ()
 Destructor. More...
 
virtual bool isAltPressed () const
 Checks whether alt is pressed. More...
 
virtual void setAltPressed (bool pressed)
 Sets alt to pressed. More...
 
virtual bool isControlPressed () const
 Checks whether control is pressed. More...
 
virtual void setControlPressed (bool pressed)
 Sets control to pressed. More...
 
virtual bool isMetaPressed () const
 Checks whether meta is pressed. More...
 
virtual void setMetaPressed (bool pressed)
 Sets meta to pressed. More...
 
virtual bool isShiftPressed () const
 Checks whether shift is pressed. More...
 
virtual void setShiftPressed (bool pressed)
 Sets shift to pressed. More...
 
virtual std::string getAttrStr () const
 Gets attribute string of the event. More...
 
- Public Member Functions inherited from FIFE::Event
 Event ()
 Constructor. More...
 
virtual ~Event ()
 Destructor. More...
 

Private Attributes

TextEventType m_eventType
 
Text m_text
 

Detailed Description

Class for text events.

Definition at line 45 of file textevent.h.

Member Enumeration Documentation

Enumerator
UNKNOWN 
INPUT 
EDIT 

Definition at line 47 of file textevent.h.

Constructor & Destructor Documentation

FIFE::TextEvent::TextEvent ( )
inline

Constructor.

Definition at line 55 of file textevent.h.

virtual FIFE::TextEvent::~TextEvent ( )
inlinevirtual

Destructor.

Definition at line 62 of file textevent.h.

Member Function Documentation

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

Marks events as consumed.

Reimplemented from FIFE::InputEvent.

Definition at line 70 of file textevent.h.

References FIFE::InputEvent::consume().

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

Marks events as consumed by widget library.

Reimplemented from FIFE::InputEvent.

Definition at line 72 of file textevent.h.

References FIFE::InputEvent::consumedByWidgets().

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

Gets the debugstring of the event.

Reimplemented from FIFE::InputEvent.

Definition at line 83 of file textevent.h.

References FIFE::InputEvent::getDebugString().

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

Gets the name of the event.

Reimplemented from FIFE::InputEvent.

Definition at line 79 of file textevent.h.

virtual IEventSource* FIFE::TextEvent::getSource ( ) const
inlinevirtual

Gets the source of the event.

Reimplemented from FIFE::InputEvent.

Definition at line 74 of file textevent.h.

References FIFE::InputEvent::getSource().

const Text& FIFE::TextEvent::getText ( ) const
inline

Definition at line 67 of file textevent.h.

References m_text.

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

Gets the timestamp of the event.

Reimplemented from FIFE::InputEvent.

Definition at line 76 of file textevent.h.

References FIFE::InputEvent::getTimeStamp().

TextEventType FIFE::TextEvent::getType ( ) const
inline

Definition at line 64 of file textevent.h.

References m_eventType.

Referenced by FIFE::EventManager::dispatchTextEvent().

+ Here is the caller graph for this function:

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

Checks whether event is consumed.

Reimplemented from FIFE::InputEvent.

Definition at line 71 of file textevent.h.

References FIFE::InputEvent::isConsumed().

virtual bool FIFE::TextEvent::isConsumedByWidgets ( ) const
inlinevirtual

Checks whether event is consumed by widget library.

Reimplemented from FIFE::InputEvent.

Definition at line 73 of file textevent.h.

References FIFE::InputEvent::isConsumedByWidgets().

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

Sets the source of the event.

Reimplemented from FIFE::InputEvent.

Definition at line 75 of file textevent.h.

References FIFE::InputEvent::setSource().

Referenced by FIFE::EventManager::processTextEvent().

+ Here is the caller graph for this function:

void FIFE::TextEvent::setText ( const Text text)
inline

Definition at line 68 of file textevent.h.

References m_text.

Referenced by FIFE::EventManager::fillTextEvent().

+ Here is the caller graph for this function:

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

Sets the timestamp of the event.

Reimplemented from FIFE::InputEvent.

Definition at line 77 of file textevent.h.

References FIFE::InputEvent::setTimeStamp().

void FIFE::TextEvent::setType ( TextEventType  type)
inline

Definition at line 65 of file textevent.h.

References m_eventType.

Referenced by FIFE::EventManager::fillTextEvent().

+ Here is the caller graph for this function:

Member Data Documentation

TextEventType FIFE::TextEvent::m_eventType
private

Definition at line 86 of file textevent.h.

Referenced by getType(), and setType().

Text FIFE::TextEvent::m_text
private

Definition at line 87 of file textevent.h.

Referenced by getText(), and setText().


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