QDoubleSpinBox¶
The
QDoubleSpinBox
class provides a spin box widget that takes doubles. More…
Synopsis¶
Functions¶
def
cleanText
()def
decimals
()def
maximum
()def
minimum
()def
prefix
()def
setDecimals
(prec)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)
Signals¶
def
valueChanged
(arg__1)def
valueChanged
(arg__1)
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 withvalidate()
,textFromValue()
andvalueFromText()
.Every time the value changes
QDoubleSpinBox
emits twovalueChanged()
signals, one taking providing a double and the other aQString
. TheQString
overload provides the value with bothprefix()
andsuffix()
. The current value can be fetched withvalue()
and set withsetValue()
.Note:
QDoubleSpinBox
will round numbers so they can be displayed with the current precision. In aQDoubleSpinBox
with decimals set to 2, callingsetValue
(2.555) will causevalue()
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 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()
. The spinbox has a default precision of 2 decimal places but this can be changed usingsetDecimals()
.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 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 withQDoubleSpinBox
.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
-
class
QDoubleSpinBox
([parent=None])¶ - param parent
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
-
PySide2.QtWidgets.QDoubleSpinBox.
cleanText
()¶ - Return type
unicode
-
PySide2.QtWidgets.QDoubleSpinBox.
decimals
()¶ - Return type
int
See also
-
PySide2.QtWidgets.QDoubleSpinBox.
maximum
()¶ - Return type
double
See also
-
PySide2.QtWidgets.QDoubleSpinBox.
minimum
()¶ - Return type
double
See also
-
PySide2.QtWidgets.QDoubleSpinBox.
prefix
()¶ - Return type
unicode
See also
-
PySide2.QtWidgets.QDoubleSpinBox.
setDecimals
(prec)¶ - Parameters
prec –
int
See also
-
PySide2.QtWidgets.QDoubleSpinBox.
setRange
(min, max)¶ - Parameters
min –
double
max –
double
Convenience function to set the
minimum
andmaximum
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)
-
PySide2.QtWidgets.QDoubleSpinBox.
setSingleStep
(val)¶ - Parameters
val –
double
See also
-
PySide2.QtWidgets.QDoubleSpinBox.
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 thatsingleStep
comes into effect if adaptive decimal step is later turned off.See also
-
PySide2.QtWidgets.QDoubleSpinBox.
singleStep
()¶ - Return type
double
See also
-
PySide2.QtWidgets.QDoubleSpinBox.
stepType
()¶ - Return type
StepType
See also
-
PySide2.QtWidgets.QDoubleSpinBox.
suffix
()¶ - Return type
unicode
See also
-
PySide2.QtWidgets.QDoubleSpinBox.
textFromValue
(val)¶ - Parameters
val –
double
- Return type
unicode
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 usinglocale()
.toString(value
,QLatin1Char
(‘f’),decimals()
) and will remove the thousand separator unlesssetGroupSeparatorShown()
is set. Reimplementations may return anything.Note:
QDoubleSpinBox
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()
.See also
valueFromText()
groupSeparator()
-
PySide2.QtWidgets.QDoubleSpinBox.
value
()¶ - Return type
double
See also
-
PySide2.QtWidgets.QDoubleSpinBox.
valueChanged
(arg__1)¶ - Parameters
arg__1 – unicode
-
PySide2.QtWidgets.QDoubleSpinBox.
valueChanged
(arg__1) - Parameters
arg__1 –
double
-
PySide2.QtWidgets.QDoubleSpinBox.
valueFromText
(text)¶ - Parameters
text – unicode
- 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
handlesspecialValueText()
separately; this function is only concerned with the other values.See also
textFromValue()
validate()
© 2018 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.