PySide6.QtWidgets.QAbstractSpinBox

class QAbstractSpinBox

The QAbstractSpinBox class provides a spinbox and a line edit to display values. More…

Inheritance diagram of PySide6.QtWidgets.QAbstractSpinBox

Inherited by: QSpinBox, QDoubleSpinBox, QDateTimeEdit, QTimeEdit, QDateEdit

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

The class is designed as a common super class for widgets like QSpinBox , QDoubleSpinBox and QDateTimeEdit

Here are the main properties of the class:

  1. text : The text that is displayed in the QAbstractSpinBox .

  2. alignment : The alignment of the text in the QAbstractSpinBox .

  3. wrapping : Whether the QAbstractSpinBox wraps from the minimum value to the maximum value and vice versa.

QAbstractSpinBox provides a virtual stepBy() function that is called whenever the user triggers a step. This function takes an integer value to signify how many steps were taken. E.g. Pressing Qt::Key_Down will trigger a call to stepBy (-1).

When the user triggers a step whilst holding the Qt::ControlModifier, QAbstractSpinBox steps by 10 instead of making a single step. This step modifier affects wheel events, key events and interaction with the spinbox buttons. Note that on macOS, Control corresponds to the Command key.

Since Qt 5.12, SH_SpinBox_StepModifier can be used to select which Qt::KeyboardModifier increases the step rate. Qt::NoModifier disables this feature.

QAbstractSpinBox also provide a virtual function stepEnabled() to determine whether stepping up/down is allowed at any point. This function returns a bitset of StepEnabled .

class StepEnabledFlag

Constant

Description

QAbstractSpinBox.StepNone

QAbstractSpinBox.StepUpEnabled

QAbstractSpinBox.StepDownEnabled
class ButtonSymbols

This enum type describes the symbols that can be displayed on the buttons in a spin box.

qspinbox-updown1 qspinbox-plusminus2

Constant

Description

QAbstractSpinBox.UpDownArrows

Little arrows in the classic style.

QAbstractSpinBox.PlusMinus

+ and - symbols.

QAbstractSpinBox.NoButtons

Don’t display buttons.

See also

buttonSymbols

class CorrectionMode

This enum type describes the mode the spinbox will use to correct an Intermediate value if editing finishes.

Constant

Description

QAbstractSpinBox.CorrectToPreviousValue

The spinbox will revert to the last valid value.

QAbstractSpinBox.CorrectToNearestValue

The spinbox will revert to the nearest valid value.

See also

correctionMode

class StepType

Constant

Description

QAbstractSpinBox.DefaultStepType

QAbstractSpinBox.AdaptiveDecimalStepType

Note

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

property acceleratedᅟ: bool

This property holds whether the spin box will accelerate the frequency of the steps when pressing the step Up/Down buttons..

If enabled the spin box will increase/decrease the value faster the longer you hold the button down.

Access functions:
property acceptableInputᅟ: bool

This property holds whether the input satisfies the current validation.

Access functions:
property alignmentᅟ: Combination of Qt.AlignmentFlag

This property holds the alignment of the spin box.

Possible Values are Qt::AlignLeft, Qt::AlignRight, and Qt::AlignHCenter.

By default, the alignment is Qt::AlignLeft

Attempting to set the alignment to an illegal flag combination does nothing.

See also

Alignment

Access functions:
property buttonSymbolsᅟ: QAbstractSpinBox.ButtonSymbols

This property holds the current button symbol mode.

The possible values can be either UpDownArrows or PlusMinus. The default is UpDownArrows.

Note that some styles might render PlusMinus and UpDownArrows identically.

See also

ButtonSymbols

Access functions:
property correctionModeᅟ: QAbstractSpinBox.CorrectionMode

This property holds the mode to correct an Intermediate value if editing finishes.

The default mode is CorrectToPreviousValue .

See also

acceptableInput validate() fixup()

Access functions:
property frameᅟ: bool

This property holds whether the spin box draws itself with a frame.

If enabled (the default) the spin box draws itself inside a frame, otherwise the spin box draws itself without any frame.

Access functions:
property keyboardTrackingᅟ: bool

This property holds whether keyboard tracking is enabled for the spinbox..

