GL Studio SCECpp Runtime Library
Public Member Functions | Protected Member Functions | List of all members
GlsEventDispatcher Class Referenceabstract

#include <gls_event.h>

Public Member Functions

 GlsEventDispatcher (void)
 
virtual GlsBool DispatchEvent (GlsEvent &event)=0
 

Protected Member Functions

virtual ~GlsEventDispatcher ()
 

Detailed Description

abstract base class for dispatching events

Invariant
none

Constructor & Destructor Documentation

GlsEventDispatcher::GlsEventDispatcher ( void  )

Constructor - construct an instance

Precondition
none
Postcondition
instance created
virtual GlsEventDispatcher::~GlsEventDispatcher ( )
protectedvirtual

Destructor - shall never be called

Precondition
none
Postcondition
none

Member Function Documentation

virtual GlsBool GlsEventDispatcher::DispatchEvent ( GlsEvent event)
pure virtual

Dispatch the given event (pure virtual)

Parameters
eventevent in question
Returns
GLS_TRUE if event was handled during dispatch else GLS_FALSE
Precondition
event.IsValid()
Postcondition
event is dispatched and handled if return value is GLS_TRUE