Subgroup: other

Class: QgsSpinBox

class qgis.gui.QgsSpinBox(parent: QWidget = None)

Bases: PyQt5.QtWidgets.QSpinBox

Constructor for QgsSpinBox.

Parameters:parent – parent widget

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.

Methods

actionEvent
changeEvent
childEvent
clear Sets the current value to the value defined by the clear value.
clearValue Returns the value used when clear() is called.
closeEvent
connectNotify
contextMenuEvent
create
customEvent
destroy
disconnectNotify
dragEnterEvent
dragLeaveEvent
dragMoveEvent
dropEvent
enterEvent
event
expressionsEnabled Returns whether the widget will allow entry of simple expressions, which are evaluated and then discarded.
fixup
focusInEvent
focusNextChild
focusNextPrevChild
focusOutEvent
focusPreviousChild
hideEvent
initPainter
initStyleOption
inputMethodEvent
isSignalConnected
keyPressEvent
keyReleaseEvent
leaveEvent
lineEdit
metric
mouseDoubleClickEvent
mouseMoveEvent
mousePressEvent
mouseReleaseEvent
moveEvent
nativeEvent
paintEvent
receivers
resizeEvent
sender
senderSignalIndex
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.
setExpressionsEnabled Sets if the widget will allow entry of simple expressions, which are evaluated and then discarded.
setLineEdit
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().
sharedPainter
showClearButton Returns whether the widget is showing a clear button.
showEvent
stepEnabled
tabletEvent
textFromValue
timerEvent
updateMicroFocus
validate
valueFromText
wheelEvent

Signals

Attributes

CustomValue
MaximumValue
MinimumValue
class ClearValueMode

Bases: int

CustomValue = 2
MaximumValue = 1
MinimumValue = 0
actionEvent()
changeEvent(self, event: QEvent)
childEvent()
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()

closeEvent()
connectNotify()
contextMenuEvent()
create()
customEvent()
destroy()
disconnectNotify()
dragEnterEvent()
dragLeaveEvent()
dragMoveEvent()
dropEvent()
enterEvent()
event()
expressionsEnabled(self) → bool

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

Returns:true if spin box allows expression entry

New in version 2.7.

fixup()
focusInEvent()
focusNextChild()
focusNextPrevChild()
focusOutEvent()
focusPreviousChild()
hideEvent()
initPainter()
initStyleOption()
inputMethodEvent()
isSignalConnected()
keyPressEvent()
keyReleaseEvent()
leaveEvent()
lineEdit()
metric()
mouseDoubleClickEvent()
mouseMoveEvent()
mousePressEvent()
mouseReleaseEvent()
moveEvent()
nativeEvent()
paintEvent(self, event: QPaintEvent)
receivers()
resizeEvent()
sender()
senderSignalIndex()
setClearValue(self, customValue: int, clearValueText: str = '')

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

Parameters:
  • customValue – defines the numerical value used as the clear value
  • clearValueText – 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 = '')

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

Parameters:
  • mode – mode to user for clear value
  • clearValueText – 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)

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

Parameters:enabled – set to true to allow expression entry

New in version 2.7.

setLineEdit()
setLineEditAlignment(self, alignment: Union[Qt.Alignment, Qt.AlignmentFlag])

Set alignment in the embedded line edit widget

Parameters:alignment
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 – set to true to show the clear button, or false to hide it
setSpecialValueText(self, txt: str)

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.

sharedPainter()
showClearButton(self) → bool

Returns whether the widget is showing a clear button.

showEvent()
stepEnabled()
tabletEvent()
textFromValue()
timerEvent()
updateMicroFocus()
validate(self, input: str) → Tuple[QValidator.State, int]
valueFromText(self, text: str) → int
wheelEvent(self, event: QWheelEvent)