Merge branch 'Dev_1.1.0' of newgeom:newgeom into Dev_1.1.0

[modules/shaper.git] / src / ModuleBase / ModuleBase_WidgetDoubleValue.h

diff --git a/src/ModuleBase/ModuleBase_WidgetDoubleValue.h b/src/ModuleBase/ModuleBase_WidgetDoubleValue.h
index 20afafbe18f9862e7a43b15c0287660334f79ed7..fd447a78050f26c525c4e3029855b383df288e7c 100644 (file)
--- a/src/ModuleBase/ModuleBase_WidgetDoubleValue.h
+++ b/src/ModuleBase/ModuleBase_WidgetDoubleValue.h
@@ -1,3 +1,5 @@
+// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
+
 // File:        ModuleBase_WidgetDoubleValue.h
 // Created:     04 June 2014
 // Author:      Vitaly Smetannikov
@@ -14,22 +16,32 @@ class QWidget;
 class QLabel;
 class QTimer;
 
+/**
+* \ingroup GUI
+* A class of property panel widget for double value input
+* It can be defined with "doublevalue" keyword. For example:
+* \code
+* <doublevalue id="x" label="X:" icon=":pictures/x_point.png" tooltip="X coordinate"/>
+* \endcode
+*/
 class MODULEBASE_EXPORT ModuleBase_WidgetDoubleValue : public ModuleBase_ModelWidget
 {
 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 structure (widget, operation, group)
   ModuleBase_WidgetDoubleValue(QWidget* theParent, const Config_WidgetAPI* theData,
                                const std::string& theParentId);
 
   virtual ~ModuleBase_WidgetDoubleValue();
 
-  /// Saves the internal parameters to the given feature
-  /// \param theObject a model feature to be changed
-  virtual bool storeValue() const;
+  /// Fills the widget with default values
+  virtual void reset();
 
+  //! Read value of corresponded attribute from data model to the input control
+  // \return True in success
   virtual bool restoreValue();
 
   /// Returns list of widget controls
@@ -44,13 +56,23 @@ Q_OBJECT
   }
 
  public slots:
- /// Delayed value chnged: when user starts typing something,
+ // Delayed value chnged: when user starts typing something,
  // it gives him a 0,5 second to finish typing, when sends valueChnaged() signal
 //  void onValueChanged();
 
- protected:
+protected:
+  /// Saves the internal parameters to the given feature
+  /// \return True in success
+  virtual bool storeValueCustom() const;
+
+protected:
+   /// Container for thw widget controls
   QWidget* myContainer;
+
+  /// Label of the widget
   QLabel* myLabel;
+
+  /// Input value control
   ModuleBase_DoubleSpinBox* mySpinBox;
 };