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

Common::EventObserver Class Reference

Object which catches and processes Events. More...

#include <events.h>

Inheritance diagram for Common::EventObserver:

List of all members.

Public Member Functions

virtual ~EventObserver ()
virtual bool notifyEvent (const Event &event)=0
 Notifies the observer of an incoming event.
virtual void notifyPoll ()
 Notifies the observer of pollEvent() query.

Detailed Description

Object which catches and processes Events.

An example for this is the Engine object, it is catching events and processing them.

Definition at line 316 of file events.h.


Constructor & Destructor Documentation

Common::EventObserver::~EventObserver (  )  [virtual]

Definition at line 47 of file events.cpp.


Member Function Documentation

virtual bool Common::EventObserver::notifyEvent ( const Event event  )  [pure virtual]

Notifies the observer of an incoming event.

An observer is supposed to eat the event, with returning true, when it wants to prevent other observers from receiving the event. A usage example here is the keymapper: If it processes an Event, it should 'eat' it and create a new event, which the EventDispatcher will then catch.

Parameters:
event the event, which is incoming.
Returns:
true if the event should not be passed to other observers, false otherwise.

Implemented in DefaultEventManager, ResVmSdlGraphicsManager, Common::InputWatcher, and Common::VirtualMouse.

virtual void Common::EventObserver::notifyPoll (  )  [inline, virtual]

Notifies the observer of pollEvent() query.

Definition at line 338 of file events.h.


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


Generated on Sat Sep 19 2020 05:04:43 for ResidualVM by doxygen 1.7.1
curved edge   curved edge