Class: QgsLabelSettingsWidgetBase

class qgis.gui.QgsLabelSettingsWidgetBase

Bases: QgsPanelWidget

Base class for widgets which allow customization of label engine properties, such as label placement settings.

New in version 3.12.

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

Parameters
actionEvent(self, QActionEvent)
auxiliaryFieldCreated

Emitted when an auxiliary field is created in the widget. [signal]

changeEvent(self, QEvent)
changed

Emitted when any of the settings described by the widget are changed. [signal]

childEvent(self, QChildEvent)
closeEvent(self, QCloseEvent)
connectNotify(self, QMetaMethod)
context(self)QgsSymbolWidgetContext

Returns the context in which the symbol widget is shown, e.g., the associated map canvas and expression contexts.

See also

setContext()

Return type

QgsSymbolWidgetContext

contextMenuEvent(self, QContextMenuEvent)
create(self, window: sip.voidptr = 0, initializeWindow: bool = True, destroyOldWindow: bool = True)
createExpressionContext(self)QgsExpressionContext
Return type

QgsExpressionContext

customEvent(self, QEvent)
dataDefinedProperties(self)QgsPropertyCollection

Returns the current data defined properties state as specified in the widget.

Return type

QgsPropertyCollection

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.

Parameters
resizeEvent(self, QResizeEvent)
sender(self)QObject
senderSignalIndex(self)int
setContext(self, context: QgsSymbolWidgetContext)

Sets the context in which the symbol widget is shown, e.g., the associated map canvas and expression contexts.

See also

context()

Parameters

context (QgsSymbolWidgetContext) –

setDataDefinedProperties(self, dataDefinedProperties: QgsPropertyCollection)

Sets the current data defined properties to show in the widget.

Parameters

dataDefinedProperties (QgsPropertyCollection) –

setGeometryType(self, type: QgsWkbTypes.GeometryType)

Sets the geometry type of the features to customize the widget accordingly.

Parameters

type (QgsWkbTypes.GeometryType) –

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

Updates a data defined properties collection, correctly setting the values for any properties related to this widget.

Parameters

properties (QgsPropertyCollection) –

updateMicroFocus(self)
wheelEvent(self, QWheelEvent)