Class: QgsSymbolLayerWidget¶

Abstract base class for widgets used to configure QgsSymbolLayer classes.

Note

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

The following methods must be implemented: setSymbolLayer(), symbolLayer()

Class Hierarchy¶

Base classes¶

QWidget
QObject
QPaintDevice

Subclasses¶

`QgsAnimatedMarkerSymbolLayerWidget`	A widget for configuring `QgsAnimatedMarkerSymbolLayer` symbol layers.
`QgsArrowSymbolLayerWidget`	A widget for configuring a `QgsArrowSymbolLayer`.
`QgsCentroidFillSymbolLayerWidget`	A widget for controlling the properties of a `QgsCentroidFillSymbolLayer`.
`QgsEllipseSymbolLayerWidget`	A widget for configuring a `QgsEllipseSymbolLayer`.
`QgsFilledLineSymbolLayerWidget`	A widget for configuring `QgsFilledLineSymbolLayer`.
`QgsFilledMarkerSymbolLayerWidget`	A widget for configuring `QgsFilledMarkerSymbolLayer` symbol layers.
`QgsFontMarkerSymbolLayerWidget`	A widget for controlling the properties of a `QgsFontMarkerSymbolLayer`.
`QgsGeometryGeneratorSymbolLayerWidget`	A widget for controlling the properties of a `QgsGeometryGeneratorSymbolLayer`.
`QgsGradientFillSymbolLayerWidget`	A widget for controlling the properties of a `QgsGradientFillSymbolLayer`.
`QgsHashedLineSymbolLayerWidget`	A widget for controlling the properties of a `QgsHashedLineSymbolLayer`.
`QgsInterpolatedLineSymbolLayerWidget`	A widget for configuring a `QgsInterpolatedLineSymbolLayer`.
`QgsLinePatternFillSymbolLayerWidget`	A widget for controlling the properties of a `QgsLinePatternFillSymbolLayer`.
`QgsLinearReferencingSymbolLayerWidget`	A widget for controlling the properties of a `QgsLinearReferencingSymbolLayer`.
`QgsLineburstSymbolLayerWidget`	A widget for configuring `QgsLineburstSymbolLayer` symbol layers.
`QgsMarkerLineSymbolLayerWidget`	A widget for controlling the properties of a `QgsMarkerLineSymbolLayer`.
`QgsMaskMarkerSymbolLayerWidget`	Symbol layer widget for the handling of `QgsMaskMarkerSymbolLayer`.
`QgsPointPatternFillSymbolLayerWidget`	A widget for controlling the properties of a `QgsPointPatternFillSymbolLayer`.
`QgsRandomMarkerFillSymbolLayerWidget`	A widget for controlling the properties of a `QgsRandomMarkerFillSymbolLayer`.
`QgsRasterFillSymbolLayerWidget`	A widget for controlling the properties of a `QgsRasterFillSymbolLayer`.
`QgsRasterLineSymbolLayerWidget`	A widget for configuring `QgsRasterLineSymbolLayer` symbol layers.
`QgsRasterMarkerSymbolLayerWidget`	A widget for configuring `QgsRasterMarkerSymbolLayer` symbol layers.
`QgsSVGFillSymbolLayerWidget`	A widget for controlling the properties of a `QgsSVGFillSymbolLayer`.
`QgsShapeburstFillSymbolLayerWidget`	A widget for controlling the properties of a `QgsShapeburstFillSymbolLayer`.
`QgsSimpleFillSymbolLayerWidget`	A widget for controlling the properties of a `QgsSimpleFillSymbolLayer`.
`QgsSimpleLineSymbolLayerWidget`	A widget for controlling the properties of a `QgsSimpleLineSymbolLayer`.
`QgsSimpleMarkerSymbolLayerWidget`	A widget for controlling the properties of a `QgsSimpleMarkerSymbolLayer`.
`QgsSvgMarkerSymbolLayerWidget`	A widget for controlling the properties of a `QgsSvgMarkerSymbolLayer`.
`QgsVectorFieldSymbolLayerWidget`	A widget for configuring a `QgsVectorFieldSymbolLayer`.

Abstract Methods

`setSymbolLayer`
`symbolLayer`

Methods

`context`	Returns the context in which the symbol widget is shown, e.g., the associated map canvas and expression contexts.
`registerDataDefinedButton`	Registers a data defined override button.
`updateDataDefinedProperty`
`vectorLayer`	Returns the vector layer associated with the widget.

Virtual Methods

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

`createExpressionContext`
`setContext`	Sets the context in which the symbol widget is shown, e.g., the associated map canvas and expression contexts.

Signals

`changed`	Should be emitted whenever configuration changes happened on this symbol layer configuration.
`symbolChanged`	Should be emitted whenever the sub symbol changed on this symbol layer configuration.

class qgis.gui.QgsSymbolLayerWidget[source]¶

Bases: QWidget

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

Constructor for QgsSymbolLayerWidget.

Parameters:

vl (Optional[QgsVectorLayer] = None) – associated vector layer
parent (Optional[QWidget]) – parent widget

signal changed[source]¶: Should be emitted whenever configuration changes happened on this symbol layer configuration. If the subsymbol is changed, symbolChanged() should be emitted instead.

context(self) → QgsSymbolWidgetContext[source]¶

Returns the context in which the symbol widget is shown, e.g., the associated map canvas and expression contexts.