PySide6.QtWidgets.QDoubleSpinBox

class QDoubleSpinBox

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

Inheritance diagram of PySide6.QtWidgets.QDoubleSpinBox

Synopsis

Properties

Methods

Virtual methods

Slots

Signals

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

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

Note

Properties can be used directly when from __feature__ import true_property is used or via accessor functions otherwise.

property cleanTextᅟ: str

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

See also

text prefix suffix

Access functions:
property decimalsᅟ: 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.

Access functions:
property maximumᅟ: float

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

Access functions:
property minimumᅟ: float

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.

Access functions:
property prefixᅟ: str

Warning

This section contains snippets that were automatically translated from C++ to Python and may contain errors.

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, prefix() returns an empty string.

Access functions:
property singleStepᅟ: float

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 singleStep. The default value is 1.0. Setting a singleStep value of less than 0 does nothing.

Access functions:
property stepTypeᅟ: QAbstractSpinBox.StepType

This property holds The step type..

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

Access functions:
property suffixᅟ: str

Warning

This section contains snippets that were automatically translated from C++ to Python and may contain errors.

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, suffix() returns an empty string.

Access functions:
property valueᅟ: float

This property holds the value of the spin box.

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

Access functions:
__init__([parent=None])
Parameters:

parent – QWidget

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.

cleanText()
Return type:

str

Getter of property cleanTextᅟ .

decimals()
Return type:

int

See also

setDecimals()

Getter of property decimalsᅟ .

maximum()
Return type:

float

See also

setMaximum()

Getter of property maximumᅟ .

minimum()
Return type:

float

See also

setMinimum()

Getter of property minimumᅟ .

prefix()
Return type:

str

See also

setPrefix()

Getter of property prefixᅟ .

setDecimals(prec)
Parameters:

prec – int

See also

decimals()

Setter of property decimalsᅟ .

setMaximum(max)
Parameters:

max – float

See also

maximum()

Setter of property maximumᅟ .

setMinimum(min)
Parameters:

min – float

See also

minimum()

Setter of property minimumᅟ .

setPrefix(prefix)
Parameters:

prefix – str

See also

prefix()

Setter of property prefixᅟ .

setRange(min, max)
Parameters:

  • min – float

  • max – float

Warning

This section contains snippets that were automatically translated from C++ to Python and may contain errors.

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

setSingleStep(val)
Parameters:

val – float

See also

singleStep()

Setter of property singleStepᅟ .

setStepType(stepType)
Parameters:

stepType – StepType

Sets the step type for the spin box to stepType, which is single step or adaptive decimal step.

Adaptive decimal step means that the step size will continuously be adjusted to one power of ten below the current value . So when the value is 1100, the step is set to 100, so stepping up once increases it to 1200. For 1200 stepping up takes it to 1300. For negative values, stepping down from -1100 goes to -1200.

It also works for any decimal values, 0.041 is increased to 0.042 by stepping once.

Step direction is taken into account to handle edges cases, so that stepping down from 100 takes the value to 99 instead of 90. Thus a step up followed by a step down – or vice versa – always lands on the starting value; 99 -> 100 -> 99.

Setting this will cause the spin box to disregard the value of singleStep , although it is preserved so that singleStep comes into effect if adaptive decimal step is later turned off.

See also

stepType()

Setter of property stepTypeᅟ .

setSuffix(suffix)
Parameters:

suffix – str

See also

suffix()

Setter of property suffixᅟ .

setValue(val)
Parameters:

val – float

See also

value()

Setter of property valueᅟ .

singleStep()
Return type:

float

See also

setSingleStep()

Getter of property singleStepᅟ .

stepType()
Return type:

StepType

See also

setStepType()

Getter of property stepTypeᅟ .

suffix()
Return type:

str

See also

setSuffix()

Getter of property suffixᅟ .

textChanged(arg__1)
Parameters:

arg__1 – str

This signal is emitted whenever the spin box’s text is changed. The new text is passed in text with prefix() and suffix() .

textFromValue(val)
Parameters:

val – float

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, u'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() .

value()
Return type:

float

See also

setValue()

Getter of property valueᅟ .

valueChanged(arg__1)
Parameters:

arg__1 – float

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

Notification signal of property valueᅟ .

valueFromText(text)
Parameters:

text – str

Return type:

float

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