Class: QgsLabelObstacleSettingsWidget

class qgis.gui.QgsLabelObstacleSettingsWidget

Bases: QgsLabelSettingsWidgetBase

A widget for customising label obstacle settings.

New in version 3.12.

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

Parameters
actionEvent(self, QActionEvent)
changeEvent(self, QEvent)
childEvent(self, QChildEvent)
closeEvent(self, QCloseEvent)
connectNotify(self, QMetaMethod)
contextMenuEvent(self, QContextMenuEvent)
create(self, window: sip.voidptr = 0, initializeWindow: bool = True, destroyOldWindow: bool = True)
createExpressionContext(self)QgsExpressionContext
customEvent(self, QEvent)
destroy(self, destroyWindow: bool = True, destroySubWindows: bool = True)
disconnectNotify(self, QMetaMethod)
dragEnterEvent(self, QDragEnterEvent)
dragLeaveEvent(self, QDragLeaveEvent)
dragMoveEvent(self, QDragMoveEvent)
dropEvent(self, QDropEvent)
enterEvent(self, QEvent)
event(self, QEvent)bool
focusInEvent(self, QFocusEvent)
focusNextChild(self)bool
focusNextPrevChild(self, bool)bool
focusOutEvent(self, QFocusEvent)
focusPreviousChild(self)bool
hideEvent(self, QHideEvent)
initPainter(self, QPainter)
inputMethodEvent(self, QInputMethodEvent)
isSignalConnected(self, QMetaMethod)bool
keyPressEvent(self, event: QKeyEvent)

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

Parameters

event – The key event

keyReleaseEvent(self, QKeyEvent)
leaveEvent(self, QEvent)
metric(self, QPaintDevice.PaintDeviceMetric)int
mouseDoubleClickEvent(self, QMouseEvent)
mouseMoveEvent(self, QMouseEvent)
mousePressEvent(self, QMouseEvent)
mouseReleaseEvent(self, QMouseEvent)
moveEvent(self, QMoveEvent)
nativeEvent(self, Union[QByteArray, bytes, bytearray], sip.voidptr)Tuple[bool, int]
paintEvent(self, QPaintEvent)
receivers(self, PYQT_SIGNAL)int
registerDataDefinedButton(self, button: QgsPropertyOverrideButton, 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, QResizeEvent)
sender(self)QObject
senderSignalIndex(self)int
setGeometryType(self, type: QgsWkbTypes.GeometryType)
Parameters

type (QgsWkbTypes.GeometryType) –

setSettings(self, settings: QgsLabelObstacleSettings)

Sets the obstacle settings to show in the widget.

See also

settings()

Parameters

settings (QgsLabelObstacleSettings) –

settings(self)QgsLabelObstacleSettings

Returns the obstacle settings defined by the widget.

See also

setSettings()

Return type

QgsLabelObstacleSettings

sharedPainter(self)QPainter
showEvent(self, QShowEvent)
tabletEvent(self, QTabletEvent)
timerEvent(self, QTimerEvent)
updateDataDefinedProperties(self, properties: QgsPropertyCollection)
Parameters

properties (QgsPropertyCollection) –

updateMicroFocus(self)
wheelEvent(self, QWheelEvent)