Abstract base class for widgets used to configure QgsSymbolLayer classes. More...

#include <qgssymbollayerwidget.h>

Inheritance diagram for QgsSymbolLayerWidget:

[legend]

Signals
void	changed ()
	Should be emitted whenever configuration changes happened on this symbol layer configuration.
void	symbolChanged ()
	Should be emitted whenever the sub symbol changed on this symbol layer configuration.

Public Member Functions
	QgsSymbolLayerWidget (QWidget parent, QgsVectorLayer vl=nullptr)
	Constructor for QgsSymbolLayerWidget.
QgsSymbolWidgetContext	context () const
	Returns the context in which the symbol widget is shown, e.g., the associated map canvas and expression contexts.
virtual void	setContext (const QgsSymbolWidgetContext &context)
	Sets the context in which the symbol widget is shown, e.g., the associated map canvas and expression contexts.
virtual void	setSymbolLayer (QgsSymbolLayer *layer)=0
virtual QgsSymbolLayer *	symbolLayer ()=0
QgsVectorLayer *	vectorLayer () const
	Returns the vector layer associated with the widget.
Public Member Functions inherited from QgsExpressionContextGenerator
virtual	~QgsExpressionContextGenerator ()=default

Protected Slots
void	updateDataDefinedProperty ()

Protected Member Functions
QgsExpressionContext	createExpressionContext () const override
	This method needs to be reimplemented in all classes which implement this interface and return an expression context.
void	registerDataDefinedButton (QgsPropertyOverrideButton *button, QgsSymbolLayer::Property key)
	Registers a data defined override button.

Detailed Description

Abstract base class for widgets used to configure QgsSymbolLayer classes.

Definition at line 41 of file qgssymbollayerwidget.h.

Constructor & Destructor Documentation

◆ QgsSymbolLayerWidget()

QgsSymbolLayerWidget::QgsSymbolLayerWidget	(	QWidget *	parent,
		QgsVectorLayer *	vl = nullptr )

inline

Constructor for QgsSymbolLayerWidget.

Parameters

vl	associated vector layer
parent	parent widget

Definition at line 51 of file qgssymbollayerwidget.h.

Member Function Documentation

◆ changed

void QgsSymbolLayerWidget::changed ( )

signal

Should be emitted whenever configuration changes happened on this symbol layer configuration.

If the subsymbol is changed, symbolChanged() should be emitted instead.

◆ context()

QgsSymbolWidgetContext QgsSymbolLayerWidget::context ( ) const

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

See also: setContext()

Definition at line 140 of file qgssymbollayerwidget.cpp.

◆ createExpressionContext()

QgsExpressionContext QgsSymbolLayerWidget::createExpressionContext ( ) const

overrideprotectedvirtual

This method needs to be reimplemented in all classes which implement this interface and return an expression context.

Implements QgsExpressionContextGenerator.

Definition at line 71 of file qgssymbollayerwidget.cpp.

◆ registerDataDefinedButton()

void QgsSymbolLayerWidget::registerDataDefinedButton	(	QgsPropertyOverrideButton *	button,
		QgsSymbolLayer::Property	key )

protected

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.

Definition at line 145 of file qgssymbollayerwidget.cpp.

◆ setContext()

void QgsSymbolLayerWidget::setContext ( const QgsSymbolWidgetContext & context )

virtual

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

Parameters

context symbol widget context

See also: context()

Reimplemented in QgsAnimatedMarkerSymbolLayerWidget, QgsLinearReferencingSymbolLayerWidget, QgsRasterMarkerSymbolLayerWidget, QgsSimpleLineSymbolLayerWidget, QgsSVGFillSymbolLayerWidget, QgsSvgMarkerSymbolLayerWidget, and QgsTemplatedLineSymbolLayerWidget.

Definition at line 130 of file qgssymbollayerwidget.cpp.

◆ setSymbolLayer()

virtual void QgsSymbolLayerWidget::setSymbolLayer ( QgsSymbolLayer * layer )

pure virtual

◆ symbolChanged

void QgsSymbolLayerWidget::symbolChanged ( )

signal

Should be emitted whenever the sub symbol changed on this symbol layer configuration.

Normally changed() should be preferred.

See also: changed()

◆ symbolLayer()

virtual QgsSymbolLayer * QgsSymbolLayerWidget::symbolLayer ( )

pure virtual

◆ updateDataDefinedProperty

void QgsSymbolLayerWidget::updateDataDefinedProperty ( )

protectedslot

Definition at line 194 of file qgssymbollayerwidget.cpp.

◆ vectorLayer()

QgsVectorLayer * QgsSymbolLayerWidget::vectorLayer ( ) const

inline

Returns the vector layer associated with the widget.

Definition at line 75 of file qgssymbollayerwidget.h.

The documentation for this class was generated from the following files:

/build/qgis-3.99.0+git20260202+e9821da5c6b+99sid/src/gui/symbology/qgssymbollayerwidget.h
/build/qgis-3.99.0+git20260202+e9821da5c6b+99sid/src/gui/symbology/qgssymbollayerwidget.cpp

Signals

Public Member Functions

Protected Slots

Protected Member Functions