QSpinBox¶
The QSpinBox
class provides a spin box widget. More…

Synopsis¶
Functions¶
def
cleanText
()def
displayIntegerBase
()def
maximum
()def
minimum
()def
prefix
()def
setDisplayIntegerBase
(base)def
setMaximum
(max)def
setMinimum
(min)def
setPrefix
(prefix)def
setRange
(min, max)def
setSingleStep
(val)def
setStepType
(stepType)def
setSuffix
(suffix)def
setValue
(val)def
singleStep
()def
stepType
()def
suffix
()def
textChanged
(arg__1)def
value
()def
valueChanged
(arg__1)
Virtual functions¶
def
textFromValue
(val)def
valueFromText
(text)
Detailed Description¶
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 .
Every time the value changes QSpinBox
emits valueChanged()
and signals, the former providing a int and the latter a QString
. The 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 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, text): regExp = QRegExp(tr("(\\d+)(\\s*[xx]\\s*\\d+)?")) if regExp.exactMatch(text): return regExp.cap(1).toInt() else: return 0 def textFromValue(self, value): return self.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
.
See also
-
PySide6.QtWidgets.QSpinBox.
cleanText
()¶ - Return type
str
-
PySide6.QtWidgets.QSpinBox.
displayIntegerBase
()¶ - Return type
int
See also
-
PySide6.QtWidgets.QSpinBox.
maximum
()¶ - Return type
int
See also
-
PySide6.QtWidgets.QSpinBox.
minimum
()¶ - Return type
int
See also
-
PySide6.QtWidgets.QSpinBox.
prefix
()¶ - Return type
str
See also
-
PySide6.QtWidgets.QSpinBox.
setDisplayIntegerBase
(base)¶ - Parameters
base – int
See also
-
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:
-
PySide6.QtWidgets.QSpinBox.
setSingleStep
(val)¶ - Parameters
val – int
See also
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.
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
-
PySide6.QtWidgets.QSpinBox.
singleStep
()¶ - Return type
int
See also
-
PySide6.QtWidgets.QSpinBox.
stepType
()¶ - Return type
See also
-
PySide6.QtWidgets.QSpinBox.
suffix
()¶ - Return type
str
See also
-
PySide6.QtWidgets.QSpinBox.
textChanged
(arg__1)¶ - Parameters
arg__1 – str
-
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 and validate()
See also
validate()
groupSeparator()
-
PySide6.QtWidgets.QSpinBox.
value
()¶ - Return type
int
See also
-
PySide6.QtWidgets.QSpinBox.
valueChanged
(arg__1)¶ - Parameters
arg__1 – int
-
PySide6.QtWidgets.QSpinBox.
valueFromText
(text)¶ - Parameters
text – str
- Return type
int
© 2021 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.