Adonthell  0.4
event_handler_base Class Referenceabstract

This is the base class for actual event handlers. More...

#include <event_handler_base.h>

Inheritance diagram for event_handler_base:

Public Member Functions

virtual ~event_handler_base ()
 Destructor. More...
 
virtual void register_event (event *ev)=0
 Registers an event. More...
 
virtual void remove_event (event *ev)=0
 Unregister an event. More...
 
virtual void raise_event (const event *ev)=0
 Check if an event corresponding to ev exists, and execute it. More...
 

Detailed Description

This is the base class for actual event handlers.

It keeps track of registered scripts, recieves triggered events and executes scripts handling those events

Definition at line 34 of file event_handler_base.h.

Constructor & Destructor Documentation

virtual event_handler_base::~event_handler_base ( )
inlinevirtual

Destructor.

Definition at line 41 of file event_handler_base.h.

Member Function Documentation

virtual void event_handler_base::register_event ( event ev)
pure virtual

Registers an event.

Parameters
evpointer to the event to register.

Implemented in time_event_handler, and map_event_handler.

virtual void event_handler_base::remove_event ( event ev)
pure virtual

Unregister an event.

Parameters
evpointer to the event to unregister.

Implemented in time_event_handler, and map_event_handler.

virtual void event_handler_base::raise_event ( const event ev)
pure virtual

Check if an event corresponding to ev exists, and execute it.

Parameters
evevent to raise.

Implemented in time_event_handler, and map_event_handler.


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