A widget for configuring a QgsGraduatedSymbolRenderer. More...

#include <qgsgraduatedsymbolrendererwidget.h>

Inheritance diagram for QgsGraduatedSymbolRendererWidget:

[legend]

Public Slots
void	addClass ()
	Adds a class manually to the classification.

void	changeCurrentValue (QStandardItem *item)

void	classifyGraduated ()

void	deleteAllClasses ()
	Removes all classes from the classification.

void	deleteClasses ()
	Removes currently selected classes.

void	graduatedColumnChanged (const QString &field)

void	labelFormatChanged ()

void	modelDataChanged ()

void	rangesClicked (const QModelIndex &idx)

void	rangesDoubleClicked (const QModelIndex &idx)

void	reapplyColorRamp ()

void	reapplySizes ()

void	refreshRanges (bool reset)
	Refreshes the ranges for the renderer.

void	rowsMoved ()

void	showSymbolLevels ()

void	toggleBoundariesLink (bool linked)
	Toggle the link between classes boundaries.

Public Slots inherited from QgsPanelWidget
void	acceptPanel ()
	Accept the panel.

void	openPanel (QgsPanelWidget *panel)
	Open a panel or dialog depending on dock mode setting If dock mode is `true` this method will emit the showPanel signal for connected slots to handle the open event.

Public Member Functions
	QgsGraduatedSymbolRendererWidget (QgsVectorLayer layer, QgsStyle style, QgsFeatureRenderer *renderer)

	~QgsGraduatedSymbolRendererWidget () override

QgsExpressionContext	createExpressionContext () const override
	This method needs to be reimplemented in all classes which implement this interface and return an expression context.

void	disableSymbolLevels () override
	Disables symbol level modification on the widget.

QgsFeatureRenderer *	renderer () override
	Returns pointer to the renderer (no transfer of ownership)

void	setContext (const QgsSymbolWidgetContext &context) override
	Sets the context in which the renderer widget is shown, e.g., the associated map canvas and expression contexts.

Public Member Functions inherited from QgsRendererWidget
	QgsRendererWidget (QgsVectorLayer layer, QgsStyle style)

void	applyChanges ()
	This method should be called whenever the renderer is actually set on the layer.

QgsSymbolWidgetContext	context () const
	Returns the context in which the renderer widget is shown, e.g., the associated map canvas and expression contexts.

QgsExpressionContext	createExpressionContext () const override
	This method needs to be reimplemented in all classes which implement this interface and return an expression context.

void	setDockMode (bool dockMode) override
	Set the widget in dock mode which tells the widget to emit panel widgets and not open dialogs.

void	showSymbolLevelsDialog (QgsFeatureRenderer *r)
	Show a dialog with renderer's symbol level settings.

const QgsVectorLayer *	vectorLayer () const
	Returns the vector layer associated with the widget.

Public Member Functions inherited from QgsPanelWidget
	QgsPanelWidget (QWidget *parent=nullptr)
	Base class for any widget that can be shown as an inline panel.

virtual bool	applySizeConstraintsToStack () const
	Returns `true` if the size constraints and hints for the panel widget should be applied to the parent QgsPanelWidgetStack which this panel is shown in.

bool	autoDelete ()
	The the auto delete property on the widget.

void	connectChildPanel (QgsPanelWidget *panel)
	Connect the given sub panel widgets showPanel signals to this current panels main showPanel event to bubble up to the user.

void	connectChildPanels (const QList< QgsPanelWidget * > &panels)
	Connect the given sub panel widgets showPanel signals to this current panels main showPanel event to bubble up to the user.

bool	dockMode ()
	Returns the dock mode state.

virtual QMenu *	menuButtonMenu ()
	Returns the menu to use for the menu button for this panel, or `nullptr` if no menu button is required.

virtual QString	menuButtonTooltip () const
	Returns the (translated) tooltip text to use for the menu button for this panel.

QString	panelTitle ()
	The title of the panel.

void	setAutoDelete (bool autoDelete)
	The the auto delete property on the widget.

