AnCH Framework  0.1
Another C++ Hack Framework
All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Pages
Public Member Functions | List of all members
anch::events::EventHandler< Event, Derived > Class Template Reference

An event handler. More...

#include <eventHandler.hpp>

Inheritance diagram for anch::events::EventHandler< Event, Derived >:
Collaboration diagram for anch::events::EventHandler< Event, Derived >:

Public Member Functions

 EventHandler (const std::function< void(Derived &, const Event &) noexcept > &callbackFunction, bool useEventBus=false)
 
 EventHandler (const std::function< void(Derived &, const Event &) noexcept > &callbackFunction, anch::events::EventBus< Event > &eventBus)
 
virtual ~EventHandler ()
 
virtual void notify (const Event &event) noexcept
 

Detailed Description

template<typename Event, typename Derived>
class anch::events::EventHandler< Event, Derived >

An event handler.

It provides a simple way to inherits several times from Observer and cutomize event receiving method name.

Since
0.1
Author
Vincent Lachenal

Constructor & Destructor Documentation

template<typename Event , typename Derived >
anch::events::EventHandler< Event, Derived >::EventHandler ( const std::function< void(Derived &, const Event &) noexcept > &  callbackFunction,
bool  useEventBus = false 
)
inline

EventHandler constructor.
Register callback method.
Register itself in global EventBus if set.

Parameters
callbackFunctionthe callback method to use on notify
useEventBusif true register itself in global EventBus, false otherwise (default)
template<typename Event , typename Derived >
anch::events::EventHandler< Event, Derived >::EventHandler ( const std::function< void(Derived &, const Event &) noexcept > &  callbackFunction,
anch::events::EventBus< Event > &  eventBus 
)
inline

EventHandler constructor.
Registers callback method.
Register itself in EventBus.

Parameters
callbackFunctionthe callback method to use on notify
eventBusthe EventBus to register itself
template<typename Event , typename Derived >
virtual anch::events::EventHandler< Event, Derived >::~EventHandler ( )
inlinevirtual

EventHandler destructor.
Unregister EventHandler from EventBus if needed.

Member Function Documentation

template<typename Event , typename Derived >
virtual void anch::events::EventHandler< Event, Derived >::notify ( const Event &  event)
inlinevirtualnoexcept

Invokes callback method on receiving event.

Parameters
eventthe event which has been fired

Implements anch::events::Observer< Event >.


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