1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
3 // File: ModuleBase_DoubleSpinBox.cxx
4 // Author: Sergey TELKOV
6 #include "ModuleBase_DoubleSpinBox.h"
9 #include <QDoubleValidator>
14 const double PSEUDO_ZERO = 1.e-20;
17 \class ModuleBase_DoubleSpinBox
18 \brief Enhanced version of the Qt's double spin box.
20 The ModuleBase_DoubleSpinBox class represents the widget for entering the
21 floating point values. In addition to the functionality provided by
22 QDoubleSpinBox, this class supports "cleared" state - this is the
23 state corresponding to "None" (or empty) entered value.
25 To set "cleared" state use setCleared() method. To check if the spin
26 box stores "cleared" state, use isCleared() method.
29 if (myDblSpinBox->isCleared()) {
30 ... // process "None" state
33 double value = myDblSpinBox->value();
34 ... // process entered value
38 Another useful feature is possibility to use scientific notation (e.g. 1.234e+18)
39 for the widget text. To enable this, negative precision should be specified either
40 through a constructor or using setPrecision() method.
42 Note that "decimals" property of QDoubleSpinBox is almost completely substituted
43 by "myPrecision" field of ModuleBase_DoubleSpinBox class. "decimals" is still used
44 for proper size hint calculation and for rounding minimum and maximum bounds of
51 Constructs a spin box with 0.0 as minimum value and 99.99 as maximum value,
52 a step value of 1.0 and a precision of 2 decimal places.
53 The value is initially set to 0.00.
55 \param theParent parent object
56 \param thePrecision precision of values input
58 ModuleBase_DoubleSpinBox::ModuleBase_DoubleSpinBox(QWidget* theParent, int thePrecision)
59 : QDoubleSpinBox(theParent),
63 // VSR 01/07/2010: Disable thousands separator for spin box
64 // (to avoid inconsistency of double-2-string and string-2-double conversion)
66 loc.setNumberOptions(loc.numberOptions() | QLocale::OmitGroupSeparator | QLocale::RejectGroupSeparator);
69 // MPV 15/09/2014: this must be set before setDecimals; otherwise in release mode setDecimals may crash
70 myPrecision = thePrecision;
72 // Use precision equal to default Qt decimals
73 // it's necessary to set decimals before the range setting,
74 // by default Qt rounds boundaries to 2 decimals at setRange
75 setDecimals(qAbs(myPrecision));
77 connect(lineEdit(), SIGNAL(textChanged( const QString& )), this,
78 SLOT(onTextChanged( const QString& )));
80 connect(this, SIGNAL(valueChanged(const QString&)), this, SLOT(onValueChanged(const QString&)));
81 connect(this, SIGNAL(editingFinished()), this, SLOT(onEditingFinished()));
87 ModuleBase_DoubleSpinBox::~ModuleBase_DoubleSpinBox()
92 \brief Check if spin box is in the "cleared" state.
93 \return \c true if spin box is cleared
96 bool ModuleBase_DoubleSpinBox::isCleared() const
102 \brief Change "cleared" status of the spin box.
103 \param on new "cleared" status
106 void ModuleBase_DoubleSpinBox::setCleared(const bool on)
112 setSpecialValueText(specialValueText());
116 \brief Set precision of the spin box
118 If precision value is less than 0, the 'g' format is used for value output,
119 otherwise 'f' format is used.
121 \param prec new precision value.
124 void ModuleBase_DoubleSpinBox::setPrecision(const int prec)
126 int newPrec = qAbs(prec);
127 int oldPrec = qAbs(myPrecision);
129 if (newPrec != oldPrec)
134 \brief Get precision value of the spin box
135 \return current precision value
138 int ModuleBase_DoubleSpinBox::getPrecision() const
144 \brief Interpret text entered by the user as a value.
145 \param text text entered by the user
149 double ModuleBase_DoubleSpinBox::valueFromText(const QString& text) const
152 return text.toDouble();
154 return QDoubleSpinBox::valueFromText(text);
158 \brief This function is used by the spin box whenever it needs to display
161 \param val spin box value
162 \return text representation of the value
165 QString ModuleBase_DoubleSpinBox::textFromValue(double val) const
167 QString s = locale().toString(val, myPrecision >= 0 ? 'f' : 'g', qAbs(myPrecision));
168 return removeTrailingZeroes(s);
172 \brief Return source string with removed leading and trailing zeros.
173 \param src source string
174 \return resulting string
176 QString ModuleBase_DoubleSpinBox::removeTrailingZeroes(const QString& src) const
178 QString delim(locale().decimalPoint());
180 int idx = src.lastIndexOf(delim);
184 QString iPart = src.left(idx);
185 QString fPart = src.mid(idx + 1);
187 int idx1 = fPart.lastIndexOf(QRegExp("e[+|-]?[0-9]+"));
189 ePart = fPart.mid(idx1);
190 fPart = fPart.left(idx1);
193 fPart.remove(QRegExp("0+$"));
196 if (!fPart.isEmpty())
197 res += delim + fPart;
204 void ModuleBase_DoubleSpinBox::keyPressEvent(QKeyEvent *theEvent)
206 myProcessedEvent = 0;
208 bool anIsModified = myIsModified;
209 QDoubleSpinBox::keyPressEvent(theEvent);
211 switch (theEvent->key()) {
213 case Qt::Key_Return: {
215 myProcessedEvent = theEvent;
216 /*qDebug("ModuleBase_DoubleSpinBox::keyPressEvent");
217 if (anIsModified) // we should not perform this event outside
218 theEvent->setAccepted(true);
220 theEvent->setAccepted(false);*/
229 \brief Perform \a steps increment/decrement steps.
231 The \a steps value can be any integer number. If it is > 0,
232 the value incrementing is done, otherwise value is decremented
235 \param steps number of increment/decrement steps
237 void ModuleBase_DoubleSpinBox::stepBy(int steps)
241 QDoubleSpinBox::stepBy(steps);
242 double tmpval = value();
243 if (qAbs(tmpval) < PSEUDO_ZERO)
245 if (tmpval < minimum())
247 else if (tmpval > maximum())
253 \brief This function is used to determine whether input is valid.
254 \param str currently entered value
255 \param pos cursor position in the string
256 \return validating operation result
258 QValidator::State ModuleBase_DoubleSpinBox::validate(QString& str, int& pos) const
260 QString pref = this->prefix();
261 QString suff = this->suffix();
262 uint overhead = pref.length() + suff.length();
263 QValidator::State state = QValidator::Invalid;
265 QDoubleValidator v(NULL);
267 // If 'g' format is used (myPrecision < 0), then
268 // myPrecision - 1 digits are allowed after the decimal point.
269 // Otherwise, expect myPrecision digits after the decimal point.
270 int decs = myPrecision < 0 ? qAbs(myPrecision) - 1 : myPrecision;
272 v.setLocale(this->locale());
274 v.setBottom(minimum());
277 myPrecision >= 0 ? QDoubleValidator::StandardNotation : QDoubleValidator::ScientificNotation);
280 state = v.validate(str, pos);
282 if ((uint)(str.length()) >= overhead && str.startsWith(pref) && str.right(suff.length()) == suff) {
283 QString core = str.mid(pref.length(), str.length() - overhead);
284 int corePos = pos - pref.length();
285 state = v.validate(core, corePos);
286 pos = corePos + pref.length();
287 str.replace(pref.length(), str.length() - overhead, core);
289 state = v.validate(str, pos);
290 if (state == QValidator::Invalid) {
291 QString special = this->specialValueText().trimmed();
292 QString candidate = str.trimmed();
293 if (special.startsWith(candidate)) {
294 if (candidate.length() == special.length())
295 state = QValidator::Acceptable;
297 state = QValidator::Intermediate;
303 // Treat values outside (min; max) range as Invalid
304 // This check is enabled by assigning "strict_validity_check" dynamic property
305 // with value "true" to the spin box instance.
306 if (state == QValidator::Intermediate) {
308 double val = str.toDouble(&isOk);
310 QVariant propVal = property("strict_validity_check");
311 if (propVal.isValid() && propVal.canConvert(QVariant::Bool) && propVal.toBool()) {
312 if (val < minimum() || val > maximum())
313 state = QValidator::Invalid;
315 } else if (myPrecision < 0) {
316 // Consider too large negative exponent as Invalid
317 QChar e(locale().exponential());
318 int epos = str.indexOf(e, 0, Qt::CaseInsensitive);
320 epos++; // Skip exponential symbol itself
321 QString exponent = str.right(str.length() - epos);
322 int expValue = exponent.toInt(&isOk);
323 if (isOk && expValue < std::numeric_limits<double>::min_exponent10)
324 state = QValidator::Invalid;
333 \brief Called when user enters the text in the spin box.
335 void ModuleBase_DoubleSpinBox::onTextChanged(const QString& )
341 void ModuleBase_DoubleSpinBox::onValueChanged(const QString& theValue)
346 void ModuleBase_DoubleSpinBox::onEditingFinished()
348 myIsModified = false;
351 bool ModuleBase_DoubleSpinBox::isEventProcessed(QKeyEvent* theEvent)
353 return myProcessedEvent && myProcessedEvent == theEvent;