void	setPanelTitle (const QString &panelTitle)
	Set the title of the panel when shown in the interface.

Public Member Functions inherited from QgsExpressionContextGenerator
virtual	~QgsExpressionContextGenerator ()=default

Static Public Member Functions
static QgsRendererWidget *	create (QgsVectorLayer layer, QgsStyle style, QgsFeatureRenderer *renderer)

Static Public Member Functions inherited from QgsPanelWidget
static QgsPanelWidget *	findParentPanel (QWidget *widget)
	Traces through the parents of a widget to find if it is contained within a QgsPanelWidget widget.

Protected Slots
void	pasteSymbolToSelection () override

Protected Slots inherited from QgsRendererWidget
void	changeSymbolAngle ()
	Change marker angles of selected symbols.

void	changeSymbolColor ()
	Change color of selected symbols.

void	changeSymbolOpacity ()
	Change opacity of selected symbols.

void	changeSymbolSize ()
	Change marker sizes of selected symbols.

void	changeSymbolUnit ()
	Change units mm/map units of selected symbols.

void	changeSymbolWidth ()
	Change line widths of selected symbols.

void	contextMenuViewCategories (QPoint p)

virtual void	copy ()

virtual void	paste ()

virtual void	pasteSymbolToSelection ()
	Pastes the clipboard symbol over selected items.

Protected Member Functions
void	applyChangeToSymbol ()
	Applies current symbol to selected ranges, or to all ranges if none is selected.

void	changeRange (int rangeIdx)

void	changeRangeSymbol (int rangeIdx)

void	changeSelectedSymbols ()

void	connectUpdateHandlers ()

void	disconnectUpdateHandlers ()

QgsSymbol *	findSymbolForRange (double lowerBound, double upperBound, const QgsRangeList &ranges) const

void	keyPressEvent (QKeyEvent *event) override

void	refreshSymbolView () override

bool	rowsOrdered ()

QList< int >	selectedClasses ()
	Returns a list of indexes for the classes under selection.

QgsRangeList	selectedRanges ()

QList< QgsSymbol * >	selectedSymbols () override
	Subclasses may provide the capability of changing multiple symbols at once by implementing the following two methods and by connecting the slot contextMenuViewCategories(const QPoint&).

void	setSymbolLevels (const QgsLegendSymbolList &levels, bool enabled) override
	Sets the symbol levels for the renderer defined in the widget.

void	updateUiFromRenderer (bool updateCount=true)

Protected Member Functions inherited from QgsRendererWidget
QgsDataDefinedSizeLegendWidget *	createDataDefinedSizeLegendWidget (const QgsMarkerSymbol symbol, const QgsDataDefinedSizeLegend ddsLegend)
	Creates widget to setup data-defined size legend.

void	registerDataDefinedButton (QgsPropertyOverrideButton *button, QgsFeatureRenderer::Property key)
	Registers a data defined override button.

Protected Member Functions inherited from QgsPanelWidget
void	keyPressEvent (QKeyEvent *event) override
	Overridden key press event to handle the esc event on the widget.

Additional Inherited Members
Signals inherited from QgsRendererWidget
void	layerVariablesChanged ()
	Emitted when expression context variables on the associated vector layers have been changed.

Q_DECL_DEPRECATED void	symbolLevelsChanged ()
	Emitted when the symbol levels settings have been changed.

Signals inherited from QgsPanelWidget
void	panelAccepted (QgsPanelWidget *panel)
	Emitted when the panel is accepted by the user.

void	showPanel (QgsPanelWidget *panel)
	Emit when you require a panel to be show in the interface.

void	widgetChanged ()
	Emitted when the widget state changes.

Protected Attributes inherited from QgsRendererWidget
QMenu *	contextMenu = nullptr

QgsSymbolWidgetContext	mContext
	Context in which widget is shown.

QAction *	mCopyAction = nullptr

QAction *	mCopySymbolAction = nullptr
	Copy symbol action.

QgsVectorLayer *	mLayer = nullptr

QAction *	mPasteAction = nullptr

