Class: QgsSpinBox

A spin box with a clear button that will set the value to the defined clear value.

The clear value can be either the minimum or the maiximum value of the spin box or a custom value. This value can then be handled by a special value text.

Class Hierarchy

Base classes

QSpinBox
QAbstractSpinBox
QWidget
QObject
QPaintDevice

Methods

clearValue	Returns the value used when clear() is called.
editingTimeoutInterval	Returns the timeout (in milliseconds) threshold for the editingTimeout() signal to be emitted after an edit.
expressionsEnabled	Returns whether the widget will allow entry of simple expressions, which are evaluated and then discarded.
setClearValue	Defines the clear value as a custom value and will automatically set the clear value mode to CustomValue.
setClearValueMode	Defines if the clear value should be the minimum or maximum values of the widget or a custom value.
setEditingTimeoutInterval	Sets the timeout (in milliseconds) threshold for the editingTimeout() signal to be emitted after an edit.
setExpressionsEnabled	Sets if the widget will allow entry of simple expressions, which are evaluated and then discarded.
setLineEditAlignment	Set alignment in the embedded line edit widget
setShowClearButton	Sets whether the widget will show a clear button.
setSpecialValueText	Set the special-value text to be txt If set, the spin box will display this text instead of a numeric value whenever the current value is equal to minimum().
showClearButton	Returns whether the widget is showing a clear button.

Virtual Methods

In PyQGIS, only methods marked as virtual can be safely overridden in a Python subclass of QgsSpinBox. See the FAQ for more details.

clear

Sets the current value to the value defined by the clear value.

Signals

editingTimeout	Emitted when either:
returnPressed	Emitted when the Return or Enter key is used in the line edit
textEdited	Emitted when the the value has been manually edited via line edit.

Attributes

CustomValue
MaximumValue
MinimumValue

class qgis.gui.QgsSpinBox

Bases: QSpinBox

__init__(parent: QWidget | None = None)

Constructor for QgsSpinBox.

Parameters:

parent (Optional[QWidget] = None) – parent widget

class ClearValueMode

Bases: int

CustomValue = 2

MaximumValue = 1

MinimumValue = 0

virtual clear(self)

Sets the current value to the value defined by the clear value.

clearValue(self) → int

Returns the value used when clear() is called.

See also

setClearValue()

Return type:

int

signal editingTimeout(value: int)

Emitted when either:

1. 1 second has elapsed since the last value change in the widget (eg last key press or scroll wheel event)

2. or, immediately after the widget has lost focus after its value was changed.

This signal can be used to respond semi-instantly to changes in the spin box, without responding too quickly while the user in the middle of setting the value.

See also

editingTimeoutInterval()

Added in version 3.42.

Parameters:

value (int)

editingTimeoutInterval(self) → int

Returns the timeout (in milliseconds) threshold for the editingTimeout() signal to be emitted after an edit.

See also

setEditingTimeoutInterval()

Added in version 3.42.

Return type:

int

expressionsEnabled(self) → bool

Returns whether the widget will allow entry of simple expressions, which are evaluated and then discarded.

Return type:

bool

Returns:

True if spin box allows expression entry

signal returnPressed

Emitted when the Return or Enter key is used in the line edit

Added in version 3.40.

setClearValue(self, customValue: int, clearValueText: str | None = '')

Defines the clear value as a custom value and will automatically set the clear value mode to CustomValue.

Parameters:

• customValue (int) – defines the numerical value used as the clear value

• clearValueText (Optional[str] = '') – is the text displayed when the spin box is at the clear value. If not specified, no special value text is used.

See also

setClearValue()

setClearValueMode(self, mode: QgsSpinBox.ClearValueMode, clearValueText: str | None = '')

Defines if the clear value should be the minimum or maximum values of the widget or a custom value.

Parameters:

• mode (QgsSpinBox.ClearValueMode) – mode to user for clear value

• clearValueText (Optional[str] = '') – is the text displayed when the spin box is at the clear value. If not specified, no special value text is used.

setEditingTimeoutInterval(self, timeout: int)

Sets the timeout (in milliseconds) threshold for the editingTimeout() signal to be emitted after an edit.

See also

editingTimeoutInterval()

See also

editingTimeout()

Added in version 3.42.

Parameters:

timeout (int)

setExpressionsEnabled(self, enabled: bool)

Sets if the widget will allow entry of simple expressions, which are evaluated and then discarded.

Parameters:

enabled (bool) – set to True to allow expression entry

setLineEditAlignment(self, alignment: Qt.Alignment | Qt.AlignmentFlag)

Set alignment in the embedded line edit widget

Parameters:

alignment (Union[Qt.Alignment, Qt.AlignmentFlag])

setShowClearButton(self, showClearButton: bool)

Sets whether the widget will show a clear button. The clear button allows users to reset the widget to a default or empty state.

Parameters:

showClearButton (bool) – set to True to show the clear button, or False to hide it

See also

showClearButton()

setSpecialValueText(self, txt: str | None)

Set the special-value text to be txt 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.

Parameters:

txt (Optional[str])

showClearButton(self) → bool

Returns whether the widget is showing a clear button.

See also

setShowClearButton()

Return type:

bool

signal textEdited(text: str)

Emitted when the the value has been manually edited via line edit.

Added in version 3.40.

Parameters:

text (str)