Home · All Classes · Modules

QDoubleSpinBox Class Reference
^{[QtGui module]}

The QDoubleSpinBox class provides a spin box widget that takes doubles. More...

Inherits QAbstractSpinBox.

Methods

• __init__ (self, QWidget parent = None)
• QString cleanText (self)
• int decimals (self)
• fixup (self, QString str)
• float maximum (self)
• float minimum (self)
• QString prefix (self)
• setDecimals (self, int prec)
• setMaximum (self, float max)
• setMinimum (self, float min)
• setPrefix (self, QString p)
• setRange (self, float min, float max)
• setSingleStep (self, float val)
• setSuffix (self, QString s)
• setValue (self, float val)
• float singleStep (self)
• QString suffix (self)
• QString textFromValue (self, float v)
• (QValidator.State, int pos) validate (self, QString input)
• float value (self)
• float valueFromText (self, QString text)

Qt Signals

• void valueChanged (double)
• void valueChanged (const QString&)

QDoubleSpinBox allows the user to choose a value by clicking the up and down buttons or by pressing Up or Down on the keyboard to increase or decrease the value currently displayed. The user can also type the value in manually. If the value is entered directly into the spin box, the value will be changed and valueChanged() will be emitted with the new value when Enter or Return is pressed, when the spin box loses focus or when the spin box is deactivated (see QWidget.windowActivationChanged()). The spin box supports double values but can be extended to use different strings with validate(), textFromValue() and valueFromText().

Every time the value changes QDoubleSpinBox emits the valueChanged() signal. The current value can be fetched with value() and set with setValue().

Note: QDoubleSpinBox will round numbers so they can be displayed with the current precision. In a QDoubleSpinBox with decimals set to 2, calling setValue(2.555) will cause value() to return 2.56.

Clicking the up and down buttons or using the keyboard accelerator's Up and Down arrows will increase or decrease the current value in steps of size singleStep(). If you want to change this behavior you can reimplement the virtual function stepBy(). The minimum and maximum value and the step size can be set using one of the constructors, and can be changed later with setMinimum(), setMaximum() and setSingleStep(). The spinbox has a default precision of 2 decimal places but this can be changed using setDecimals().

Most spin boxes are directional, but QDoubleSpinBox can also operate as a circular spin box, i.e. if the range is 0.0-99.9 and the current value is 99.9, clicking "up" will give 0 if wrapping() is set to true. Use setWrapping() if you want circular behavior.

The displayed value can be prepended and appended with arbitrary strings indicating, for example, currency or the unit of measurement. See setPrefix() and setSuffix(). The text in the spin box is retrieved with text() (which includes any prefix() and suffix()), or with cleanText() (which has no prefix(), no suffix() and no leading or trailing whitespace).

It is often desirable to give the user a special (often default) choice in addition to the range of numeric values. See setSpecialValueText() for how to do this with QDoubleSpinBox.

See also QSpinBox, QSlider, and GUI Design Handbook: Slider.

Method Documentation

QDoubleSpinBox.__init__ (self, QWidget parent = None)

The parent argument, if not None, causes self to be owned by Qt instead of PyQt.

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. The spin box has the given parent.

See also setMinimum(), setMaximum(), and setSingleStep().

QString QDoubleSpinBox.cleanText (self)

int QDoubleSpinBox.decimals (self)

QDoubleSpinBox.fixup (self, QString str)

float QDoubleSpinBox.maximum (self)

float QDoubleSpinBox.minimum (self)

QString QDoubleSpinBox.prefix (self)

QDoubleSpinBox.setDecimals (self, int prec)

QDoubleSpinBox.setMaximum (self, float max)

QDoubleSpinBox.setMinimum (self, float min)

QDoubleSpinBox.setPrefix (self, QString p)

QDoubleSpinBox.setRange (self, float min, float max)

Convenience function to set the minimum, min, and maximum, max, values with a single function call.

    setRange(min, max);

    setMinimum(min);
    setMaximum(max);

See also minimum and maximum.

QDoubleSpinBox.setSingleStep (self, float val)

QDoubleSpinBox.setSuffix (self, QString s)

QDoubleSpinBox.setValue (self, float val)

This method is also a Qt slot with the C++ signature void setValue(double).

float QDoubleSpinBox.singleStep (self)

QString QDoubleSpinBox.suffix (self)

QString QDoubleSpinBox.textFromValue (self, float v)

This virtual function is used by the spin box whenever it needs to display value v. The default implementation returns a string containing v printed using QLocale().toString(v, QLatin1Char('f'), decimals()) and will remove the thousand seperator. Reimplementations may return anything.

Note: QDoubleSpinBox does not call this function for specialValueText() and that neither prefix() nor suffix() should be included in the return value.

If you reimplement this, you may also need to reimplement valueFromText().

See also valueFromText().

(QValidator.State, int pos) QDoubleSpinBox.validate (self, QString input)

float QDoubleSpinBox.value (self)

float QDoubleSpinBox.valueFromText (self, QString text)

This virtual function is used by the spin box whenever it needs to interpret text entered by the user as a value.

Subclasses that need to display spin box values in a non-numeric way need to reimplement this function.

Note: QDoubleSpinBox handles specialValueText() separately; this function is only concerned with the other values.

See also textFromValue() and validate().

Qt Signal Documentation

void valueChanged (double)

This signal is emitted whenever the spin box's value is changed. The new value is passed in d.

void valueChanged (const QString&)

This is an overloaded member function, provided for convenience.

The new value is passed literally in text with no prefix() or suffix().