Spell-checking

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

diff --git a/src/ModuleBase/ModuleBase_ParamSpinBox.h b/src/ModuleBase/ModuleBase_ParamSpinBox.h
index 46af290922d448a1216739cdb1db4184c2171407..591d0cfd970658fa981a8ffc0f6a47ad69d3c117 100644 (file)
--- a/src/ModuleBase/ModuleBase_ParamSpinBox.h
+++ b/src/ModuleBase/ModuleBase_ParamSpinBox.h
@@ -8,6 +8,10 @@
 
 #include <QValidator>
 
+/**
+* \ingroup GUI
+* An extension of a double spin box which let to use parameters and expressions for value definition
+*/
 class MODULEBASE_EXPORT ModuleBase_ParamSpinBox : public ModuleBase_DoubleSpinBox
 {
   Q_OBJECT
@@ -15,7 +19,17 @@ class MODULEBASE_EXPORT ModuleBase_ParamSpinBox : public ModuleBase_DoubleSpinBo
   enum State { Invalid = 0, NoVariable, Incompatible, Acceptable };
 
 public:
-  explicit ModuleBase_ParamSpinBox(QWidget* theParent = 0, int thePrecision = 6);
+  /*!
+   \brief Constructor.
+
+   Constructs a spin box with 0.0 as minimum value and 99.99 as maximum value,
+   a step value of 1.0 and a precision of 2 decimal places.
+   The value is initially set to 0.00.
+
+   \param theParent a parent object
+   \param thePrecision a precision of values display
+   */
+  explicit ModuleBase_ParamSpinBox( QWidget* theParent = 0, int thePrecision = -12 );
   virtual ~ModuleBase_ParamSpinBox();
 
   virtual void stepBy(int);
@@ -29,26 +43,36 @@ public:
 
   virtual void setText(const QString&);
 
+  /// Set a flag about accepted variable
   void setAcceptVariables(const bool);
+
+  /// Returns accepted variables flag
   bool isAcceptVariables() const;
-  bool hasVariable() const;
 
-//signals:
-  //void textChanged(const QString&);
+  /// Returns True if the input value contains variable
+  bool hasVariable() const;
 
  protected:
+   /// Returns True if the given text contains variable
+   /// \param theText a text string
   bool hasVariable(const QString& theText) const;
+
+  /// Returns state of the control
   State isValid(const QString&, double&) const;
 
+  /// Returns True if the given value is within min and max of the control
   bool checkRange(const double) const;
 
-  bool findVariable(const QString&, double&) const;
+  /// Finds a variable by its name. Returns true in success
+  /// \param theName a name of variable
+  /// \param outValue an output value of the variable
+  bool findVariable(const QString& theName, double& outValue) const;
 
  protected:
-  //virtual void keyPressEvent(QKeyEvent*);
   virtual void showEvent(QShowEvent*);
 
  protected slots:
+   /// A slot called on text change
   void onTextChanged(const QString&);
 
  private: