Update classes documentation

[modules/shaper.git] / src / PartSet / PartSet_WidgetMultiSelector.h

diff --git a/src/PartSet/PartSet_WidgetMultiSelector.h b/src/PartSet/PartSet_WidgetMultiSelector.h
index 8b71001e8c147cb98fe5213b77feb2834ade8bea..4ec5e13505fdeee5e22395529da5e6003ab2c978 100644 (file)
--- a/src/PartSet/PartSet_WidgetMultiSelector.h
+++ b/src/PartSet/PartSet_WidgetMultiSelector.h
@@ -11,11 +11,11 @@
 #include "PartSet.h"
 
 #include <ModuleBase_WidgetMultiSelector.h>
-#include <ModuleBase_ViewerPrs.h>
 
 #include <ModelAPI_CompositeFeature.h>
 
 class PartSet_ExternalObjectsMgr;
+class ModuleBase_ViewerPrs;
 
 /**
 * \ingroup Modules
@@ -30,9 +30,8 @@ Q_OBJECT
   /// \param theParent the parent object
   /// \param theWorkshop instance of workshop interface
   /// \param theData the widget configuation. The attribute of the model widget is obtained from
-  /// \param theParentId is Id of a parent of the current attribute
   PartSet_WidgetMultiSelector(QWidget* theParent, ModuleBase_IWorkshop* theWorkshop,
-    const Config_WidgetAPI* theData, const std::string& theParentId);
+                              const Config_WidgetAPI* theData);
 
   virtual ~PartSet_WidgetMultiSelector();
 
@@ -46,39 +45,33 @@ Q_OBJECT
   /// Retrurns installed sketcher
   CompositeFeaturePtr sketch() const { return mySketch; }
 
-  /// Fills the attribute with the value of the selected owner
-  /// \param theOwner a selected owner
-  virtual bool setSelectionCustom(const ModuleBase_ViewerPrs& thePrs);
-
-public slots:
-  /// Slot is called on selection changed
-  virtual void onSelectionChanged();
-
 protected:
-  /// Creates a backup of the current values of the attribute
-  /// It should be realized in the specific widget because of different
-  /// parameters of the current attribute
-  virtual void storeAttributeValue();
+  /// Checks the widget validity. By default, it returns true.
+  /// \param thePrs a selected presentation in the view
+  /// \return a boolean value
+  virtual bool isValidSelectionCustom(const std::shared_ptr<ModuleBase_ViewerPrs>& thePrs);
 
   /// Creates a backup of the current values of the attribute
   /// It should be realized in the specific widget because of different
   /// parameters of the current attribute
+  /// \param theAttribute an attribute
   /// \param theValid a boolean flag, if restore happens for valid parameters
-  void restoreAttributeValue(const bool theValid);
+  virtual void restoreAttributeValue(const AttributePtr& theAttribute, const bool theValid);
 
-  /// Store the values to the model attribute of the widget. It casts this attribute to
-  /// the specific type and set the given values
-  /// \param theSelectedObject an object
-  /// \param theShape a selected shape, which is used in the selection attribute
-  /// \return true if it is succeed
-  bool setObject(const ObjectPtr& theSelectedObject, const GeomShapePtr& theShape);
+  /// Return an object and geom shape by the viewer presentation
+  /// \param thePrs a selection
+  /// \param theObject an output object
+  /// \param theShape a shape of the selection
+  virtual void getGeomSelection(const std::shared_ptr<ModuleBase_ViewerPrs>& thePrs,
+                                ObjectPtr& theObject,
+                                GeomShapePtr& theShape);
 
 protected:
+  /// Manager of external objects
   PartSet_ExternalObjectsMgr* myExternalObjectMgr;
+
   /// Pointer to a sketch 
   CompositeFeaturePtr mySketch;
-
-  bool myIsInVaildate;
 };
 
 #endif
\ No newline at end of file