QAction *	mPasteSymbolAction = nullptr
	Paste symbol action.

QgsStyle *	mStyle = nullptr

Detailed Description

A widget for configuring a QgsGraduatedSymbolRenderer.

Definition at line 96 of file qgsgraduatedsymbolrendererwidget.h.

Constructor & Destructor Documentation

◆ QgsGraduatedSymbolRendererWidget()

QgsGraduatedSymbolRendererWidget::QgsGraduatedSymbolRendererWidget	(	QgsVectorLayer *	layer,
		QgsStyle *	style,
		QgsFeatureRenderer *	renderer
	)

Definition at line 466 of file qgsgraduatedsymbolrendererwidget.cpp.

◆ ~QgsGraduatedSymbolRendererWidget()

QgsGraduatedSymbolRendererWidget::~QgsGraduatedSymbolRendererWidget ( )

override

Definition at line 637 of file qgsgraduatedsymbolrendererwidget.cpp.

Member Function Documentation

◆ addClass

void QgsGraduatedSymbolRendererWidget::addClass ( )

slot

Adds a class manually to the classification.

Definition at line 1272 of file qgsgraduatedsymbolrendererwidget.cpp.

◆ applyChangeToSymbol()

void QgsGraduatedSymbolRendererWidget::applyChangeToSymbol ( )

protected

Applies current symbol to selected ranges, or to all ranges if none is selected.

Definition at line 986 of file qgsgraduatedsymbolrendererwidget.cpp.

◆ changeCurrentValue

void QgsGraduatedSymbolRendererWidget::changeCurrentValue ( QStandardItem * item )

slot

Definition at line 1340 of file qgsgraduatedsymbolrendererwidget.cpp.

◆ changeRange()

void QgsGraduatedSymbolRendererWidget::changeRange ( int rangeIdx )

protected

Definition at line 1236 of file qgsgraduatedsymbolrendererwidget.cpp.

◆ changeRangeSymbol()

void QgsGraduatedSymbolRendererWidget::changeRangeSymbol ( int rangeIdx )

protected

Definition at line 1208 of file qgsgraduatedsymbolrendererwidget.cpp.

◆ changeSelectedSymbols()

void QgsGraduatedSymbolRendererWidget::changeSelectedSymbols ( )

protected

Definition at line 1204 of file qgsgraduatedsymbolrendererwidget.cpp.

◆ classifyGraduated

void QgsGraduatedSymbolRendererWidget::classifyGraduated ( )

slot

Definition at line 1038 of file qgsgraduatedsymbolrendererwidget.cpp.

◆ connectUpdateHandlers()

void QgsGraduatedSymbolRendererWidget::connectUpdateHandlers ( )

protected

Definition at line 662 of file qgsgraduatedsymbolrendererwidget.cpp.

◆ create()

QgsRendererWidget * QgsGraduatedSymbolRendererWidget::create	(	QgsVectorLayer *	layer,
		QgsStyle *	style,
		QgsFeatureRenderer *	renderer
	)

static

Definition at line 432 of file qgsgraduatedsymbolrendererwidget.cpp.

◆ createExpressionContext()

QgsExpressionContext QgsGraduatedSymbolRendererWidget::createExpressionContext ( ) const

overridevirtual

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

Implements QgsExpressionContextGenerator.

Definition at line 437 of file qgsgraduatedsymbolrendererwidget.cpp.

◆ deleteAllClasses

void QgsGraduatedSymbolRendererWidget::deleteAllClasses ( )

slot

Removes all classes from the classification.

Definition at line 1287 of file qgsgraduatedsymbolrendererwidget.cpp.

◆ deleteClasses

void QgsGraduatedSymbolRendererWidget::deleteClasses ( )

slot

Removes currently selected classes.

Definition at line 1279 of file qgsgraduatedsymbolrendererwidget.cpp.

◆ disableSymbolLevels()

void QgsGraduatedSymbolRendererWidget::disableSymbolLevels ( )

overridevirtual

Disables symbol level modification on the widget.

Note: Not available in Python bindings

Since: QGIS 3.20

