Class: QgsSpinBox¶
The QgsSpinBox
is 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¶
Methods
Sets the current value to the value defined by the clear value. |
|
Returns the value used when |
|
Returns whether the widget will allow entry of simple expressions, which are evaluated and then discarded. |
|
Defines the clear value as a custom value and will automatically set the clear value mode to CustomValue. |
|
Defines if the clear value should be the minimum or maximum values of the widget or a custom value. |
|
Sets if the widget will allow entry of simple expressions, which are evaluated and then discarded. |
|
Set alignment in the embedded line edit widget |
|
Sets whether the widget will show a clear button. |
|
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 |
|
Returns whether the widget is showing a clear button. |
Signals
Emitted when the Return or Enter key is used in the line edit |
|
Emitted when the the value has been manually edited via line edit. |
Attributes
- class qgis.gui.QgsSpinBox[source]¶
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¶
- clearValue(self) int [source]¶
Returns the value used when
clear()
is called.See also
- Return type:
int
- expressionsEnabled(self) bool [source]¶
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[source]¶
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 = '')[source]¶
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
- setClearValueMode(self, mode: QgsSpinBox.ClearValueMode, clearValueText: str | None = '')[source]¶
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.
- setExpressionsEnabled(self, enabled: bool)[source]¶
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)[source]¶
Set alignment in the embedded line edit widget
- Parameters:
alignment (Union[Qt.Alignment, Qt.AlignmentFlag])
- setShowClearButton(self, showClearButton: bool)[source]¶
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, orFalse
to hide it
See also
- setSpecialValueText(self, txt: str | None)[source]¶
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 tominimum()
. Typical use is to indicate that this choice has a special (default) meaning.- Parameters:
txt (Optional[str])