A widget for configuring a QgsCategorizedSymbolRenderer. More...

#include <qgscategorizedsymbolrendererwidget.h>

Inheritance diagram for QgsCategorizedSymbolRendererWidget:

[legend]

Public Types
enum class	CustomRole : int { Value = Qt::UserRole + 1 }
	Custom model roles. More...

Public Slots
void	addCategories ()
void	addCategory ()
void	applyColorRamp ()
	Applies the color ramp passed on by the color ramp button.
void	categoriesDoubleClicked (const QModelIndex &idx)
void	categoryColumnChanged (const QString &field)
void	changeCategorizedSymbol ()
void	deleteAllCategories ()
void	deleteCategories ()
void	deleteUnusedCategories ()
	Deletes unused categories from the widget which are not used by the layer renderer.
void	matchToSymbolsFromLibrary ()
	Replaces category symbols with the symbols from the users' symbol library that have a matching name.
void	matchToSymbolsFromXml ()
	Prompts for selection of an xml file, then replaces category symbols with the symbols from the XML file with a matching name.
void	rowsMoved ()
void	showSymbolLevels ()
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
	QgsCategorizedSymbolRendererWidget (QgsVectorLayer layer, QgsStyle style, QgsFeatureRenderer *renderer)
	~QgsCategorizedSymbolRendererWidget () 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.
int	matchToSymbols (QgsStyle *style)
	Replaces category symbols with the symbols from a style that have a matching name.
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 () const
	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 () const
	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 () const
	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 categories, or to all categories if none is selected.
void	changeCategorySymbol ()
void	changeSelectedSymbols ()
	Changes the selected symbols alone for the change button, if there is a selection.
int	currentCategoryRow ()
	Returns row index for the currently selected category (-1 if on no selection).
void	keyPressEvent (QKeyEvent *event) override
Q_DECL_DEPRECATED QList< QVariant >	layerUniqueValues (const QString &attrName)
	Returns the list of unique values in the current widget's layer for attribute name attrName.
void	populateCategories ()
void	refreshSymbolView () override
QList< int >	selectedCategories ()
	Returns a list of indexes for the categories under selection.
QgsCategoryList	selectedCategoryList ()
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 ()
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.

Protected Attributes
std::unique_ptr< QgsSymbol >	mCategorizedSymbol
QgsCategorizedSymbolRendererModel *	mModel = nullptr
std::unique_ptr< QgsCategorizedSymbolRenderer >	mRenderer
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

Friends
class	TestQgsCategorizedRendererWidget

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.

Detailed Description

A widget for configuring a QgsCategorizedSymbolRenderer.

Definition at line 115 of file qgscategorizedsymbolrendererwidget.h.

Member Enumeration Documentation

◆ CustomRole

enum class QgsCategorizedSymbolRendererWidget::CustomRole : int

strong

Custom model roles.

Note: Prior to QGIS 3.36 this was available as QgsCategorizedSymbolRendererWidget::CustomRoles

Since: QGIS 3.36

Enumerator
Value	Category value.

Definition at line 127 of file qgscategorizedsymbolrendererwidget.h.

Constructor & Destructor Documentation

◆ QgsCategorizedSymbolRendererWidget()

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

Definition at line 641 of file qgscategorizedsymbolrendererwidget.cpp.

◆ ~QgsCategorizedSymbolRendererWidget()

QgsCategorizedSymbolRendererWidget::~QgsCategorizedSymbolRendererWidget ( )

override

Definition at line 751 of file qgscategorizedsymbolrendererwidget.cpp.

Member Function Documentation

◆ addCategories

void QgsCategorizedSymbolRendererWidget::addCategories ( )

slot

Definition at line 908 of file qgscategorizedsymbolrendererwidget.cpp.

◆ addCategory

void QgsCategorizedSymbolRendererWidget::addCategory ( )

slot

Definition at line 1122 of file qgscategorizedsymbolrendererwidget.cpp.

◆ applyChangeToSymbol()

void QgsCategorizedSymbolRendererWidget::applyChangeToSymbol ( )

protected

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

Definition at line 1307 of file qgscategorizedsymbolrendererwidget.cpp.

◆ applyColorRamp

void QgsCategorizedSymbolRendererWidget::applyColorRamp ( )

slot

Applies the color ramp passed on by the color ramp button.

Definition at line 1037 of file qgscategorizedsymbolrendererwidget.cpp.

◆ categoriesDoubleClicked

void QgsCategorizedSymbolRendererWidget::categoriesDoubleClicked ( const QModelIndex & idx )

slot

Definition at line 863 of file qgscategorizedsymbolrendererwidget.cpp.

◆ categoryColumnChanged

