Class: QgsRendererRulePropsWidget¶

A widget for editing the details of a rule based renderer rule.

Class Hierarchy¶

Base classes¶

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

Methods

`apply`	Apply any changes from the widget to the set rule.
`buildExpression`	Open the expression builder widget to check if the
`rule`	Returns the current set rule.
`testFilter`	Test the filter that is set in the widget

Virtual Methods

In PyQGIS, only methods marked as virtual can be safely overridden in a Python subclass of QgsRendererRulePropsWidget. See the FAQ for more details.

setDockMode

Set the widget in dock mode.

class qgis.gui.QgsRendererRulePropsWidget[source]¶

Bases: QgsPanelWidget

__init__(rule: QgsRuleBasedRenderer.Rule | None, layer: QgsVectorLayer | None, style: QgsStyle | None, parent: QWidget | None = None, context: QgsSymbolWidgetContext = QgsSymbolWidgetContext())

Widget to edit the details of a rule based renderer rule.

Parameters:

rule (Optional[QgsRuleBasedRenderer.Rule]) – The rule to edit.
layer (Optional[QgsVectorLayer]) – The layer used to pull layer related information.
style (Optional[QgsStyle]) – The active QGIS style.
parent (Optional[QWidget] = None) – The parent widget.
context (QgsSymbolWidgetContext = QgsSymbolWidgetContext()) – the symbol widget context

apply(self)[source]¶: Apply any changes from the widget to the set rule.

buildExpression(self)[source]¶: Open the expression builder widget to check if the

rule(self) → QgsRuleBasedRenderer.Rule | None[source]¶

Returns the current set rule.

Return type:: Optional[QgsRuleBasedRenderer.Rule]
Returns:: The current rule.

virtual setDockMode(self, dockMode: bool)[source]¶

Set the widget in dock mode.

Parameters:: dockMode (bool) – True for dock mode.

testFilter(self)[source]¶: Test the filter that is set in the widget