Merge branch 'master' of newgeom:newgeom

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

diff --git a/src/PartSet/PartSet_WidgetShapeSelector.h b/src/PartSet/PartSet_WidgetShapeSelector.h
index d4cf72aff480fa7674bf953a116297c9760bdf41..222bac774861dde14ece55b7fa51f81fe96a6433 100644 (file)
--- a/src/PartSet/PartSet_WidgetShapeSelector.h
+++ b/src/PartSet/PartSet_WidgetShapeSelector.h
@@ -14,31 +14,59 @@
 
 #include <ModelAPI_CompositeFeature.h>
 
+
+/**
+* \ingroup Modules
+* Customosation of ModuleBase_WidgetShapeSelector in order to provide 
+* working with sketch specific objects.
+*/
 class PARTSET_EXPORT PartSet_WidgetShapeSelector: public ModuleBase_WidgetShapeSelector
 {
 Q_OBJECT
  public:
+  /// Constructor
+  /// \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_WidgetShapeSelector(QWidget* theParent, ModuleBase_IWorkshop* theWorkshop,
     const Config_WidgetAPI* theData, const std::string& theParentId)
     : ModuleBase_WidgetShapeSelector(theParent, theWorkshop, theData, theParentId) {}
 
   virtual ~PartSet_WidgetShapeSelector() {}
 
-  /// Saves the internal parameters to the given feature
   virtual bool storeValue() const;
 
+  /// Set sketcher
+  /// \param theSketch a sketcher object
   void setSketcher(CompositeFeaturePtr theSketch) { mySketch = theSketch; }
+
+  /// Retrurns installed sketcher
   CompositeFeaturePtr sketch() const { return mySketch; }
 
+protected:
+  /// Check the selected with validators if installed
+  virtual bool isValid(ObjectPtr theObj, std::shared_ptr<GeomAPI_Shape> theShape);
+
 private:
+  /// Pointer to a sketch 
   CompositeFeaturePtr mySketch;
 };
 
-
+/**
+* \ingroup Modules
+* Customosation of ModuleBase_WidgetShapeSelector in order to provide 
+* working with constraints.
+*/
 class PARTSET_EXPORT PartSet_WidgetConstraintShapeSelector: public ModuleBase_WidgetShapeSelector
 {
 Q_OBJECT
  public:
+  /// Constructor
+  /// \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_WidgetConstraintShapeSelector(QWidget* theParent, ModuleBase_IWorkshop* theWorkshop,
     const Config_WidgetAPI* theData, const std::string& theParentId)
     : ModuleBase_WidgetShapeSelector(theParent, theWorkshop, theData, theParentId) {}
@@ -48,10 +76,15 @@ Q_OBJECT
   /// Saves the internal parameters to the given feature
   virtual bool storeValue() const;
 
+  /// Set sketcher
+  /// \param theSketch a sketcher object
   void setSketcher(CompositeFeaturePtr theSketch) { mySketch = theSketch; }
+
+  /// Retrurns installed sketcher
   CompositeFeaturePtr sketch() const { return mySketch; }
 
 private:
+  /// Pointer to a sketch 
   CompositeFeaturePtr mySketch;
 };