Class: QgsLabelObstacleSettingsWidget¶

class qgis.gui.QgsLabelObstacleSettingsWidget¶

Bases: QgsLabelSettingsWidgetBase

A widget for customising label obstacle settings.

Added in version 3.12.

QgsLabelObstacleSettingsWidget(parent: Optional[QWidget] = None, vl: Optional[QgsVectorLayer] = None) Constructor for QgsLabelObstacleSettingsWidget.

Parameters:

parent – parent widget

vl –

associated vector layer

Methods

`actionEvent`
`changeEvent`
`childEvent`
`closeEvent`
`connectNotify`
`contextMenuEvent`
`create`
`createExpressionContext`
`customEvent`
`destroy`
`disconnectNotify`
`dragEnterEvent`
`dragLeaveEvent`
`dragMoveEvent`
`dropEvent`
`enterEvent`
`event`
`focusInEvent`
`focusNextChild`
`focusNextPrevChild`
`focusOutEvent`
`focusPreviousChild`
`hideEvent`
`initPainter`
`inputMethodEvent`
`isSignalConnected`
`keyPressEvent`	Overridden key press event to handle the esc event on the widget.
`keyReleaseEvent`
`leaveEvent`
`metric`
`mouseDoubleClickEvent`
`mouseMoveEvent`
`mousePressEvent`
`mouseReleaseEvent`
`moveEvent`
`nativeEvent`
`paintEvent`
`receivers`
`registerDataDefinedButton`	Registers a data defined override `button`.
`resizeEvent`
`sender`
`senderSignalIndex`
`setGeometryType`	param type:
`setSettings`	Sets the obstacle `settings` to show in the widget.
`settings`	Returns the obstacle settings defined by the widget.
`sharedPainter`
`showEvent`
`tabletEvent`
`timerEvent`
`updateDataDefinedProperties`	param properties:
`updateMicroFocus`
`wheelEvent`

actionEvent(self, a0: QActionEvent | None)¶

changeEvent(self, a0: QEvent | None)¶

childEvent(self, a0: QChildEvent | None)¶

closeEvent(self, a0: QCloseEvent | None)¶

connectNotify(self, signal: QMetaMethod)¶

contextMenuEvent(self, a0: QContextMenuEvent | None)¶

create(self, window: PyQt5.sip.voidptr = None, initializeWindow: bool = True, destroyOldWindow: bool = True)¶

createExpressionContext(self) → QgsExpressionContext¶

customEvent(self, a0: QEvent | None)¶

destroy(self, destroyWindow: bool = True, destroySubWindows: bool = True)¶

disconnectNotify(self, signal: QMetaMethod)¶

dragEnterEvent(self, a0: QDragEnterEvent | None)¶

dragLeaveEvent(self, a0: QDragLeaveEvent | None)¶

dragMoveEvent(self, a0: QDragMoveEvent | None)¶

dropEvent(self, a0: QDropEvent | None)¶

enterEvent(self, a0: QEvent | None)¶

event(self, a0: QEvent | None) → bool¶

focusInEvent(self, a0: QFocusEvent | None)¶

focusNextChild(self) → bool¶

focusNextPrevChild(self, next: bool) → bool¶

focusOutEvent(self, a0: QFocusEvent | None)¶

focusPreviousChild(self) → bool¶

hideEvent(self, a0: QHideEvent | None)¶

initPainter(self, painter: QPainter | None)¶

inputMethodEvent(self, a0: QInputMethodEvent | None)¶

isSignalConnected(self, signal: QMetaMethod) → bool¶

keyPressEvent(self, event: QKeyEvent | None)¶

Overridden key press event to handle the esc event on the widget.

Parameters:: event – The key event

keyReleaseEvent(self, a0: QKeyEvent | None)¶

leaveEvent(self, a0: QEvent | None)¶

metric(self, a0: QPaintDevice.PaintDeviceMetric) → int¶

mouseDoubleClickEvent(self, a0: QMouseEvent | None)¶

mouseMoveEvent(self, a0: QMouseEvent | None)¶

mousePressEvent(self, a0: QMouseEvent | None)¶

mouseReleaseEvent(self, a0: QMouseEvent | None)¶

moveEvent(self, a0: QMoveEvent | None)¶

nativeEvent(self, eventType: QByteArray | bytes | bytearray, message: PyQt5.sip.voidptr | None)¶

paintEvent(self, a0: QPaintEvent | None)¶

receivers(self, signal: PYQT_SIGNAL) → int¶

registerDataDefinedButton(self, button: QgsPropertyOverrideButton | None, key: QgsPalLayerSettings.Property)¶: Registers a data defined override button. Handles setting up connections for the button and initializing the button to show the correct descriptions and help text for the associated property.

resizeEvent(self, a0: QResizeEvent | None)¶

sender(self) → QObject | None¶

senderSignalIndex(self) → int¶

setGeometryType(self, type: Qgis.GeometryType)¶

Parameters:: type (Qgis.GeometryType)

setSettings(self, settings: QgsLabelObstacleSettings)¶

Sets the obstacle settings to show in the widget.