If keyboard tracking is enabled (the default), the spinbox emits the valueChanged() and textChanged() signals while the new value is being entered from the keyboard.

E.g. when the user enters the value 600 by typing 6, 0, and 0, the spinbox emits 3 signals with the values 6, 60, and 600 respectively.

If keyboard tracking is disabled, the spinbox doesn’t emit the valueChanged() and textChanged() signals while typing. It emits the signals later, when the return key is pressed, when keyboard focus is lost, or when other spinbox functionality is used, e.g. pressing an arrow key.

Access functions:
property readOnlyᅟ: bool

This property holds whether the spin box is read only..

In read-only mode, the user can still copy the text to the clipboard, or drag and drop the text; but cannot edit it.

The QLineEdit in the QAbstractSpinBox does not show a cursor in read-only mode.

See also

readOnly

Access functions:
property showGroupSeparatorᅟ: bool

This property holds whether a thousands separator is enabled. By default this property is false..

Access functions:
property specialValueTextᅟ: str

Warning

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

This property holds the special-value text.

If set, the spin box will display this text instead of a numeric value whenever the current value is equal to minimum(). Typical use is to indicate that this choice has a special (default) meaning.

For example, if your spin box allows the user to choose a scale factor (or zoom level) for displaying an image, and your application is able to automatically choose one that will enable the image to fit completely within the display window, you can set up the spin box like this:

zoomSpinBox = QSpinBox()
zoomSpinBox.setRange(0, 1000)
zoomSpinBox.setSingleStep(10)
zoomSpinBox.setSuffix("%")
zoomSpinBox.setSpecialValueText(tr("Automatic"))
zoomSpinBox.setValue(100)

The user will then be able to choose a scale from 1% to 1000% or select “Auto” to leave it up to the application to choose. Your code must then interpret the spin box value of 0 as a request from the user to scale the image to fit inside the window.

All values are displayed with the prefix and suffix (if set), except for the special value, which only shows the special value text. This special text is passed in the textChanged() signal that passes a QString.

To turn off the special-value text display, call this function with an empty string. The default is no special-value text, i.e. the numeric value is shown as usual.

If no special-value text is set, specialValueText() returns an empty string.

Access functions:
property textᅟ: str

This property holds the spin box’s text, including any prefix and suffix.

There is no default text.

Access functions:
property wrappingᅟ: bool

Warning

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

This property holds whether the spin box is circular..

If wrapping is true stepping up from maximum() value will take you to the minimum() value and vice versa. Wrapping only make sense if you have minimum() and maximum() values set.

spinBox = QSpinBox(self)
spinBox.setRange(0, 100)
spinBox.setWrapping(True)
spinBox.setValue(100)
spinBox.stepBy(1)
# value is 0

See also

minimum() maximum()

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

parent – QWidget

Constructs an abstract spinbox with the given parent with default wrapping , and alignment properties.

alignment()
Return type:

Combination of AlignmentFlag

See also

setAlignment()

Getter of property alignmentᅟ .

buttonSymbols()
Return type:

ButtonSymbols

See also

setButtonSymbols()

Getter of property buttonSymbolsᅟ .

clear()

Clears the lineedit of all text but prefix and suffix.

correctionMode()
Return type:

CorrectionMode

See also

setCorrectionMode()

Getter of property correctionModeᅟ .

editingFinished()

This signal is emitted editing is finished. This happens when the spinbox loses focus and when enter is pressed.

fixup(input)
Parameters:

input – str

Return type:

QString

This virtual function is called by the QAbstractSpinBox if the input is not validated to QValidator::Acceptable when Return is pressed or interpretText() is called. It will try to change the text so it is valid. Reimplemented in the various subclasses.

hasAcceptableInput()
Return type:

bool

Getter of property acceptableInputᅟ .

hasFrame()
Return type:

bool

Getter of property frameᅟ .

initStyleOption(option)
Parameters:

option – QStyleOptionSpinBox

Initialize option with the values from this QSpinBox . This method is useful for subclasses when they need a QStyleOptionSpinBox , but don’t want to fill in all the information themselves.

See also

initFrom()

interpretText()