Reimplemented from QgsRendererWidget.

Definition at line 655 of file qgsgraduatedsymbolrendererwidget.cpp.

◆ disconnectUpdateHandlers()

void QgsGraduatedSymbolRendererWidget::disconnectUpdateHandlers ( )

protected

Definition at line 688 of file qgsgraduatedsymbolrendererwidget.cpp.

◆ findSymbolForRange()

QgsSymbol * QgsGraduatedSymbolRendererWidget::findSymbolForRange	(	double	lowerBound,
		double	upperBound,
		const QgsRangeList &	ranges
	)		const

protected

Definition at line 1396 of file qgsgraduatedsymbolrendererwidget.cpp.

◆ graduatedColumnChanged

void QgsGraduatedSymbolRendererWidget::graduatedColumnChanged ( const QString & field )

slot

Definition at line 833 of file qgsgraduatedsymbolrendererwidget.cpp.

◆ keyPressEvent()

void QgsGraduatedSymbolRendererWidget::keyPressEvent ( QKeyEvent * event )

overrideprotected

Definition at line 1443 of file qgsgraduatedsymbolrendererwidget.cpp.

◆ labelFormatChanged

void QgsGraduatedSymbolRendererWidget::labelFormatChanged ( )

slot

Definition at line 1350 of file qgsgraduatedsymbolrendererwidget.cpp.

◆ modelDataChanged

void QgsGraduatedSymbolRendererWidget::modelDataChanged ( )

slot

Definition at line 1438 of file qgsgraduatedsymbolrendererwidget.cpp.

◆ pasteSymbolToSelection

void QgsGraduatedSymbolRendererWidget::pasteSymbolToSelection ( )

overrideprotectedslot

Definition at line 1501 of file qgsgraduatedsymbolrendererwidget.cpp.

◆ rangesClicked

void QgsGraduatedSymbolRendererWidget::rangesClicked ( const QModelIndex & idx )

slot

Definition at line 1196 of file qgsgraduatedsymbolrendererwidget.cpp.

◆ rangesDoubleClicked

void QgsGraduatedSymbolRendererWidget::rangesDoubleClicked ( const QModelIndex & idx )

slot

Definition at line 1188 of file qgsgraduatedsymbolrendererwidget.cpp.

◆ reapplyColorRamp

void QgsGraduatedSymbolRendererWidget::reapplyColorRamp ( )

slot

Definition at line 1131 of file qgsgraduatedsymbolrendererwidget.cpp.

◆ reapplySizes

void QgsGraduatedSymbolRendererWidget::reapplySizes ( )

slot

Definition at line 1142 of file qgsgraduatedsymbolrendererwidget.cpp.

◆ refreshRanges

void QgsGraduatedSymbolRendererWidget::refreshRanges ( bool reset )

slot

Refreshes the ranges for the renderer.

The reset argument is deprecated and has no effect.

Definition at line 950 of file qgsgraduatedsymbolrendererwidget.cpp.

◆ refreshSymbolView()

void QgsGraduatedSymbolRendererWidget::refreshSymbolView ( )

overrideprotectedvirtual

Reimplemented from QgsRendererWidget.

Definition at line 1413 of file qgsgraduatedsymbolrendererwidget.cpp.

◆ renderer()

QgsFeatureRenderer * QgsGraduatedSymbolRendererWidget::renderer ( )

overridevirtual

Returns pointer to the renderer (no transfer of ownership)

Implements QgsRendererWidget.

Definition at line 643 of file qgsgraduatedsymbolrendererwidget.cpp.

◆ rowsMoved

void QgsGraduatedSymbolRendererWidget::rowsMoved ( )

slot

Definition at line 1428 of file qgsgraduatedsymbolrendererwidget.cpp.

◆ rowsOrdered()

bool QgsGraduatedSymbolRendererWidget::rowsOrdered ( )

protected

Definition at line 1294 of file qgsgraduatedsymbolrendererwidget.cpp.

◆ selectedClasses()

QList< int > QgsGraduatedSymbolRendererWidget::selectedClasses ( )

