Salome HOME
updated copyright message
[modules/shaper.git] / src / ModuleBase / ModuleBase_DoubleSpinBox.h
index a247fb8b782d5fde34efb0acb4ab629c47c88438..c28c69f71992bc57d8260ed14a2dcd382bef708d 100644 (file)
@@ -1,6 +1,22 @@
-// File:      ModuleBase_DoubleSpinBox.h
-// Author:    Sergey TELKOV
+// Copyright (C) 2014-2023  CEA, EDF
 //
+// This library is free software; you can redistribute it and/or
+// modify it under the terms of the GNU Lesser General Public
+// License as published by the Free Software Foundation; either
+// version 2.1 of the License, or (at your option) any later version.
+//
+// This library is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+// Lesser General Public License for more details.
+//
+// You should have received a copy of the GNU Lesser General Public
+// License along with this library; if not, write to the Free Software
+// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
+//
+// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
+//
+
 #ifndef MODULEBASE_DOUBLESPINBOX_H_
 #define MODULEBASE_DOUBLESPINBOX_H_
 
 #include <QDoubleSpinBox>
 #include <QValidator>
 
+#include <QColor>
+
+class QKeyEvent;
+
+/**
+* \ingroup GUI
+* An extension and customization 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 = -12 );
   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;
 
+  /// Imitation of disable control value. If theEnable is false, the control becomes
+  /// read only and base color is disabled.
+  void setValueEnabled(const bool& theEnable);
+
  protected slots:
+   /// Called on text changed
   virtual void onTextChanged(const QString&);
 
  protected:
+   /// Removes extra trailing zero symbols
   QString removeTrailingZeroes(const QString&) const;
 
  private:
+  // boolen flag whether the key event is emitted. The default value is false
+  bool myIsEmitKeyPressEvent;
+
+   /// Is clear flag
   bool myCleared;
+
+  /// Precision value
   int myPrecision;
+
+  /// Cashed color of active base palette
+  QColor myEnabledBaseColor;
 };
 
 #endif