|  | Home · All Classes · Modules

# QAbstractSpinBox Class Reference
[QtGui module]

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

Inherits QWidget.

Inherited by QDateTimeEdit, QDoubleSpinBox and QSpinBox.

### Types

- enum ButtonSymbols { UpDownArrows, PlusMinus, NoButtons }
- enum CorrectionMode { CorrectToPreviousValue, CorrectToNearestValue }
- class StepEnabled
- enum StepEnabledFlag { StepNone, StepUpEnabled, StepDownEnabled }

### Methods

- __init__ (self, QWidget parent = None)
- Qt.Alignment alignment (self)
- ButtonSymbols buttonSymbols (self)
- changeEvent (self, QEvent e)
- clear (self)
- closeEvent (self, QCloseEvent e)
- contextMenuEvent (self, QContextMenuEvent e)
- CorrectionMode correctionMode (self)
- bool event (self, QEvent event)
- QString input fixup (self, QString input)
- fixup (self, QString input)
- focusInEvent (self, QFocusEvent e)
- focusOutEvent (self, QFocusEvent e)
- bool hasAcceptableInput (self)
- bool hasFrame (self)
- hideEvent (self, QHideEvent e)
- initStyleOption (self, QStyleOptionSpinBox option)
- QVariant inputMethodQuery (self, Qt.InputMethodQuery)
- interpretText (self)
- bool isAccelerated (self)
- bool isReadOnly (self)
- bool keyboardTracking (self)
- keyPressEvent (self, QKeyEvent e)
- keyReleaseEvent (self, QKeyEvent e)
- QLineEdit lineEdit (self)
- QSize minimumSizeHint (self)
- mouseMoveEvent (self, QMouseEvent e)
- mousePressEvent (self, QMouseEvent e)
- mouseReleaseEvent (self, QMouseEvent e)
- paintEvent (self, QPaintEvent e)
- resizeEvent (self, QResizeEvent e)
- selectAll (self)
- setAccelerated (self, bool on)
- setAlignment (self, Qt.Alignment flag)
- setButtonSymbols (self, ButtonSymbols bs)
- setCorrectionMode (self, CorrectionMode cm)
- setFrame (self, bool)
- setKeyboardTracking (self, bool kt)
- setLineEdit (self, QLineEdit e)
- setReadOnly (self, bool r)
- setSpecialValueText (self, QString s)
- setWrapping (self, bool w)
- showEvent (self, QShowEvent e)
- QSize sizeHint (self)
- QString specialValueText (self)
- stepBy (self, int steps)
- stepDown (self)
- StepEnabled stepEnabled (self)
- stepUp (self)
- QString text (self)
- timerEvent (self, QTimerEvent e)
- (QValidator.State, QString input, int pos) validate (self, QString input, int pos)
- (QValidator.State, int pos) validate (self, QString input, int pos)
- wheelEvent (self, QWheelEvent e)
- bool wrapping (self)

### Qt Signals

- void editingFinished ()

## Detailed Description

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

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 vica 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).

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.

## Type Documentation

### QAbstractSpinBox.ButtonSymbols

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

Constant | Value | Description
--- | --- | ---
`QAbstractSpinBox.UpDownArrows` | `0` | Little arrows in the classic style.
`QAbstractSpinBox.PlusMinus` | `1` | + and - symbols.
`QAbstractSpinBox.NoButtons` | `2` | Don't display buttons.

See also QAbstractSpinBox.buttonSymbols.

### QAbstractSpinBox.CorrectionMode

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

Constant | Value | Description
--- | --- | ---
`QAbstractSpinBox.CorrectToPreviousValue` | `0` | The spinbox will revert to the last valid value.
`QAbstractSpinBox.CorrectToNearestValue` | `1` | The spinbox will revert to the nearest valid value.

See also correctionMode.

### QAbstractSpinBox.StepEnabledFlag

Constant | Value
--- | ---
`QAbstractSpinBox.StepNone` | `0x00`
`QAbstractSpinBox.StepUpEnabled` | `0x01`
`QAbstractSpinBox.StepDownEnabled` | `0x02`

The StepEnabled type is a typedef for QFlags<StepEnabledFlag>. It stores an OR combination of StepEnabledFlag values.

## Method Documentation

### QAbstractSpinBox.__init__ (self, QWidget parent = None)

The parent argument, if not None, causes self to be owned by Qt instead of PyQt.

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

### Qt.Alignment QAbstractSpinBox.alignment (self)

### ButtonSymbols QAbstractSpinBox.buttonSymbols (self)

### QAbstractSpinBox.changeEvent (self, QEvent e)

Reimplemented from QWidget.changeEvent().

### QAbstractSpinBox.clear (self)

This method is also a Qt slot with the C++ signature `void clear()`.

Clears the lineedit of all text but prefix and suffix.

### QAbstractSpinBox.closeEvent (self, QCloseEvent e)

Reimplemented from QWidget.closeEvent().

### QAbstractSpinBox.contextMenuEvent (self, QContextMenuEvent e)

Reimplemented from QWidget.contextMenuEvent().

### CorrectionMode QAbstractSpinBox.correctionMode (self)

### bool QAbstractSpinBox.event (self, QEvent event)

Reimplemented from QObject.event().

### QString input QAbstractSpinBox.fixup (self, QString input)

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.

### QAbstractSpinBox.fixup (self, QString input)

