QSpinBox¶
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
singleStep
()def
stepType
()def
suffix
()def
value
()
Virtual functions¶
def
textFromValue
(val)def
valueFromText
(text)
Slots¶
def
setValue
(val)
Signals¶
def
textChanged
(arg__1)def
valueChanged
(arg__1)def
valueChanged
(arg__1)
Detailed Description¶
QSpinBox
is designed to handle integers and discrete sets of values (e.g., month names); useQDoubleSpinBox
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 withvalidate()
,textFromValue()
andvalueFromText()
.Every time the value changes
QSpinBox
emitsvalueChanged()
andtextChanged()
signals, the former providing a int and the latter aQString
. ThetextChanged()
signal provides the value with bothprefix()
andsuffix()
. The current value can be fetched withvalue()
and set withsetValue()
.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 functionstepBy()
. The minimum and maximum value and the step size can be set using one of the constructors, and can be changed later withsetMinimum()
,setMaximum()
andsetSingleStep()
.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 ifwrapping()
is set to true. UsesetWrapping()
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()
andsetSuffix()
. The text in the spin box is retrieved withtext()
(which includes anyprefix()
andsuffix()
), or withcleanText()
(which has noprefix()
, nosuffix()
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 withQSpinBox
.
Subclassing QSpinBox¶
If using
prefix()
,suffix()
, andspecialValueText()
don’t provide enough control, you subclassQSpinBox
and reimplementvalueFromText()
andtextFromValue()
. 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 PySide2.QtWidgets.QSpinBox([parent=None])¶
- param parent:
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
- PySide2.QtWidgets.QSpinBox.cleanText()¶
- Return type:
str
This property holds the text of the spin box excluding any prefix, suffix, or leading or trailing whitespace..
- PySide2.QtWidgets.QSpinBox.displayIntegerBase()¶
- Return type:
int
This property holds the base used to display the value of the spin box.
The default value is 10.
See also
- PySide2.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.
See also
- PySide2.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.
See also
- PySide2.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()
andspecialValueText()
is set.If no prefix is set, returns an empty string.
- PySide2.QtWidgets.QSpinBox.setDisplayIntegerBase(base)¶
- Parameters:
base – int
This property holds the base used to display the value of the spin box.
The default value is 10.
See also
- PySide2.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.
See also
- PySide2.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.
See also
- PySide2.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()
andspecialValueText()
is set.If no prefix is set, returns an empty string.
- PySide2.QtWidgets.QSpinBox.setRange(min, max)¶
- Parameters:
min – int
max – int
Convenience function to set the
minimum
, andmaximum
values with a single function call.setRange(minimum, maximum)
is equivalent to:
setMinimum(minimum) setMaximum(maximum)
- PySide2.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 . The default value is 1. Setting a value of less than 0 does nothing.
- PySide2.QtWidgets.QSpinBox.setStepType(stepType)¶
- Parameters:
stepType –
StepType
This property holds The step type..
The step type can be single step or adaptive decimal step.
- PySide2.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()
ifspecialValueText()
is set.If no suffix is set, returns an empty string.
- PySide2.QtWidgets.QSpinBox.setValue(val)¶
- Parameters:
val – int
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.
- PySide2.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 . The default value is 1. Setting a value of less than 0 does nothing.
- PySide2.QtWidgets.QSpinBox.stepType()¶
- Return type:
This property holds The step type..
The step type can be single step or adaptive decimal step.
- PySide2.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()
ifspecialValueText()
is set.If no suffix is set, returns an empty string.
- PySide2.QtWidgets.QSpinBox.textChanged(arg__1)¶
- Parameters:
arg__1 – str
- PySide2.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 containingvalue
printed in the standard way usinglocale()
.toString(), but with the thousand separator removed unlesssetGroupSeparatorShown()
is set. Reimplementations may return anything. (See the example in the detailed description.)Note:
QSpinBox
does not call this function forspecialValueText()
and that neitherprefix()
norsuffix()
should be included in the return value.If you reimplement this, you may also need to reimplement
valueFromText()
andvalidate()
See also
valueFromText()
validate()
groupSeparator()
- PySide2.QtWidgets.QSpinBox.value()¶
- Return type:
int
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.
- PySide2.QtWidgets.QSpinBox.valueChanged(arg__1)¶
- Parameters:
arg__1 – str
Note
This function is deprecated.
def callback_unicode(value_as_unicode): print 'unicode value changed:', repr(value_as_unicode) app = QApplication(sys.argv) spinbox = QSpinBox() spinbox.valueChanged[unicode].connect(callback_unicode) spinbox.show() sys.exit(app.exec_())
- PySide2.QtWidgets.QSpinBox.valueChanged(arg__1)
- Parameters:
arg__1 – int
def callback_int(value_as_int): print 'int value changed:', repr(value_as_int) app = QApplication(sys.argv) spinbox = QSpinBox() spinbox.valueChanged[unicode].connect(callback_unicode) spinbox.show() sys.exit(app.exec_())
- PySide2.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
handlesspecialValueText()
separately; this function is only concerned with the other values.See also
textFromValue()
validate()
© 2022 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.