void QgsCategorizedSymbolRendererWidget::categoryColumnChanged ( const QString & field )

slot

Definition at line 857 of file qgscategorizedsymbolrendererwidget.cpp.

◆ changeCategorizedSymbol

void QgsCategorizedSymbolRendererWidget::changeCategorizedSymbol ( )

slot

Definition at line 827 of file qgscategorizedsymbolrendererwidget.cpp.

◆ changeCategorySymbol()

void QgsCategorizedSymbolRendererWidget::changeCategorySymbol ( )

protected

Definition at line 869 of file qgscategorizedsymbolrendererwidget.cpp.

◆ changeSelectedSymbols()

void QgsCategorizedSymbolRendererWidget::changeSelectedSymbols ( )

protected

Changes the selected symbols alone for the change button, if there is a selection.

Definition at line 800 of file qgscategorizedsymbolrendererwidget.cpp.

◆ create()

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

static

Definition at line 636 of file qgscategorizedsymbolrendererwidget.cpp.

◆ createExpressionContext()

QgsExpressionContext QgsCategorizedSymbolRendererWidget::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 1364 of file qgscategorizedsymbolrendererwidget.cpp.

◆ currentCategoryRow()

int QgsCategorizedSymbolRendererWidget::currentCategoryRow ( )

protected

Returns row index for the currently selected category (-1 if on no selection).

Definition at line 1046 of file qgscategorizedsymbolrendererwidget.cpp.

◆ deleteAllCategories

void QgsCategorizedSymbolRendererWidget::deleteAllCategories ( )

slot

Definition at line 1077 of file qgscategorizedsymbolrendererwidget.cpp.

◆ deleteCategories

void QgsCategorizedSymbolRendererWidget::deleteCategories ( )

slot

Definition at line 1070 of file qgscategorizedsymbolrendererwidget.cpp.

◆ deleteUnusedCategories

void QgsCategorizedSymbolRendererWidget::deleteUnusedCategories ( )

slot

Deletes unused categories from the widget which are not used by the layer renderer.

Definition at line 1083 of file qgscategorizedsymbolrendererwidget.cpp.

◆ disableSymbolLevels()

void QgsCategorizedSymbolRendererWidget::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 794 of file qgscategorizedsymbolrendererwidget.cpp.

◆ keyPressEvent()

void QgsCategorizedSymbolRendererWidget::keyPressEvent ( QKeyEvent * event )

overrideprotected

Definition at line 1341 of file qgscategorizedsymbolrendererwidget.cpp.

◆ layerUniqueValues()

QList< QVariant > QgsCategorizedSymbolRendererWidget::layerUniqueValues ( const QString & attrName )

protected

Returns the list of unique values in the current widget's layer for attribute name attrName.

Called by addCategories() and deleteUnusedCategories()

Deprecated: QGIS 4.0. Use QgsVectorLayerUtils::uniqueValues instead.

Definition at line 1111 of file qgscategorizedsymbolrendererwidget.cpp.

◆ matchToSymbols()

int QgsCategorizedSymbolRendererWidget::matchToSymbols ( QgsStyle * style )

Replaces category symbols with the symbols from a style that have a matching name.

Parameters

style style containing symbols to match with

Returns: number of symbols matched

See also: matchToSymbolsFromLibrary; matchToSymbolsFromXml

Definition at line 1203 of file qgscategorizedsymbolrendererwidget.cpp.

◆ matchToSymbolsFromLibrary

void QgsCategorizedSymbolRendererWidget::matchToSymbolsFromLibrary ( )

slot

Replaces category symbols with the symbols from the users' symbol library that have a matching name.

See also: matchToSymbolsFromXml; matchToSymbols

Definition at line 1190 of file qgscategorizedsymbolrendererwidget.cpp.

◆ matchToSymbolsFromXml

void QgsCategorizedSymbolRendererWidget::matchToSymbolsFromXml ( )

slot

Prompts for selection of an xml file, then replaces category symbols with the symbols from the XML file with a matching name.

See also: matchToSymbolsFromLibrary; matchToSymbols

Definition at line 1220 of file qgscategorizedsymbolrendererwidget.cpp.

◆ pasteSymbolToSelection

void QgsCategorizedSymbolRendererWidget::pasteSymbolToSelection ( )

overrideprotectedslot

Definition at line 1267 of file qgscategorizedsymbolrendererwidget.cpp.

◆ populateCategories()

void QgsCategorizedSymbolRendererWidget::populateCategories ( )

protected

Definition at line 853 of file qgscategorizedsymbolrendererwidget.cpp.

◆ refreshSymbolView()

void QgsCategorizedSymbolRendererWidget::refreshSymbolView ( )

overrideprotectedvirtual

