QDoubleSpinBox

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

Inheritance diagram of PySide2.QtWidgets.QDoubleSpinBox

Synopsis

Functions

Virtual functions

Slots

Signals

Detailed Description

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. 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 valueChanged() and textChanged() signals, the former providing a double and the latter a QString . The textChanged() signal provides the value with both prefix() and suffix() . 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 .

Note

The displayed value of the QDoubleSpinBox is limited to 18 characters in addition to eventual prefix and suffix content. This limitation is used to keep the double spin box usable even with extremely large values.

See also

QSpinBox QDateTimeEdit QSlider Spin Boxes Example

class PySide2.QtWidgets.QDoubleSpinBox([parent=None])

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() setSingleStep()

PySide2.QtWidgets.QDoubleSpinBox.cleanText()
Return type:

str

This property holds the text of the spin box excluding any prefix, suffix, or leading or trailing whitespace..

See also

text prefix suffix

PySide2.QtWidgets.QDoubleSpinBox.decimals()
Return type:

int

This property holds the precision of the spin box, in decimals.

Sets how many decimals the spinbox will use for displaying and interpreting doubles.

Warning

The maximum value for decimals is DBL_MAX_10_EXP + DBL_DIG (ie. 323) because of the limitations of the double type.

Note: The maximum, minimum and value might change as a result of changing this property.

PySide2.QtWidgets.QDoubleSpinBox.maximum()
Return type:

double

This property holds the maximum value of the spin box.

When setting this property the minimum is adjusted if necessary, to ensure that the range remains valid.

The default maximum value is 99.99.

Note: The maximum value will be rounded to match the decimals property.

See also

decimals setRange()

PySide2.QtWidgets.QDoubleSpinBox.minimum()
Return type:

double

This property holds the minimum value of the spin box.

When setting this property the maximum is adjusted if necessary to ensure that the range remains valid.

The default minimum value is 0.0.

Note: The minimum value will be rounded to match the decimals property.

See also

decimals setRange() specialValueText

PySide2.QtWidgets.QDoubleSpinBox.prefix()
Return type:

str

This property holds the spin box’s prefix.

The prefix is prepended to the start of the displayed value. Typical use is to display a unit of measurement or a currency symbol. For example:

spinbox.setPrefix("$")

To turn off the prefix display, set this property to an empty string. The default is no prefix. The prefix is not displayed when value() == minimum() and specialValueText() is set.

If no prefix is set, returns an empty string.

See also

suffix() setSuffix() specialValueText() setSpecialValueText()

PySide2.QtWidgets.QDoubleSpinBox.setDecimals(prec)
Parameters:

prec – int

This property holds the precision of the spin box, in decimals.

Sets how many decimals the spinbox will use for displaying and interpreting doubles.

Warning

The maximum value for decimals is DBL_MAX_10_EXP + DBL_DIG (ie. 323) because of the limitations of the double type.

Note: The maximum, minimum and value might change as a result of changing this property.

PySide2.QtWidgets.QDoubleSpinBox.setMaximum(max)
Parameters:

max – double

This property holds the maximum value of the spin box.

When setting this property the minimum is adjusted if necessary, to ensure that the range remains valid.

The default maximum value is 99.99.

Note: The maximum value will be rounded to match the decimals property.

See also

decimals setRange()

PySide2.QtWidgets.QDoubleSpinBox.setMinimum(min)
Parameters:

min – double

This property holds the minimum value of the spin box.

When setting this property the maximum is adjusted if necessary to ensure that the range remains valid.

The default minimum value is 0.0.

Note: The minimum value will be rounded to match the decimals property.

See also

decimals setRange() specialValueText

PySide2.QtWidgets.QDoubleSpinBox.setPrefix(prefix)
Parameters:

prefix – str

This property holds the spin box’s prefix.

The prefix is prepended to the start of the displayed value. Typical use is to display a unit of measurement or a currency symbol. For example:

spinbox.setPrefix("$")

To turn off the prefix display, set this property to an empty string. The default is no prefix. The prefix is not displayed when value() == minimum() and specialValueText() is set.

