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

Common::ArtificialEventSource Class Reference

An artificial event source. More...

#include <events.h>

Inheritance diagram for Common::ArtificialEventSource:
Collaboration diagram for Common::ArtificialEventSource:

List of all members.

Public Member Functions

void addEvent (const Event &ev)
bool pollEvent (Event &ev)
 Queries a event from the source.
virtual bool allowMapping () const
 By default an artificial event source prevents its events from being mapped.

Protected Attributes

Queue< Event_artificialEventQueue

Detailed Description

An artificial event source.

This is class is used as an event source, which is made up by client specific events.

Example usage cases for this are the Keymapper or the DefaultEventManager.

Definition at line 238 of file common/events.h.


Member Function Documentation

void Common::ArtificialEventSource::addEvent ( const Event ev  )  [inline]

Definition at line 242 of file common/events.h.

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

By default an artificial event source prevents its events from being mapped.

Reimplemented from Common::EventSource.

Definition at line 259 of file common/events.h.

bool Common::ArtificialEventSource::pollEvent ( Event event  )  [inline, 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.

Implements Common::EventSource.

Definition at line 246 of file common/events.h.


Member Data Documentation


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


Generated on Sat Mar 16 2019 05:05:32 for ResidualVM by doxygen 1.7.1
curved edge   curved edge