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 a7f19df947bdc4b4c5f79989d8628b17bfc89d6f..4ec5e13505fdeee5e22395529da5e6003ab2c978 100644 (file)
--- a/src/PartSet/PartSet_WidgetMultiSelector.h
+++ b/src/PartSet/PartSet_WidgetMultiSelector.h
@@ -11,15 +11,15 @@
 #include "PartSet.h"
 
 #include <ModuleBase_WidgetMultiSelector.h>
-#include <ModuleBase_ViewerPrs.h>
 
 #include <ModelAPI_CompositeFeature.h>
 
 class PartSet_ExternalObjectsMgr;
+class ModuleBase_ViewerPrs;
 
 /**
 * \ingroup Modules
-* Customization of ModuleBase_WidgetMultiSelector in order to provide
+* Customosation of ModuleBase_WidgetMultiSelector in order to provide 
 * working with sketch specific objects and creation of external objects.
 */
 class PARTSET_EXPORT PartSet_WidgetMultiSelector: public ModuleBase_WidgetMultiSelector
@@ -29,10 +29,9 @@ Q_OBJECT
   /// Constructor
   /// \param theParent the parent object
   /// \param theWorkshop instance of workshop interface
-  /// \param theData the widget configuration. The attribute of the model widget is obtained from
-  /// \param theParentId is Id of a parent of the current attribute
+  /// \param theData the widget configuation. The attribute of the model widget is obtained from
   PartSet_WidgetMultiSelector(QWidget* theParent, ModuleBase_IWorkshop* theWorkshop,
-                              const Config_WidgetAPI* theData, const std::string& theParentId);
+                              const Config_WidgetAPI* theData);
 
   virtual ~PartSet_WidgetMultiSelector();
 
@@ -43,46 +42,36 @@ Q_OBJECT
   /// \param theSketch a sketcher object
   void setSketcher(CompositeFeaturePtr theSketch) { mySketch = theSketch; }
 
-  /// Returns installed sketcher
+  /// Retrurns installed sketcher
   CompositeFeaturePtr sketch() const { return mySketch; }
 
-  /// Set the given wrapped value to the current widget
-  /// This value should be processed in the widget according to the needs
-  /// \param theValues the wrapped selection values
-  virtual bool setSelection(QList<ModuleBase_ViewerPrs>& theValues,
-                            const bool theToValidate);
-
 protected:
   /// Checks the widget validity. By default, it returns true.
-  /// \param theValue a selected presentation in the view
+  /// \param thePrs a selected presentation in the view
   /// \return a boolean value
-  virtual bool isValidSelectionCustom(const 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
-  virtual void storeAttributeValue();
+  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);
 
   /// 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 ModuleBase_ViewerPrs& thePrs,
+  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
+#endif
\ No newline at end of file