If no prefix is set, returns an empty string.

See also

suffix() setSuffix() specialValueText() setSpecialValueText()

PySide2.QtWidgets.QDoubleSpinBox.setRange(min, max)
Parameters:

  • min – double

  • max – double

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

Note: The maximum and minimum values will be rounded to match the decimals property.

setRange(minimum, maximum)

is equivalent to:

setMinimum(minimum)
setMaximum(maximum)

See also

minimum maximum

PySide2.QtWidgets.QDoubleSpinBox.setSingleStep(val)
Parameters:

val – double

This property holds the step value.

When the user uses the arrows to change the spin box’s value the value will be incremented/decremented by the amount of the . The default value is 1.0. Setting a value of less than 0 does nothing.

PySide2.QtWidgets.QDoubleSpinBox.setStepType(stepType)
Parameters:

stepType – StepType

This property holds The step type..

The step type can be single step or adaptive decimal step.

PySide2.QtWidgets.QDoubleSpinBox.setSuffix(suffix)
Parameters:

suffix – str

This property holds the suffix of the spin box.

The suffix is appended to the end of the displayed value. Typical use is to display a unit of measurement or a currency symbol. For example:

spinbox.setSuffix(" km")

To turn off the suffix display, set this property to an empty string. The default is no suffix. The suffix is not displayed for the minimum() if specialValueText() is set.

If no suffix is set, returns an empty string.

See also

prefix() setPrefix() specialValueText() setSpecialValueText()

PySide2.QtWidgets.QDoubleSpinBox.setValue(val)
Parameters:

val – double

This property holds the value of the spin box.

will emit valueChanged() if the new value is different from the old one. The value property has a second notifier signal which includes the spin box’s prefix and suffix.

Note: The value will be rounded so it can be displayed with the current setting of decimals.

See also

decimals

PySide2.QtWidgets.QDoubleSpinBox.singleStep()
Return type:

double

This property holds the step value.

When the user uses the arrows to change the spin box’s value the value will be incremented/decremented by the amount of the . The default value is 1.0. Setting a value of less than 0 does nothing.

PySide2.QtWidgets.QDoubleSpinBox.stepType()
Return type:

StepType

This property holds The step type..

The step type can be single step or adaptive decimal step.

PySide2.QtWidgets.QDoubleSpinBox.suffix()
Return type:

str

This property holds the suffix of the spin box.

The suffix is appended to the end of the displayed value. Typical use is to display a unit of measurement or a currency symbol. For example:

spinbox.setSuffix(" km")

To turn off the suffix display, set this property to an empty string. The default is no suffix. The suffix is not displayed for the minimum() if specialValueText() is set.

If no suffix is set, returns an empty string.

See also

prefix() setPrefix() specialValueText() setSpecialValueText()

PySide2.QtWidgets.QDoubleSpinBox.textChanged(arg__1)
Parameters:

arg__1 – str

PySide2.QtWidgets.QDoubleSpinBox.textFromValue(val)
Parameters:

val – double

Return type:

str

This virtual function is used by the spin box whenever it needs to display the given value . The default implementation returns a string containing value printed using locale() .toString(value , QLatin1Char (‘f’), decimals() ) and will remove the thousand separator unless setGroupSeparatorShown() is set. 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() groupSeparator()

PySide2.QtWidgets.QDoubleSpinBox.value()
Return type:

double

This property holds the value of the spin box.

will emit valueChanged() if the new value is different from the old one. The value property has a second notifier signal which includes the spin box’s prefix and suffix.

Note: The value will be rounded so it can be displayed with the current setting of decimals.

See also

decimals

PySide2.QtWidgets.QDoubleSpinBox.valueChanged(arg__1)
Parameters:

arg__1 – str

Note

This function is deprecated.

PySide2.QtWidgets.QDoubleSpinBox.valueChanged(arg__1)
Parameters:

arg__1 – double

PySide2.QtWidgets.QDoubleSpinBox.valueFromText(text)
Parameters:

text – str

Return type:

double

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() validate()