GG::EventPump Class Reference

encapsulates the GG event-pumping mechanism. More...

#include <EventPump.h>

Inheritance diagram for GG::EventPump:

List of all members.

Public Member Functions
virtual	~EventPump ()
virtual void	operator() ()

---

Detailed Description

encapsulates the GG event-pumping mechanism.

Events from the application framework (i.e. SDL, DirectInput, etc.) are received by an EventPump, and appropriate action is taken. The default action is to call GUI::HandleSystemEvents(), but any action can be taken in a EventPump-derived type that overrides operator()(). For example, it might be useful to override operator()() with a function that gives all GG-relevant events to a GG event-hendler, and gives all other events to a system-specific handler, if your GUI-derived class does not already do so.

Definition at line 74 of file EventPump.h.

---

Constructor & Destructor Documentation

virtual GG::EventPump::~EventPump

(

)

[inline, virtual]

virtual dtor

Definition at line 77 of file EventPump.h.

---

Member Function Documentation

virtual void GG::EventPump::operator()

(

)

[virtual]

cycles through event-handling and rendering, calling GUI::HandleSystemEvents() and then EventPumpBase::LoopBody().

Reimplemented in GG::ModalEventPump.

---

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

• EventPump.h

---