QSpinBox#

The QSpinBox class provides a spin box widget. More…

Inheritance diagram of PySide6.QtWidgets.QSpinBox

Synopsis#

Functions#

Virtual functions#

Slots#

Signals#

Detailed Description#

../../_images/windows-spinbox.png

QSpinBox is designed to handle integers and discrete sets of values (e.g., month names); use QDoubleSpinBox for floating point values.

QSpinBox allows the user to choose a value by clicking the up/down buttons or pressing up/down on the keyboard to increase/decrease the value currently displayed. The user can also type the value in manually. The spin box supports integer values but can be extended to use different strings with validate() , textFromValue() and valueFromText() .

Every time the value changes QSpinBox emits valueChanged() and textChanged() signals, the former providing a int 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() .

Clicking the up/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 behaviour 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() .

Most spin boxes are directional, but QSpinBox can also operate as a circular spin box, i.e. if the range is 0-99 and the current value is 99, 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 QSpinBox .

Subclassing QSpinBox#

If using prefix() , suffix() , and specialValueText() don’t provide enough control, you subclass QSpinBox and reimplement valueFromText() and textFromValue() . For example, here’s the code for a custom spin box that allows the user to enter icon sizes (e.g., “32 x 32”):

def valueFromText(self, QString text):

    regExp = QRegularExpression(tr("(\\d+)(\\s*[xx]\\s*\\d+)?"))
    Q_ASSERT(regExp.isValid())
    match = regExp.match(text)
    if match.isValid():
        return match.captured(1).toInt()
    return 0
def textFromValue(self, int value):

    return tr("%1 x %1").arg(value)

See the Icons example for the full source code.

class PySide6.QtWidgets.QSpinBox([parent=None])#
Parameters

parent – PySide6.QtWidgets.QWidget

Constructs a spin box with 0 as minimum value and 99 as maximum value, a step value of 1. The value is initially set to 0. It is parented to parent.

PySide6.QtWidgets.QSpinBox.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

PySide6.QtWidgets.QSpinBox.displayIntegerBase()#
Return type

int

This property holds the base used to display the value of the spin box.

The default displayIntegerBase value is 10.

PySide6.QtWidgets.QSpinBox.maximum()#
Return type

int

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.

PySide6.QtWidgets.QSpinBox.minimum()#
Return type

int

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.

PySide6.QtWidgets.QSpinBox.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:

sb.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.

PySide6.QtWidgets.QSpinBox.setDisplayIntegerBase(base)#
Parameters

base – int

This property holds the base used to display the value of the spin box.

The default displayIntegerBase value is 10.

PySide6.QtWidgets.QSpinBox.setMaximum(max)#
Parameters

max – int

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.

PySide6.QtWidgets.QSpinBox.setMinimum(min)#
Parameters

min – int

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.

PySide6.QtWidgets.QSpinBox.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:

sb.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.

PySide6.QtWidgets.QSpinBox.setRange(min, max)#
Parameters

  • min – int

  • max – int

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

setRange(minimum, maximum)

is equivalent to:

setMinimum(minimum)
setMaximum(maximum)

See also

minimum maximum

PySide6.QtWidgets.QSpinBox.setSingleStep(val)#
Parameters

val – int

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

PySide6.QtWidgets.QSpinBox.setStepType(stepType)#
Parameters

stepType – StepType

This property holds The step type..

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

PySide6.QtWidgets.QSpinBox.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:

sb.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.

PySide6.QtWidgets.QSpinBox.setValue(val)#
Parameters

val – int

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.

PySide6.QtWidgets.QSpinBox.singleStep()#
Return type

int

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

PySide6.QtWidgets.QSpinBox.stepType()#
Return type

StepType

This property holds The step type..

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

PySide6.QtWidgets.QSpinBox.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:

sb.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.

PySide6.QtWidgets.QSpinBox.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() .

PySide6.QtWidgets.QSpinBox.textFromValue(val)#
Parameters

val – int

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 in the standard way using locale() .toString(), but with the thousand separator removed unless setGroupSeparatorShown() is set. Reimplementations may return anything. (See the example in the detailed description.)

Note: QSpinBox 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() and validate()

See also

valueFromText() validate() groupSeparator()

PySide6.QtWidgets.QSpinBox.value()#
Return type

int

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.

PySide6.QtWidgets.QSpinBox.valueChanged(arg__1)#
Parameters

arg__1 – int

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

PySide6.QtWidgets.QSpinBox.valueFromText(text)#
Parameters

text – str

Return type

int

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: QSpinBox handles specialValueText() separately; this function is only concerned with the other values.

See also

textFromValue() validate()