Salome HOME
updated copyright message
[modules/shaper.git] / src / XGUI / XGUI_WorkshopListener.h
old mode 100755 (executable)
new mode 100644 (file)
index 16a0de8..26fbcbc
@@ -1,4 +1,21 @@
-// Copyright (C) 2014-20xx CEA/DEN, EDF R&D -->
+// Copyright (C) 2014-2023  CEA, EDF
+//
+// This library is free software; you can redistribute it and/or
+// modify it under the terms of the GNU Lesser General Public
+// License as published by the Free Software Foundation; either
+// version 2.1 of the License, or (at your option) any later version.
+//
+// This library is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+// Lesser General Public License for more details.
+//
+// You should have received a copy of the GNU Lesser General Public
+// License along with this library; if not, write to the Free Software
+// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
+//
+// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
+//
 
 #ifndef XGUI_WORKSHOP_LISTENER_H
 #define XGUI_WORKSHOP_LISTENER_H
@@ -8,6 +25,7 @@
 #include <Events_Message.h>
 
 #include <ModelAPI_Feature.h>
+#include <Events_InfoMessage.h>
 
 #include <QObject>
 
@@ -19,6 +37,7 @@ class XGUI_Workshop;
 class ModuleBase_IWorkshop;
 
 class QString;
+class Events_InfoMessage;
 
 /**\class XGUI_WorkshopListener
  * \ingroup GUI
@@ -28,10 +47,9 @@ class XGUI_EXPORT XGUI_WorkshopListener : public QObject, public Events_Listener
 {
   Q_OBJECT
 public:
-  /// Constructor
-  /// \param theConnector a Salome connector object. 
-  /// Used only if the workshop is launched in Salome environment
-   XGUI_WorkshopListener(ModuleBase_IWorkshop* theWorkshop);
+  /// Constructor. Used only if the workshop is launched in Salome environment
+  /// \param theWorkshop a reference to workshop.
+   XGUI_WorkshopListener(XGUI_Workshop* theWorkshop);
   virtual ~XGUI_WorkshopListener();
 
   /// Register this class in the events loop for several types of events
@@ -42,45 +60,53 @@ public:
 
 signals:
   /// Emitted when error in applivation happens
-  void errorOccurred(const QString&);
-
-protected slots:
-  /// Updates Apply All button state of the feature to the state if the feature has the button
-  /// \param theFeatureId an index of the feature, the action is searched, which state is to be changed
-  /// \param theState an action enable state
-  //void onNestedStateChanged(const std::string& theFeatureId, const bool theState);
+  void errorOccurred(std::shared_ptr<Events_InfoMessage> theMsg);
 
 protected:
   /// Procedure to process postponed events
   bool event(QEvent * theEvent);
 
-   /// Process event "Add a feature"
-  void addFeature(const std::shared_ptr<Config_FeatureMessage>&);
-
   /// Process feature update message
-  void onFeatureUpdatedMsg(const std::shared_ptr<ModelAPI_ObjectUpdatedMessage>& );
+  /// \param theMsg a message with a container of objects
+  void onFeatureUpdatedMsg(const std::shared_ptr<ModelAPI_ObjectUpdatedMessage>& theMsg);
 
   /// Process feature created message
-  void onFeatureCreatedMsg(const std::shared_ptr<ModelAPI_ObjectUpdatedMessage>& );
+  /// \param theMsg a message with a container of objects
+  void onFeatureCreatedMsg(const std::shared_ptr<ModelAPI_ObjectUpdatedMessage>& theMsg);
 
   /// Process feature redisplay message
-  void onFeatureRedisplayMsg(const std::shared_ptr<ModelAPI_ObjectUpdatedMessage>& );
+  /// \param theMsg a message with a container of objects
+  void onFeatureRedisplayMsg(const std::shared_ptr<ModelAPI_ObjectUpdatedMessage>& theMsg);
+
+  /// Process clearing of presentation
+  /// \param theMsg an event message
+  void onFeatureEmptyPresentationMsg(const std::shared_ptr<ModelAPI_ObjectUpdatedMessage>& theMsg);
 
   /// Displaus object and fit all viewer if the object is first (update viewer will not be called)
   /// Asks the module whether the object can be displayed
   /// \param theObj an object
+  /// \param theFirstVisualizedBody an output state whether there are not object displayed in the
+  /// view and the displayed object is a body
   /// \return true if the object is displayed
   bool displayObject(ObjectPtr theObj);
 
   /// Calls the module method of cusomize object for the feature of the current operation
+  /// Perform cusomize if the force redisplay flag is true or the list of objects contains the
+  /// current operation feature
+  /// \param theObjects a list of objects to find current operation feature
+  ///                   if forced redisplay is false
+  /// \param theForceRedisplay a flag to customize object even always
   /// \return true if the object is modified
-  bool customizeCurrentObject();
+  bool customizeFeature(const std::set<ObjectPtr>& theObjects, bool theForceRedisplay);
 
   /// Returns the workshop
   XGUI_Workshop* workshop() const;
 
 private:
-  ModuleBase_IWorkshop* myWorkshop; // the current workshop
+
+  void setDisplayed(ObjectPtr theObject, const bool theIsLoadedScript, bool& theDisplayed);
+
+  XGUI_Workshop* myWorkshop; // the current workshop
 
   bool myUpdatePrefs;
 };