ResidualVM logo ResidualVM website - Forums - Contact us BuildBot - Doxygen - Wiki curved edge

Common::EventSource Class Reference

A source of Events. More...

#include <events.h>

Inheritance diagram for Common::EventSource:

List of all members.

Public Member Functions

virtual ~EventSource ()
virtual bool pollEvent (Event &event)=0
 Queries a event from the source.
virtual bool allowMapping () const
 Checks whether events from this source are allowed to be mapped.

Detailed Description

A source of Events.

An example for this is OSystem, it provides events created by the system and or user.

Definition at line 213 of file events.h.


Constructor & Destructor Documentation

virtual Common::EventSource::~EventSource (  )  [inline, virtual]

Definition at line 215 of file events.h.


Member Function Documentation

virtual bool Common::EventSource::allowMapping (  )  const [inline, virtual]

Checks whether events from this source are allowed to be mapped.

Possible event sources not allowing mapping are: the event recorder/player and/or the EventManager, which allows user events to be pushed.

By default we allow mapping for every event source.

Reimplemented in Common::ArtificialEventSource.

Definition at line 233 of file events.h.

virtual bool Common::EventSource::pollEvent ( Event event  )  [pure virtual]

Queries a event from the source.

Parameters:
event a reference to the event struct, where the event should be stored.
Returns:
true if an event was polled, false otherwise.

Implemented in Cloud::CloudManager, SdlEventSource, Common::ArtificialEventSource, and Common::OSDMessageQueue.


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


Generated on Sat Nov 16 2019 05:02:44 for ResidualVM by doxygen 1.7.1
curved edge   curved edge