This function interprets the text of the spin box. If the value has changed since last interpretation it will emit signals.

isAccelerated()
Return type:

bool

Getter of property acceleratedᅟ .

isGroupSeparatorShown()
Return type:

bool

Getter of property showGroupSeparatorᅟ .

isReadOnly()
Return type:

bool

Getter of property readOnlyᅟ .

keyboardTracking()
Return type:

bool

See also

setKeyboardTracking()

Getter of property keyboardTrackingᅟ .

lineEdit()
Return type:

QLineEdit

This function returns a pointer to the line edit of the spin box.

See also

setLineEdit()

selectAll()

Selects all the text in the spinbox except the prefix and suffix.

setAccelerated(on)
Parameters:

on – bool

See also

isAccelerated()

Setter of property acceleratedᅟ .

setAlignment(flag)
Parameters:

flag – Combination of AlignmentFlag

See also

alignment()

Setter of property alignmentᅟ .

setButtonSymbols(bs)
Parameters:

bs – ButtonSymbols

See also

buttonSymbols()

Setter of property buttonSymbolsᅟ .

setCorrectionMode(cm)
Parameters:

cm – CorrectionMode

See also

correctionMode()

Setter of property correctionModeᅟ .

setFrame(arg__1)
Parameters:

arg__1 – bool

See also

hasFrame()

Setter of property frameᅟ .

setGroupSeparatorShown(shown)
Parameters:

shown – bool

See also

isGroupSeparatorShown()

Setter of property showGroupSeparatorᅟ .

setKeyboardTracking(kt)
Parameters:

kt – bool

See also

keyboardTracking()

Setter of property keyboardTrackingᅟ .

setLineEdit(edit)
Parameters:

edit – QLineEdit

Sets the line edit of the spinbox to be lineEdit instead of the current line edit widget. lineEdit cannot be None.

QAbstractSpinBox takes ownership of the new lineEdit

If validator() for the lineEdit returns None, the internal validator of the spinbox will be set on the line edit.

See also

lineEdit()

setReadOnly(r)
Parameters:

r – bool

See also

isReadOnly()

Setter of property readOnlyᅟ .

setSpecialValueText(txt)
Parameters:

txt – str

See also

specialValueText()

Setter of property specialValueTextᅟ .

setWrapping(w)
Parameters:

w – bool

See also

wrapping()

Setter of property wrappingᅟ .

specialValueText()
Return type:

str

See also

setSpecialValueText()

Getter of property specialValueTextᅟ .

stepBy(steps)
Parameters:

steps – int

Virtual function that is called whenever the user triggers a step. The steps parameter indicates how many steps were taken. For example, pressing Qt::Key_Down will trigger a call to stepBy(-1), whereas pressing Qt::Key_PageUp will trigger a call to stepBy(10).

If you subclass QAbstractSpinBox you must reimplement this function. Note that this function is called even if the resulting value will be outside the bounds of minimum and maximum. It’s this function’s job to handle these situations.

See also

stepUp() stepDown() keyPressEvent()

stepDown()

Steps down by one linestep Calling this slot is analogous to calling stepBy (-1);

See also

stepBy() stepUp()

stepEnabled()
Return type:

Combination of StepEnabledFlag

Virtual function that determines whether stepping up and down is legal at any given time.

The up arrow will be painted as disabled unless (stepEnabled() & StepUpEnabled ) != 0.

The default implementation will return ( StepUpEnabled | StepDownEnabled ) if wrapping is turned on. Else it will return StepDownEnabled if value is > minimum() or’ed with StepUpEnabled if value < maximum().

If you subclass QAbstractSpinBox you will need to reimplement this function.

stepUp()

Steps up by one linestep Calling this slot is analogous to calling stepBy (1);

See also

stepBy() stepDown()

text()
Return type:

str

Getter of property textᅟ .

validate(input, pos)
Parameters:

  • input – str

  • pos – int

Return type:

PyObject

This virtual function is called by the QAbstractSpinBox to determine whether input is valid. The pos parameter indicates the position in the string. Reimplemented in the various subclasses.

wrapping()
Return type:

bool

See also

setWrapping()

Getter of property wrappingᅟ .