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

Abstract Methods

rule	Returns the rule defined by the current settings in the widget.
setRule	Sets the rule to show in the widget.

Signals

changed

Emitted whenever the configuration of the rule is changed.

class qgis.gui.QgsLabelingEngineRuleWidget

Bases: QgsPanelWidget

__init__(parent: QWidget | None = None)

Constructor for QgsLabelingEngineRuleWidget.

Parameters:

parent (Optional[QWidget] = None)

signal changed

Emitted whenever the configuration of the rule is changed.

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])