QAbstractSpinBox

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

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

Synopsis

Functions

• def alignment ()

• def buttonSymbols ()

• def correctionMode ()

• def editingFinished ()

• def hasAcceptableInput ()

• def hasFrame ()

• def interpretText ()

• def isAccelerated ()

• def isGroupSeparatorShown ()

• def isReadOnly ()

• def keyboardTracking ()

• def lineEdit ()

• def selectAll ()

• def setAccelerated (on)

• def setAlignment (flag)

• def setButtonSymbols (bs)

• def setCorrectionMode (cm)

• def setFrame (arg__1)

• def setGroupSeparatorShown (shown)

• def setKeyboardTracking (kt)

• def setLineEdit (edit)

• def setReadOnly (r)

• def setSpecialValueText (txt)

• def setWrapping (w)

• def specialValueText ()

• def stepDown ()

• def stepUp ()

• def text ()

• def wrapping ()

Virtual functions

• def clear ()

• def fixup (input)

• def initStyleOption (option)

• def stepBy (steps)

• def stepEnabled ()

• def validate (input, pos)

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 Key_Down will trigger a call to stepBy (-1).

When the user triggers a step whilst holding the 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 KeyboardModifier increases the step rate. 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 .

See also

QAbstractSlider QSpinBox QDoubleSpinBox QDateTimeEdit Spin Boxes Example

class PySide6.QtWidgets.QAbstractSpinBox([parent=None])

Parameters

parent – PySide6.QtWidgets.QWidget

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

PySide6.QtWidgets.QAbstractSpinBox.StepEnabledFlag

Constant	Description
QAbstractSpinBox.StepNone
QAbstractSpinBox.StepUpEnabled
QAbstractSpinBox.StepDownEnabled

PySide6.QtWidgets.QAbstractSpinBox.ButtonSymbols

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

Constant	Description
QAbstractSpinBox.UpDownArrows	Little arrows in the classic style.
QAbstractSpinBox.PlusMinus	+ and - symbols.
QAbstractSpinBox.NoButtons	Don’t display buttons.

See also

buttonSymbols

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

PySide6.QtWidgets.QAbstractSpinBox.StepType

Constant	Description
QAbstractSpinBox.DefaultStepType
QAbstractSpinBox.AdaptiveDecimalStepType

New in version 5.12.

PySide6.QtWidgets.QAbstractSpinBox.alignment()

Return type

Alignment

See also

setAlignment()

PySide6.QtWidgets.QAbstractSpinBox.buttonSymbols()

Return type

ButtonSymbols

See also

setButtonSymbols()

PySide6.QtWidgets.QAbstractSpinBox.clear()

Clears the lineedit of all text but prefix and suffix.

PySide6.QtWidgets.QAbstractSpinBox.correctionMode()

Return type

CorrectionMode

See also

setCorrectionMode()

PySide6.QtWidgets.QAbstractSpinBox.editingFinished()

PySide6.QtWidgets.QAbstractSpinBox.fixup(input)

Parameters

input – str

This virtual function is called by the QAbstractSpinBox if the input is not validated to 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.

PySide6.QtWidgets.QAbstractSpinBox.hasAcceptableInput()

Return type

bool

PySide6.QtWidgets.QAbstractSpinBox.hasFrame()

Return type

bool

PySide6.QtWidgets.QAbstractSpinBox.initStyleOption(option)

Parameters

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

PySide6.QtWidgets.QAbstractSpinBox.interpretText()

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

PySide6.QtWidgets.QAbstractSpinBox.isAccelerated()

Return type

bool

PySide6.QtWidgets.QAbstractSpinBox.isGroupSeparatorShown()

Return type

bool

PySide6.QtWidgets.QAbstractSpinBox.isReadOnly()

Return type

bool

PySide6.QtWidgets.QAbstractSpinBox.keyboardTracking()

Return type

bool

See also

setKeyboardTracking()

PySide6.QtWidgets.QAbstractSpinBox.lineEdit()

Return type

PySide6.QtWidgets.QLineEdit

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

PySide6.QtWidgets.QAbstractSpinBox.selectAll()

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

PySide6.QtWidgets.QAbstractSpinBox.setAccelerated(on)

Parameters

on – bool

See also

isAccelerated()

PySide6.QtWidgets.QAbstractSpinBox.setAlignment(flag)

Parameters

flag – Alignment

See also

alignment()

PySide6.QtWidgets.QAbstractSpinBox.setButtonSymbols(bs)

Parameters

bs – ButtonSymbols

See also

buttonSymbols()

PySide6.QtWidgets.QAbstractSpinBox.setCorrectionMode(cm)

Parameters

cm – CorrectionMode

See also

correctionMode()

PySide6.QtWidgets.QAbstractSpinBox.setFrame(arg__1)

Parameters

arg__1 – bool

See also

hasFrame()

PySide6.QtWidgets.QAbstractSpinBox.setGroupSeparatorShown(shown)

Parameters

shown – bool

See also

isGroupSeparatorShown()

PySide6.QtWidgets.QAbstractSpinBox.setKeyboardTracking(kt)

Parameters

kt – bool

See also

keyboardTracking()

PySide6.QtWidgets.QAbstractSpinBox.setLineEdit(edit)

Parameters

edit – PySide6.QtWidgets.QLineEdit

PySide6.QtWidgets.QAbstractSpinBox.setReadOnly(r)

Parameters

r – bool

See also

isReadOnly()

PySide6.QtWidgets.QAbstractSpinBox.setSpecialValueText(txt)

Parameters

txt – str

See also

specialValueText()

PySide6.QtWidgets.QAbstractSpinBox.setWrapping(w)

Parameters

w – bool

See also

wrapping()

PySide6.QtWidgets.QAbstractSpinBox.specialValueText()

Return type

str

See also

setSpecialValueText()

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

PySide6.QtWidgets.QAbstractSpinBox.stepDown()

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

See also

stepBy() stepUp()

PySide6.QtWidgets.QAbstractSpinBox.stepEnabled()

Return type

StepEnabled

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

The up arrow will be painted as disabled unless ( & 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.

See also

minimum() maximum() wrapping()

PySide6.QtWidgets.QAbstractSpinBox.stepUp()

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

See also

stepBy() stepDown()

PySide6.QtWidgets.QAbstractSpinBox.text()

Return type

str

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

PySide6.QtWidgets.QAbstractSpinBox.wrapping()

Return type

bool

See also

setWrapping()