FIFE  be64c707dea6b3250bd4355bf5c825d25920087d
FIFE::DropEvent Class Reference

Class for drop events. More...

#include <dropevent.h>

+ Inheritance diagram for FIFE::DropEvent:
+ Collaboration diagram for FIFE::DropEvent:

Public Member Functions

 DropEvent ()
 Constructor. More...
 
virtual ~DropEvent ()
 Destructor. More...
 
const std::string & getPath () const
 Gets the path for the file that is droped. More...
 
void setPath (const std::string &path)
 Sets the path for the file that is droped. More...
 
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

std::string m_path
 

Detailed Description

Class for drop events.

Definition at line 43 of file dropevent.h.

Constructor & Destructor Documentation

◆ DropEvent()

FIFE::DropEvent::DropEvent ( )
inline

Constructor.

Definition at line 48 of file dropevent.h.

◆ ~DropEvent()

virtual FIFE::DropEvent::~DropEvent ( )
inlinevirtual

Destructor.

Definition at line 54 of file dropevent.h.

Member Function Documentation

◆ consume()

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

Marks events as consumed.

Reimplemented from FIFE::InputEvent.

Definition at line 66 of file dropevent.h.

References FIFE::InputEvent::consume().

◆ consumedByWidgets()

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

Marks events as consumed by widget library.

Reimplemented from FIFE::InputEvent.

Definition at line 74 of file dropevent.h.

References FIFE::InputEvent::consumedByWidgets().

◆ getDebugString()

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

Gets the debugstring of the event.

Reimplemented from FIFE::InputEvent.

Definition at line 105 of file dropevent.h.

References FIFE::InputEvent::getDebugString().

◆ getName()

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

Gets the name of the event.

Reimplemented from FIFE::InputEvent.

Definition at line 98 of file dropevent.h.

◆ getPath()

const std::string& FIFE::DropEvent::getPath ( ) const
inline

Gets the path for the file that is droped.

Definition at line 58 of file dropevent.h.

References m_path.

◆ getSource()

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

Gets the source of the event.

Reimplemented from FIFE::InputEvent.

Definition at line 82 of file dropevent.h.

References FIFE::InputEvent::getSource().

◆ getTimeStamp()

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

Gets the timestamp of the event.

Reimplemented from FIFE::InputEvent.

Definition at line 90 of file dropevent.h.

References FIFE::InputEvent::getTimeStamp().

◆ isConsumed()

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

Checks whether event is consumed.

Reimplemented from FIFE::InputEvent.

Definition at line 70 of file dropevent.h.

References FIFE::InputEvent::isConsumed().

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

+ Here is the caller graph for this function:

◆ isConsumedByWidgets()

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

Checks whether event is consumed by widget library.

Reimplemented from FIFE::InputEvent.

Definition at line 78 of file dropevent.h.

References FIFE::InputEvent::isConsumedByWidgets().

◆ setPath()

void FIFE::DropEvent::setPath ( const std::string &  path)
inline

Sets the path for the file that is droped.

Definition at line 62 of file dropevent.h.

References m_path.

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

+ Here is the caller graph for this function:

◆ setSource()

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

Sets the source of the event.

Reimplemented from FIFE::InputEvent.

Definition at line 86 of file dropevent.h.

References FIFE::InputEvent::setSource().

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

+ Here is the caller graph for this function:

◆ setTimeStamp()

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

Sets the timestamp of the event.

Reimplemented from FIFE::InputEvent.

Definition at line 94 of file dropevent.h.

References FIFE::InputEvent::setTimeStamp().

Member Data Documentation

◆ m_path

std::string FIFE::DropEvent::m_path
private

Definition at line 108 of file dropevent.h.

Referenced by getPath(), and setPath().


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