SHAPER  9.12.0
Events_Listener.h
1 // Copyright (C) 2014-2023 CEA, EDF
2 //
3 // This library is free software; you can redistribute it and/or
4 // modify it under the terms of the GNU Lesser General Public
5 // License as published by the Free Software Foundation; either
6 // version 2.1 of the License, or (at your option) any later version.
7 //
8 // This library is distributed in the hope that it will be useful,
9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 // Lesser General Public License for more details.
12 //
13 // You should have received a copy of the GNU Lesser General Public
14 // License along with this library; if not, write to the Free Software
15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
16 //
17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
18 //
19 
20 #ifndef Events_Listener_H_
21 #define Events_Listener_H_
22 
23 #include <Events.h>
24 #include <memory>
25 #include <map>
26 
27 class Events_Message;
28 class Events_ID;
29 
39  std::map<char*, std::shared_ptr<Events_Message> > myGroups;
40 
41 public:
42  virtual ~Events_Listener() {}
43 
45  EVENTS_EXPORT virtual void processEvent(const std::shared_ptr<Events_Message>& theMessage) = 0;
46 
50  EVENTS_EXPORT virtual bool groupMessages() {return false;}
51 
52 protected:
54  void groupWhileFlush(const std::shared_ptr<Events_Message>& theMessage);
56  EVENTS_EXPORT void flushGrouped(const Events_ID& theID);
57 
58  friend class Events_Loop;
59 };
60 
61 #endif
Identifier of the event kind.
Definition: Events_Message.h:36
Base interface for any event listener.
Definition: Events_Listener.h:37
virtual EVENTS_EXPORT bool groupMessages()
Listener that needs mostly grouped messages received returns true in this method.
Definition: Events_Listener.h:50
EVENTS_EXPORT void flushGrouped(const Events_ID &theID)
Sends myGroups on flush finish.
Definition: Events_Listener.cpp:42
virtual EVENTS_EXPORT void processEvent(const std::shared_ptr< Events_Message > &theMessage)=0
This method is called by loop when the event is started to process.
void groupWhileFlush(const std::shared_ptr< Events_Message > &theMessage)
Allows to group messages while they are flushed (for flush for groupMessages=true listeners)
Definition: Events_Listener.cpp:24
Base class that manages the receiving and sending of all not Qt-events in the application.
Definition: Events_Loop.h:43
Message for communication between sender and listener of event.
Definition: Events_Message.h:65