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

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

diff --git a/src/ModuleBase/ModuleBase_DoubleSpinBox.h b/src/ModuleBase/ModuleBase_DoubleSpinBox.h
index a247fb8b782d5fde34efb0acb4ab629c47c88438..555cafc36fdeec085b8444ba80c27f7a384732e3 100644 (file)
--- a/src/ModuleBase/ModuleBase_DoubleSpinBox.h
+++ b/src/ModuleBase/ModuleBase_DoubleSpinBox.h
@@ -1,5 +1,7 @@
+// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
+
 // File:      ModuleBase_DoubleSpinBox.h
-// Author:    Sergey TELKOV
+// Author:    Sergey BELASH
 //
 #ifndef MODULEBASE_DOUBLESPINBOX_H_
 #define MODULEBASE_DOUBLESPINBOX_H_
@@ -9,35 +11,56 @@
 #include <QDoubleSpinBox>
 #include <QValidator>
 
+
+/**
+* \ingroup GUI
+* An extension and customozation of QDoubleSpinBox class
+*/
 class MODULEBASE_EXPORT ModuleBase_DoubleSpinBox : public QDoubleSpinBox
 {
 Q_OBJECT
 
  public:
-  ModuleBase_DoubleSpinBox(QWidget* = 0, int thePrecision = 6);
+  explicit ModuleBase_DoubleSpinBox(QWidget* theParent = 0, int thePrecision = 6);
   virtual ~ModuleBase_DoubleSpinBox();
 
+  /// Returns true if the control is clear
   bool isCleared() const;
+
+  /// Set control clear
   virtual void setCleared(const bool);
 
+  /// Returns current precision
   int getPrecision() const;
+
+  /// Set precision
   void setPrecision(const int);
 
+  /// Set step
   virtual void stepBy(int);
 
+  /// Converts value from string to double
   virtual double valueFromText(const QString&) const;
+
+  /// Convert value from double to string
   virtual QString textFromValue(double) const;
 
+  /// Validate current value
   virtual QValidator::State validate(QString&, int&) const;
 
  protected slots:
+   /// Called on text changed
   virtual void onTextChanged(const QString&);
 
  protected:
+   /// Removes extra trailing zero symbols
   QString removeTrailingZeroes(const QString&) const;
 
  private:
+   /// Is clear flag
   bool myCleared;
+
+  /// Precision value
   int myPrecision;
 };