QAbstractSpinBox Class

See also QAbstractSlider, QSpinBox, QDoubleSpinBox, QDateTimeEdit, Spin Boxes Example

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

See Also▲

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

See Also▲

flags QAbstractSpinBox::StepEnabled

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

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:

• bool isAccelerated() const

• void setAccelerated(bool on)

This property holds whether the input satisfies the current validation

Access functions:

• bool hasAcceptableInput() const

See Also▲

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.

Access functions:

• alignment() const

• void setAlignment( flag)

See Also▲

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.

Access functions:

• buttonSymbols() const

• void setButtonSymbols( bs)

See Also▲

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

The default mode is QAbstractSpinBox::CorrectToPreviousValue.

Access functions:

• correctionMode() const

• void setCorrectionMode( cm)

See Also▲

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:

• bool hasFrame() const

• void setFrame(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:

• bool keyboardTracking() const

• void setKeyboardTracking(bool kt)

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.

Access functions:

• bool isReadOnly() const

• void setReadOnly(bool r)

See Also▲

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

This property was introduced in Qt 5.3.

Access functions:

• bool isGroupSeparatorShown() const

• void setGroupSeparatorShown(bool shown)

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:

    QSpinBox *zoomSpinBox = new 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 QSpinBox::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:

• specialValueText() const

• void setSpecialValueText(const &txt)

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

There is no default text.

Access functions:

• text() const

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.

QSpinBox *spinBox = new QSpinBox(this);
spinBox->setRange(0, 100);
spinBox->setWrapping(true);
spinBox->setValue(100);
spinBox->stepBy(1);
// value is 0

Access functions:

• bool wrapping() const

• void setWrapping(bool w)

See Also▲

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

Called when the QAbstractSpinBox is destroyed.

Reimplements: QWidget::changeEvent(QEvent *event).

Clears the lineedit of all text but prefix and suffix.

Reimplements: QWidget::closeEvent(QCloseEvent *event).

Reimplements: QWidget::contextMenuEvent(QContextMenuEvent *event).

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

Reimplements: QWidget::event(QEvent *event).

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.

Reimplements: QWidget::focusInEvent(QFocusEvent *event).

Reimplements: QWidget::focusOutEvent(QFocusEvent *event).

Reimplements: QWidget::hideEvent(QHideEvent *event).

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▲

Reimplements: QWidget::inputMethodQuery(Qt::InputMethodQuery query) const.

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

Reimplements: QWidget::keyPressEvent(QKeyEvent *event).

This function handles keyboard input.

The following keys are handled specifically:

See Also▲

Reimplements: QWidget::keyReleaseEvent(QKeyEvent *event).

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

See Also▲

Reimplements an access function for property: QWidget::minimumSizeHint.

Reimplements: QWidget::mouseMoveEvent(QMouseEvent *event).

Reimplements: QWidget::mousePressEvent(QMouseEvent *event).

Reimplements: QWidget::mouseReleaseEvent(QMouseEvent *event).

Reimplements: QWidget::paintEvent(QPaintEvent *event).

Reimplements: QWidget::resizeEvent(QResizeEvent *event).

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

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

QAbstractSpinBox takes ownership of the new lineEdit

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

See Also▲

Reimplements: QWidget::showEvent(QShowEvent *event).

Reimplements an access function for property: QWidget::sizeHint.

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▲

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

See Also▲

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▲

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

See Also▲

Reimplements: QObject::timerEvent(QTimerEvent *event).

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.

Reimplements: QWidget::wheelEvent(QWheelEvent *event).