### QAbstractSpinBox.focusInEvent (self, QFocusEvent e)

Reimplemented from QWidget.focusInEvent().

### QAbstractSpinBox.focusOutEvent (self, QFocusEvent e)

Reimplemented from QWidget.focusOutEvent().

### bool QAbstractSpinBox.hasAcceptableInput (self)

### bool QAbstractSpinBox.hasFrame (self)

### QAbstractSpinBox.hideEvent (self, QHideEvent e)

Reimplemented from QWidget.hideEvent().

### QAbstractSpinBox.initStyleOption (self, QStyleOptionSpinBox option)

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 QStyleOption.initFrom().

### QVariant QAbstractSpinBox.inputMethodQuery (self, Qt.InputMethodQuery)

Reimplemented from QWidget.inputMethodQuery().

### QAbstractSpinBox.interpretText (self)

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

### bool QAbstractSpinBox.isAccelerated (self)

### bool QAbstractSpinBox.isReadOnly (self)

### bool QAbstractSpinBox.keyboardTracking (self)

### QAbstractSpinBox.keyPressEvent (self, QKeyEvent e)

Reimplemented from QWidget.keyPressEvent().

This function handles keyboard input.

The following keys are handled specifically:

Enter/Return | This will reinterpret the text and emit a signal even if the value has not changed since last time a signal was emitted.
Up | This will invoke stepBy(1)
Down | This will invoke stepBy(-1)
Page up | This will invoke stepBy(10)
Page down | This will invoke stepBy(-10)

### QAbstractSpinBox.keyReleaseEvent (self, QKeyEvent e)

Reimplemented from QWidget.keyReleaseEvent().

### QLineEdit QAbstractSpinBox.lineEdit (self)

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

See also setLineEdit().

### QSize QAbstractSpinBox.minimumSizeHint (self)

Reimplemented from QWidget.minimumSizeHint().

### QAbstractSpinBox.mouseMoveEvent (self, QMouseEvent e)

Reimplemented from QWidget.mouseMoveEvent().

### QAbstractSpinBox.mousePressEvent (self, QMouseEvent e)

Reimplemented from QWidget.mousePressEvent().

### QAbstractSpinBox.mouseReleaseEvent (self, QMouseEvent e)

Reimplemented from QWidget.mouseReleaseEvent().

### QAbstractSpinBox.paintEvent (self, QPaintEvent e)

Reimplemented from QWidget.paintEvent().

### QAbstractSpinBox.resizeEvent (self, QResizeEvent e)

Reimplemented from QWidget.resizeEvent().

### QAbstractSpinBox.selectAll (self)

This method is also a Qt slot with the C++ signature `void selectAll()`.

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

### QAbstractSpinBox.setAccelerated (self, bool on)

### QAbstractSpinBox.setAlignment (self, Qt.Alignment flag)

### QAbstractSpinBox.setButtonSymbols (self, ButtonSymbols bs)

### QAbstractSpinBox.setCorrectionMode (self, CorrectionMode cm)

### QAbstractSpinBox.setFrame (self, bool)

### QAbstractSpinBox.setKeyboardTracking (self, bool kt)

### QAbstractSpinBox.setLineEdit (self, QLineEdit e)

The e argument has it's ownership transferred to Qt.

Sets the line edit of the spinbox to be lineEdit instead of the current line edit widget. lineEdit can not be 0.

QAbstractSpinBox takes ownership of the new lineEdit

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

See also lineEdit().

### QAbstractSpinBox.setReadOnly (self, bool r)

### QAbstractSpinBox.setSpecialValueText (self, QString s)

### QAbstractSpinBox.setWrapping (self, bool w)

### QAbstractSpinBox.showEvent (self, QShowEvent e)

Reimplemented from QWidget.showEvent().

### QSize QAbstractSpinBox.sizeHint (self)

Reimplemented from QWidget.sizeHint().

### QString QAbstractSpinBox.specialValueText (self)

### QAbstractSpinBox.stepBy (self, int steps)

Virtual function that is called whenever the user triggers a step. The steps parameter indicates how many steps were taken, e.g. Pressing Qt.Key_Down will trigger a call to stepBy(-1), whereas pressing Qt.Key_Prior 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.

### QAbstractSpinBox.stepDown (self)

This method is also a Qt slot with the C++ signature `void stepDown()`.

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

See also stepBy() and stepUp().

### StepEnabled QAbstractSpinBox.stepEnabled (self)

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.

See also QSpinBox.minimum(), QSpinBox.maximum(), and wrapping().

### QAbstractSpinBox.stepUp (self)

This method is also a Qt slot with the C++ signature `void stepUp()`.

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

See also stepBy() and stepDown().

### QString QAbstractSpinBox.text (self)

### QAbstractSpinBox.timerEvent (self, QTimerEvent e)

Reimplemented from QObject.timerEvent().

### (QValidator.State, QString input, int pos) QAbstractSpinBox.validate (self, QString input, int pos)

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.

### (QValidator.State, int pos) QAbstractSpinBox.validate (self, QString input, int pos)

### QAbstractSpinBox.wheelEvent (self, QWheelEvent e)

Reimplemented from QWidget.wheelEvent().

### bool QAbstractSpinBox.wrapping (self)

## Qt Signal Documentation

### void editingFinished ()

This is the default overload of this signal.

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