src/Events/Events_Loop.h

   1 // File:        Events_Loop.hxx
   2 // Created:     Thu Mar 13 2014
   3 // Author:      Mikhail PONIKAROV
   4
   5 #ifndef Events_Loop_HeaderFile
   6 #define Events_Loop_HeaderFile
   7
   8 #include <Events_Message.h>
   9 #include <Events_Listener.h>
  10
  11 #include <map>
  12 #include <list>
  13
  14 /**\class Events_Lopp
  15  * \ingroup EventsLoop
  16  * \brief Base class that manages the receiving and sending of all
  17  * not Qt-events in the application.
  18  *
  19  * One per application, initialized on start. Listeners must register in this loop
  20  * to get events, called by senders. Sending of events is very fast (just adding to container).
  21  * Performing of events is processed in separated thread, so, sender takes
  22  * control back immideately.
  23  */
  24 class Events_Loop {
  25   std::map<char*, std::map<void*, std::list<Events_Listener*> > >
  26     myListeners; ///< map from event ID to sender pointer to listeners that must be called for this
  27
  28   //! The empty constructor, will be called at startup of the application, only once
  29   Events_Loop() {};
  30 public:
  31   ///! Returns the main object of the loop, one per application.
  32   EVENTS_EXPORT static Events_Loop* loop();
  33   //! Returns the unique event by the given name. Call this method only on initialization of object
  34   //! to speedup the events processing without parsing of the string.
  35   EVENTS_EXPORT static Events_ID eventByName(const char* theName);
  36
  37   //! Allows to send an event
  38   EVENTS_EXPORT void send(Events_Message& theMessage);
  39
  40   //! Registers (or adds if such listener is already registered) a listener
  41   //! that will be called on the event and from the defined sender
  42   EVENTS_EXPORT void registerListener(Events_Listener* theListener, const Events_ID theID,
  43     void* theSender = 0);
  44 };
  45
  46 #endif