X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FPartSet%2FPartSet_WidgetPoint2dDistance.h;h=7d6a497c6058f55a89af09552decfa518f6ce373;hb=c55b14977783111c8b418b416c7f6c2fa545c5e5;hp=84d962a06982de936d8ec59b1b8bef002602ac5a;hpb=8a5d97eb28fa3b1058c64942fed24347916a5c40;p=modules%2Fshaper.git

diff --git a/src/PartSet/PartSet_WidgetPoint2dDistance.h b/src/PartSet/PartSet_WidgetPoint2dDistance.h
index 84d962a06..7d6a497c6 100644
--- a/src/PartSet/PartSet_WidgetPoint2dDistance.h
+++ b/src/PartSet/PartSet_WidgetPoint2dDistance.h
@@ -1,3 +1,5 @@
+// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
+
 // File:        PartSet_WidgetPoint2dDistance.h
 // Created:     23 June 2014
 // Author:      Vitaly Smetannikov
@@ -15,45 +17,78 @@ 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);
 
   virtual ~PartSet_WidgetPoint2dDistance();
 
-  /// The methiod called when widget is activated
-  virtual void activate();
+  /// Fills the widget with default values
+  virtual void reset();
 
   /// 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:
-  void onMouseRelease(ModuleBase_IViewWindow* theWnd, QMouseEvent* theEvent);
+public slots:
+   /// Process of mouse move
+   /// \param theWnd a pointer to a window
+   /// \param theEvent a mouse event
   void onMouseMove(ModuleBase_IViewWindow* theWnd, QMouseEvent* theEvent);
 
+  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);
+
 protected:
+  /// The methiod called when widget is activated
+  virtual void activateCustom();
+
   /// Set the second point which defines a value in the widget as a distance with a first point defined by feature
   void setPoint(FeaturePtr theFeature, const std::shared_ptr<GeomAPI_Pnt2d>& thePnt);
 
+private slots:
+  /// Process values changed event
+  void onValuesChanged();
+
  private:
   XGUI_Workshop* myWorkshop;
   std::string myFirstPntName;