Common::EventObserver Class Reference

#include <events.h>

Inheritance diagram for Common::EventObserver:

Public Member Functions
virtual bool	notifyEvent (const Event &event)=0
virtual void	notifyPoll ()

Detailed Description

Object that catches and processes Events.

An example for this is the Engine object - it catches events and processes them.

Member Function Documentation

notifyEvent()

virtual bool Common::EventObserver::notifyEvent ( const Event &  event )

pure virtual

Notify 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 that is incoming.

Return values

true	If the event should not be passed to other observers, false otherwise.

Implemented in SurfaceSdlGraphicsManager, N3DS::OSystem_3DS, AtariGraphicsManager, SdlGraphicsManager, Pegasus::InputDeviceManager, Common::VirtualMouse, OpenGLSdlGraphicsManager, and AtariMixerManager.

notifyPoll()

virtual void Common::EventObserver::notifyPoll ( )

inlinevirtual

Notify the observer of pollEvent() query.

---

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

• common/events.h