Class: QgsLabelingEngineRulesWidget¶

A widget which allows configuration of a list of labeling engine rules.

This widget allows users to add, remove, and edit the properties of a list of QgsAbstractLabelingEngineRule objects.

Class Hierarchy¶

Base classes¶

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

class qgis.gui.QgsLabelingEngineRulesWidget[source]¶

Bases: QgsPanelWidget

__init__(parent: QWidget | None = None)

Constructor for QgsLabelingEngineRulesWidget.

Parameters:: parent (Optional[QWidget] = None)

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.

rules(self) → List[QgsAbstractLabelingEngineRule]¶

Returns the rules shown in the widget.

The caller takes ownership of all returned rules.

Return type:: List[QgsAbstractLabelingEngineRule]

setRules(self, rules: Iterable[QgsAbstractLabelingEngineRule])[source]¶

Sets the rules to show in the widget.

Ownership is not transferred, an internal copy will be made.

Parameters:: rules (Iterable[QgsAbstractLabelingEngineRule])