Update classes documentation

[modules/shaper.git] / src / XGUI / XGUI_WorkshopListener.h

diff --git a/src/XGUI/XGUI_WorkshopListener.h b/src/XGUI/XGUI_WorkshopListener.h
index fa41577cc5e2d42db19ac595e6902e9d0f916e8e..5358253b522d142f139ada0976def30db21e3acb 100755 (executable)
--- a/src/XGUI/XGUI_WorkshopListener.h
+++ b/src/XGUI/XGUI_WorkshopListener.h
@@ -28,9 +28,8 @@ 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
+  /// Constructor. Used only if the workshop is launched in Salome environment
+  /// \param theWorkshop a reference to workshop. 
    XGUI_WorkshopListener(ModuleBase_IWorkshop* theWorkshop);
   virtual ~XGUI_WorkshopListener();
 
@@ -44,37 +43,41 @@ 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);
-
 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);
+  bool displayObject(ObjectPtr theObj, bool& theFirstVisualizedBody);
 
   /// 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 customizeCurrentObject(const std::set<ObjectPtr>& theObjects, bool theForceRedisplay);
 
   /// Returns the workshop
   XGUI_Workshop* workshop() const;