Merge branch 'Dev_0.7.1' of newgeom:newgeom into Dev_0.7.1

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

diff --git a/src/PartSet/PartSet_WidgetPoint2dDistance.h b/src/PartSet/PartSet_WidgetPoint2dDistance.h
index ca95b75fd3ee11f0bd851fa1319dbc76d4a9985d..9ccf0cb6bdbbb864cc7ca349e0f46a6dcd97c316 100644 (file)
--- a/src/PartSet/PartSet_WidgetPoint2dDistance.h
+++ b/src/PartSet/PartSet_WidgetPoint2dDistance.h
@@ -17,13 +17,31 @@ class XGUI_Workshop;
 class ModuleBase_IViewWindow;
 class QMouseEvent;
 
+/**
+* \ingroup Modules
+* Implementation of model widget for widget which provides input of a distance between two points
+* In XML file can be defined as following:
+* \code
+* <point2ddistance id="CircleRadius" 
+*   first_point="CircleCenter" 
+*   label="Radius:" 
+*   min="0" 
+*   step="1.0" 
+*   default="0" 
+*   icon=":icons/radius.png" 
+*   tooltip="Set radius">
+*   <validator id="GeomValidators_Positive"/>
+* </point2ddistance>
+* \endcode
+*/ 
 class PARTSET_EXPORT PartSet_WidgetPoint2dDistance : public ModuleBase_WidgetDoubleValue
 {
 Q_OBJECT
  public:
   /// Constructor
-  /// \theParent the parent object
-  /// \theData the widget configuation. The attribute of the model widget is obtained from
+  /// \param theParent the parent object
+  /// \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_WidgetPoint2dDistance(QWidget* theParent, const Config_WidgetAPI* theData,
                                    const std::string& theParentId);
 
@@ -35,21 +53,28 @@ Q_OBJECT
   /// The methiod called when widget is deactivated
   virtual void deactivate();
 
-  /// Set the given wrapped value to the current widget
-  /// This value should be processed in the widget according to the needs
-  /// \param theValue the wrapped widget value
-  //virtual bool setValue(ModuleBase_WidgetValue* theValue);
-
+  /// Returns workshop
   XGUI_Workshop* workshop() const { return myWorkshop; }
 
+  /// Set workshop
+  /// \param theWork a pointer to workshop
   void setWorkshop(XGUI_Workshop* theWork) { myWorkshop = theWork; }
 
   /// \returns the sketch instance
   CompositeFeaturePtr sketch() const { return mySketch; }
+
+  /// Set sketch instance
   void setSketch(CompositeFeaturePtr theSketch) { mySketch = theSketch; }
 
  protected slots:
+   /// Process of mouse release
+   /// \param theWnd a pointer to a window
+   /// \param theEvent a mouse event
   void onMouseRelease(ModuleBase_IViewWindow* theWnd, QMouseEvent* theEvent);
+
+   /// Process of mouse move
+   /// \param theWnd a pointer to a window
+   /// \param theEvent a mouse event
   void onMouseMove(ModuleBase_IViewWindow* theWnd, QMouseEvent* theEvent);
 
 protected:
@@ -57,6 +82,7 @@ protected:
   void setPoint(FeaturePtr theFeature, const std::shared_ptr<GeomAPI_Pnt2d>& thePnt);
 
 private slots:
+  /// Process values changed event
   void onValuesChanged();
 
  private: