Fix for #767: correct the internal history structure for nested features

[modules/shaper.git] / src / Events / Events_Loop.h

diff --git a/src/Events/Events_Loop.h b/src/Events/Events_Loop.h
index 317c62d3b9e9dea0b5ef33b4c75684ede9c328ef..adc88835198dda23e4121ac4dd07620217475e19 100644 (file)
--- a/src/Events/Events_Loop.h
+++ b/src/Events/Events_Loop.h
@@ -1,3 +1,5 @@
+// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
+
 // File:       Events_Loop.hxx
 // Created:    Thu Mar 13 2014
 // Author:     Mikhail PONIKAROV
@@ -14,7 +16,7 @@
 
 class Events_MessageGroup;
 
-/**\class Events_Lopp
+/**\class Events_Loop
  * \ingroup EventsLoop
  * \brief Base class that manages the receiving and sending of all
  * not Qt-events in the application.
@@ -52,6 +54,7 @@ class Events_Loop
   EVENTS_EXPORT static Events_ID eventByName(const char* theName);
 
   //! Allows to send an event
+  //! \param theMessage the enevt message to send
   //! \param isGroup is true for grouping messages if possible
   EVENTS_EXPORT void send(const std::shared_ptr<Events_Message>& theMessage, bool isGroup = true);
 
@@ -65,8 +68,10 @@ class Events_Loop
 
   //! Allows to disable flushes: needed in synchronization of document mechanism 
   //! (to synchronize all and only then flush create, update, etc in correct order)
-  EVENTS_EXPORT void activateFlushes(const bool theActivate);
-
+  //! \param theActivate a state about flushe is active. If false, the flush is disabled
+  //! \return the previous active flush state
+  EVENTS_EXPORT bool activateFlushes(const bool theActivate);
+  
   //! Clears all collected messages
   EVENTS_EXPORT void clear(const Events_ID& theID);