Class: QgsLabelingEngineRuleWidget

Base class for widgets which allow control over the properties of QgsAbstractLabelingEngineRule subclasses.

See also

QgsLabelingEngineRulesWidget for a widget for configuring multiple rules

See also

QgsLabelingEngineRuleDialog

Added in version 3.40.

Note

This is an abstract class, with methods which must be implemented by a subclass.

The following methods must be implemented: rule(), setRule()

Class Hierarchy

Base classes

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

class qgis.gui.QgsLabelingEngineRuleWidget

Bases: QgsPanelWidget

__init__(parent: QWidget | None = None)

Constructor for QgsLabelingEngineRuleWidget.

Parameters:

parent (Optional[QWidget] = None)

signal changed

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.

abstract rule(self) → QgsAbstractLabelingEngineRule | None

Returns the rule defined by the current settings in the widget.

Ownership of the returned object is transferred to the caller

See also

setRule()

Return type:

Optional[QgsAbstractLabelingEngineRule]

abstract setRule(self, rule: QgsAbstractLabelingEngineRule | None)

Sets the rule to show in the widget. Ownership is not transferred.

See also

rule()

Parameters:

rule (Optional[QgsAbstractLabelingEngineRule])