protected

Returns a list of indexes for the classes under selection.

Definition at line 1159 of file qgsgraduatedsymbolrendererwidget.cpp.

◆ selectedRanges()

QgsRangeList QgsGraduatedSymbolRendererWidget::selectedRanges ( )

protected

Definition at line 1175 of file qgsgraduatedsymbolrendererwidget.cpp.

◆ selectedSymbols()

QList< QgsSymbol * > QgsGraduatedSymbolRendererWidget::selectedSymbols ( )

overrideprotectedvirtual

Subclasses may provide the capability of changing multiple symbols at once by implementing the following two methods and by connecting the slot contextMenuViewCategories(const QPoint&).

Reimplemented from QgsRendererWidget.

Definition at line 1360 of file qgsgraduatedsymbolrendererwidget.cpp.

◆ setContext()

void QgsGraduatedSymbolRendererWidget::setContext ( const QgsSymbolWidgetContext & context )

overridevirtual

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

Parameters

context symbol widget context

See also: context()

Reimplemented from QgsRendererWidget.

Definition at line 648 of file qgsgraduatedsymbolrendererwidget.cpp.

◆ setSymbolLevels()

void QgsGraduatedSymbolRendererWidget::setSymbolLevels	(	const QgsLegendSymbolList &	levels,
		bool	enabled
	)

overrideprotectedvirtual

Sets the symbol levels for the renderer defined in the widget.

The levels argument defines the updated list of symbols with rendering passes set.

The enabled arguments specifies if symbol levels should be enabled for the renderer.

Since: QGIS 3.20

Reimplemented from QgsRendererWidget.

Definition at line 964 of file qgsgraduatedsymbolrendererwidget.cpp.

◆ showSymbolLevels

void QgsGraduatedSymbolRendererWidget::showSymbolLevels ( )

slot

Definition at line 1423 of file qgsgraduatedsymbolrendererwidget.cpp.

◆ toggleBoundariesLink

void QgsGraduatedSymbolRendererWidget::toggleBoundariesLink ( bool linked )

slot

Toggle the link between classes boundaries.

Definition at line 1309 of file qgsgraduatedsymbolrendererwidget.cpp.

◆ updateUiFromRenderer()

void QgsGraduatedSymbolRendererWidget::updateUiFromRenderer ( bool updateCount = true )

protected

Definition at line 713 of file qgsgraduatedsymbolrendererwidget.cpp.

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

/build/qgis-3.43.0+git20250408+c67cf405802+99sid/src/gui/symbology/qgsgraduatedsymbolrendererwidget.h
/build/qgis-3.43.0+git20250408+c67cf405802+99sid/src/gui/symbology/qgsgraduatedsymbolrendererwidget.cpp

Public Slots

Public Member Functions

Static Public Member Functions

Protected Slots

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QgsGraduatedSymbolRendererWidget()

◆ ~QgsGraduatedSymbolRendererWidget()

Member Function Documentation

◆ addClass

◆ applyChangeToSymbol()

◆ changeCurrentValue

◆ changeRange()

◆ changeRangeSymbol()

◆ changeSelectedSymbols()

◆ classifyGraduated

◆ connectUpdateHandlers()

◆ create()

◆ createExpressionContext()

◆ deleteAllClasses

◆ deleteClasses

◆ disableSymbolLevels()

◆ disconnectUpdateHandlers()

◆ findSymbolForRange()

◆ graduatedColumnChanged

◆ keyPressEvent()

◆ labelFormatChanged

◆ modelDataChanged

◆ pasteSymbolToSelection

◆ rangesClicked

◆ rangesDoubleClicked

◆ reapplyColorRamp

◆ reapplySizes

◆ refreshRanges

◆ refreshSymbolView()

◆ renderer()

◆ rowsMoved

◆ rowsOrdered()

◆ selectedClasses()

◆ selectedRanges()

◆ selectedSymbols()

◆ setContext()

◆ setSymbolLevels()

◆ showSymbolLevels

◆ toggleBoundariesLink

◆ updateUiFromRenderer()