Class: QgsSymbolLayerWidget

Class Hierarchy

Base classes

QWidget
QObject
QPaintDevice

Subclasses

QgsAnimatedMarkerSymbolLayerWidget	Widget for configuring QgsAnimatedMarkerSymbolLayer symbol layers.
QgsArrowSymbolLayerWidget	param layer: the layer where this symbol layer is applied :param parent: the parent widget
QgsCentroidFillSymbolLayerWidget	Constructor for QgsCentroidFillSymbolLayerWidget.
QgsEllipseSymbolLayerWidget	Constructor for QgsEllipseSymbolLayerWidget.
QgsFilledLineSymbolLayerWidget	A widget for configuring QgsFilledLineSymbolLayer.
QgsFilledMarkerSymbolLayerWidget	Widget for configuring QgsFilledMarkerSymbolLayer symbol layers.
QgsFontMarkerSymbolLayerWidget	Constructor for QgsFontMarkerSymbolLayerWidget.
QgsGeometryGeneratorSymbolLayerWidget	Constructor for QgsGeometryGeneratorSymbolLayerWidget.
QgsGradientFillSymbolLayerWidget	Constructor for QgsGradientFillSymbolLayerWidget.
QgsHashedLineSymbolLayerWidget	Widget for controlling the properties of a QgsHashedLineSymbolLayer.
QgsInterpolatedLineSymbolLayerWidget	QgsInterpolatedLineSymbolLayerWidget
QgsLinePatternFillSymbolLayerWidget	Constructor for QgsLinePatternFillSymbolLayerWidget.
QgsLinearReferencingSymbolLayerWidget	Widget for controlling the properties of a QgsLinearReferencingSymbolLayer.
QgsLineburstSymbolLayerWidget	Widget for configuring QgsLineburstSymbolLayer symbol layers.
QgsMarkerLineSymbolLayerWidget	Constructor for QgsMarkerLineSymbolLayerWidget.
QgsMaskMarkerSymbolLayerWidget	Symbol layer widget for the handling of QgsMaskMarkerSymbolLayer.
QgsPointPatternFillSymbolLayerWidget	Constructor for QgsPointPatternFillSymbolLayerWidget.
QgsRandomMarkerFillSymbolLayerWidget	Widget for controlling the properties of a QgsRandomMarkerFillSymbolLayer.
QgsRasterFillSymbolLayerWidget	Constructor for QgsRasterFillSymbolLayerWidget.
QgsRasterLineSymbolLayerWidget	Widget for configuring QgsRasterLineSymbolLayer symbol layers.
QgsRasterMarkerSymbolLayerWidget	Widget for configuring QgsRasterMarkerSymbolLayer symbol layers.
QgsSVGFillSymbolLayerWidget	Constructor for QgsSVGFillSymbolLayerWidget.
QgsShapeburstFillSymbolLayerWidget	Constructor for QgsShapeburstFillSymbolLayerWidget.
QgsSimpleFillSymbolLayerWidget	Constructor for QgsSimpleFillSymbolLayerWidget.
QgsSimpleLineSymbolLayerWidget	Constructor for QgsSimpleLineSymbolLayerWidget.
QgsSimpleMarkerSymbolLayerWidget	Constructor for QgsSimpleMarkerSymbolLayerWidget.
QgsSvgMarkerSymbolLayerWidget	Constructor for QgsSvgMarkerSymbolLayerWidget.
QgsVectorFieldSymbolLayerWidget	Constructor for QgsVectorFieldSymbolLayerWidget.

Methods

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

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(parent: QWidget | None, vl: QgsVectorLayer | None = None)

Bases: QWidget

signal changed

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

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

See also

setContext()

Return type:

QgsSymbolWidgetContext

createExpressionContext(self) → QgsExpressionContext

Return type:

QgsExpressionContext

registerDataDefinedButton(self, button: QgsPropertyOverrideButton | None, key: QgsSymbolLayer.Property)

Registers a data defined override button. Handles setting up connections for the button and initializing the button to show the correct descriptions and help text for the associated property.

Parameters:

• button (Optional[QgsPropertyOverrideButton])

• key (QgsSymbolLayer.Property)

setContext(self, context: QgsSymbolWidgetContext)

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

Parameters:

context (QgsSymbolWidgetContext) – symbol widget context

See also

context()

setSymbolLayer(self, layer: QgsSymbolLayer | None)

Parameters:

layer (Optional[QgsSymbolLayer])

signal symbolChanged

Should be emitted whenever the sub symbol changed on this symbol layer configuration. Normally changed() should be preferred.

See also

changed()

symbolLayer(self) → QgsSymbolLayer | None

Return type:

Optional[QgsSymbolLayer]

updateDataDefinedProperty(self)

vectorLayer(self) → QgsVectorLayer | None

Returns the vector layer associated with the widget.

Return type:

Optional[QgsVectorLayer]