Class: QgsLabelSettingsWidgetBase¶

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

Added in version 3.12.

Class Hierarchy¶

Base classes¶

`QgsPanelWidget`	Base class for any widget that can be shown as an inline panel.
QWidget
QObject
QPaintDevice

Subclasses¶

`QgsLabelLineAnchorWidget`	A widget for customising label line anchor settings.
`QgsLabelObstacleSettingsWidget`	A widget for customising label obstacle settings.
`QgsLabelRemoveDuplicatesSettingsWidget`	A widget for customising label duplicate removal settings.

class qgis.gui.QgsLabelSettingsWidgetBase[source]¶

Bases: QgsPanelWidget

__init__(parent: QWidget | None = None, vl: QgsMapLayer | None = None)

Constructor for QgsLabelSettingsWidgetBase.

Parameters:

parent (Optional[QWidget] = None) – parent widget
vl (Optional[QgsMapLayer] = None) – associated map layer

signal auxiliaryFieldCreated[source]¶

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

signal changed[source]¶

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

context(self) → QgsSymbolWidgetContext[source]¶

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

virtual createExpressionContext(self) → QgsExpressionContext[source]¶

Return type:: QgsExpressionContext

dataDefinedProperties(self) → QgsPropertyCollection[source]¶

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

See also

updateDataDefinedProperties()

See also

setDataDefinedProperties()

Return type:: QgsPropertyCollection

registerDataDefinedButton(self, button: QgsPropertyOverrideButton | None, key: QgsPalLayerSettings.Property)[source]¶

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: