1 // File: Events_Loop.hxx
2 // Created: Thu Mar 13 2014
3 // Author: Mikhail PONIKAROV
8 #include <Events_Message.h>
9 #include <Events_Listener.h>
14 class Events_MessageGroup;
18 * \brief Base class that manages the receiving and sending of all
19 * not Qt-events in the application.
21 * One per application, initialized on start. Listeners must register in this loop
22 * to get events, called by senders. Sending of events is very fast (just adding to container).
23 * Performing of events is processed in separated thread, so, sender takes
24 * control back immideately.
28 /// map from event ID to sender pointer to listeners that must be called for this
29 std::map<char*, std::map<void*, std::list<Events_Listener*> > > myListeners;
31 /// map from event ID to listeners which must process message without waiting for flush
32 std::map<char*, Events_Listener*> myImmediateListeners;
34 /// map from event ID to groupped messages (accumulated on flush)
35 std::map<char*, boost::shared_ptr<Events_Message> > myGroups;
37 /// to process flushes or not
40 //! The empty constructor, will be called at startup of the application, only once
41 Events_Loop() : myFlushActive(true) {}
44 ///! Returns the main object of the loop, one per application.
45 EVENTS_EXPORT static Events_Loop* loop();
46 //! Returns the unique event by the given name. Call this method only on initialization of object
47 //! to speedup the events processing without parsing of the string.
48 EVENTS_EXPORT static Events_ID eventByName(const char* theName);
50 //! Allows to send an event
51 //! \param isGroup is true for grouping messages if possible
52 EVENTS_EXPORT void send(const boost::shared_ptr<Events_Message>& theMessage, bool isGroup = true);
54 //! Registers (or adds if such listener is already registered) a listener
55 //! that will be called on the event and from the defined sender
56 EVENTS_EXPORT void registerListener(Events_Listener* theListener, const Events_ID theID,
57 void* theSender = 0, bool theImmediate = false);
59 //! Initializes sending of a group-message by the given ID
60 EVENTS_EXPORT void flush(const Events_ID& theID);
62 //! Allows to disable flushes: needed in synchronization of document mechanism
63 //! (to synchronize all and only then flush create, update, etc in correct order)
64 EVENTS_EXPORT void activateFlushes(const bool theActivate);