Reimplemented from QgsRendererWidget.

Definition at line 1174 of file qgscategorizedsymbolrendererwidget.cpp.

◆ renderer()

QgsFeatureRenderer * QgsCategorizedSymbolRendererWidget::renderer ( )

overridevirtual

Returns pointer to the renderer (no transfer of ownership).

Implements QgsRendererWidget.

Definition at line 782 of file qgscategorizedsymbolrendererwidget.cpp.

◆ rowsMoved

void QgsCategorizedSymbolRendererWidget::rowsMoved ( )

slot

Definition at line 1185 of file qgscategorizedsymbolrendererwidget.cpp.

◆ selectedCategories()

QList< int > QgsCategorizedSymbolRendererWidget::selectedCategories ( )

protected

Returns a list of indexes for the categories under selection.

Definition at line 1054 of file qgscategorizedsymbolrendererwidget.cpp.

◆ selectedCategoryList()

QgsCategoryList QgsCategorizedSymbolRendererWidget::selectedCategoryList ( )

protected

Definition at line 1156 of file qgscategorizedsymbolrendererwidget.cpp.

◆ selectedSymbols()

QList< QgsSymbol * > QgsCategorizedSymbolRendererWidget::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 1132 of file qgscategorizedsymbolrendererwidget.cpp.

◆ setContext()

void QgsCategorizedSymbolRendererWidget::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 787 of file qgscategorizedsymbolrendererwidget.cpp.

◆ setSymbolLevels()

void QgsCategorizedSymbolRendererWidget::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 1252 of file qgscategorizedsymbolrendererwidget.cpp.

◆ showSymbolLevels

void QgsCategorizedSymbolRendererWidget::showSymbolLevels ( )

slot

Definition at line 1180 of file qgscategorizedsymbolrendererwidget.cpp.

◆ updateUiFromRenderer()

void QgsCategorizedSymbolRendererWidget::updateUiFromRenderer ( )

protected

Definition at line 756 of file qgscategorizedsymbolrendererwidget.cpp.

◆ TestQgsCategorizedRendererWidget

friend class TestQgsCategorizedRendererWidget

friend

Definition at line 273 of file qgscategorizedsymbolrendererwidget.h.

Member Data Documentation

◆ mCategorizedSymbol

std::unique_ptr<QgsSymbol> QgsCategorizedSymbolRendererWidget::mCategorizedSymbol

protected

Definition at line 261 of file qgscategorizedsymbolrendererwidget.h.

◆ mModel

QgsCategorizedSymbolRendererModel* QgsCategorizedSymbolRendererWidget::mModel = nullptr

protected

Definition at line 263 of file qgscategorizedsymbolrendererwidget.h.

◆ mRenderer

std::unique_ptr<QgsCategorizedSymbolRenderer> QgsCategorizedSymbolRendererWidget::mRenderer

protected

Definition at line 259 of file qgscategorizedsymbolrendererwidget.h.

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

/build/qgis-3.99.0+git20251214+752b475928d+99sid/src/gui/symbology/qgscategorizedsymbolrendererwidget.h
/build/qgis-3.99.0+git20251214+752b475928d+99sid/src/gui/symbology/qgscategorizedsymbolrendererwidget.cpp

Public Types

Public Slots

Public Member Functions

Static Public Member Functions

Protected Slots

Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ CustomRole

Constructor & Destructor Documentation

◆ QgsCategorizedSymbolRendererWidget()

◆ ~QgsCategorizedSymbolRendererWidget()

Member Function Documentation

◆ addCategories

◆ addCategory

◆ applyChangeToSymbol()

◆ applyColorRamp

◆ categoriesDoubleClicked

◆ categoryColumnChanged

◆ changeCategorizedSymbol

◆ changeCategorySymbol()

◆ changeSelectedSymbols()

◆ create()

◆ createExpressionContext()

◆ currentCategoryRow()

◆ deleteAllCategories

◆ deleteCategories

◆ deleteUnusedCategories

◆ disableSymbolLevels()

◆ keyPressEvent()

◆ layerUniqueValues()

◆ matchToSymbols()

◆ matchToSymbolsFromLibrary

◆ matchToSymbolsFromXml

◆ pasteSymbolToSelection

◆ populateCategories()

◆ refreshSymbolView()

◆ renderer()

◆ rowsMoved

◆ selectedCategories()

◆ selectedCategoryList()

◆ selectedSymbols()

◆ setContext()

◆ setSymbolLevels()

◆ showSymbolLevels

◆ updateUiFromRenderer()

Friends And Related Symbol Documentation

◆ TestQgsCategorizedRendererWidget

Member Data Documentation

◆ mCategorizedSymbol

◆ mModel

◆ mRenderer