src/ModuleBase/ModuleBase_ParamSpinBox.h

   1 // Copyright (C) 2014-2017  CEA/DEN, EDF R&D
   2 //
   3 // This library is free software; you can redistribute it and/or
   4 // modify it under the terms of the GNU Lesser General Public
   5 // License as published by the Free Software Foundation; either
   6 // version 2.1 of the License, or (at your option) any later version.
   7 //
   8 // This library is distributed in the hope that it will be useful,
   9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11 // Lesser General Public License for more details.
  12 //
  13 // You should have received a copy of the GNU Lesser General Public
  14 // License along with this library; if not, write to the Free Software
  15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  16 //
  17 // See http://www.salome-platform.org/ or
  18 // email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
  19 //
  20
  21 #ifndef ModuleBase_ParamSpinBox_H
  22 #define ModuleBase_ParamSpinBox_H
  23
  24 #include "ModuleBase.h"
  25
  26 #include <ModuleBase_DoubleSpinBox.h>
  27
  28 #include <QValidator>
  29
  30 class QStringListModel;
  31 class QCompleter;
  32
  33 /**
  34 * \ingroup GUI
  35 * An extension of a double spin box which let to use parameters and expressions for value definition
  36 */
  37 class MODULEBASE_EXPORT ModuleBase_ParamSpinBox : public ModuleBase_DoubleSpinBox
  38 {
  39   Q_OBJECT
  40
  41   enum State { Invalid = 0, NoVariable, Incompatible, Acceptable };
  42
  43 public:
  44   /*!
  45    \brief Constructor.
  46
  47    Constructs a spin box with 0.0 as minimum value and 99.99 as maximum value,
  48    a step value of 1.0 and a precision of 2 decimal places.
  49    The value is initially set to 0.00.
  50
  51    \param theParent a parent object
  52    \param thePrecision a precision of values display
  53    */
  54   explicit ModuleBase_ParamSpinBox( QWidget* theParent = 0, int thePrecision = -12 );
  55
  56   /// Set list of completion strings
  57   void setCompletionList(QStringList&);
  58
  59   virtual ~ModuleBase_ParamSpinBox();
  60
  61   virtual void stepBy(int);
  62
  63   virtual double valueFromText(const QString&) const;
  64   virtual QString textFromValue (double value) const;
  65
  66   virtual QValidator::State validate(QString&, int&) const;
  67
  68   virtual void setValue(double);
  69
  70   virtual void setText(const QString&);
  71
  72   /// Set a flag about accepted variable
  73   void setAcceptVariables(const bool);
  74
  75   /// Returns accepted variables flag
  76   bool isAcceptVariables() const;
  77
  78   /// Returns True if the input value contains variable
  79   bool hasVariable() const;
  80
  81 protected:
  82    /// Returns True if the given text contains variable
  83    /// \param theText a text string
  84   bool hasVariable(const QString& theText) const;
  85
  86   /// Returns state of the control
  87   State isValid(const QString&, double&) const;
  88
  89   /// Returns True if the given value is within min and max of the control
  90   bool checkRange(const double) const;
  91
  92   /// Finds a variable by its name. Returns true in success
  93   /// \param theName a name of variable
  94   /// \param outValue an output value of the variable
  95   bool findVariable(const QString& theName, double& outValue) const;
  96
  97 signals:
  98   void textChanged(const QString& theText);
  99
 100  protected:
 101   virtual void showEvent(QShowEvent*);
 102
 103  protected slots:
 104    /// A slot called on text change
 105   void onTextChanged(const QString&);
 106
 107  private:
 108   void connectSignalsAndSlots();
 109
 110  private:
 111   QString myTextValue;
 112
 113   bool myAcceptVariables;
 114
 115   QStringListModel* myCompleterModel;
 116   QCompleter* myCompleter;
 117 };
 118
 119 #endif