Default legend implementation for vector layers. More...

#include <qgsmaplayerlegend.h>

Inheritance diagram for QgsDefaultVectorLayerLegend:

[legend]

Public Member Functions
	QgsDefaultVectorLayerLegend (QgsVectorLayer *vl)
QList< QgsLayerTreeModelLegendNode * >	createLayerTreeModelLegendNodes (QgsLayerTreeLayer *nodeLayer) override
	Returns list of legend nodes to be used for a particular layer tree layer node.
void	readXml (const QDomElement &elem, const QgsReadWriteContext &context) override
	Reads configuration from a DOM element previously written by writeXml().
void	setShowLabelLegend (bool enabled)
	Sets if a legend for the labeling should be shown.
void	setTextOnSymbolContent (const QHash< QString, QString > &content)
	Sets per-symbol content of labels for "text on symbol" functionality.
void	setTextOnSymbolEnabled (bool enabled)
	Sets whether the "text on symbol" functionality is enabled.
void	setTextOnSymbolTextFormat (const QgsTextFormat &format)
	Sets text format of symbol labels for "text on symbol" functionality.
bool	showLabelLegend () const
	Returns whether the legend for the labeling is shown.
QHash< QString, QString >	textOnSymbolContent () const
	Returns per-symbol content of labels for "text on symbol" functionality.
bool	textOnSymbolEnabled () const
	Returns whether the "text on symbol" functionality is enabled.
QgsTextFormat	textOnSymbolTextFormat () const
	Returns text format of symbol labels for "text on symbol" functionality.
QDomElement	writeXml (QDomDocument &doc, const QgsReadWriteContext &context) const override
	Writes configuration to a DOM element, to be used later with readXml().
Public Member Functions inherited from QgsMapLayerLegend
	QgsMapLayerLegend (QObject *parent=nullptr)
	Constructor for QgsMapLayerLegend.
Qgis::MapLayerLegendFlags	flags () const
	Returns flags associated with the legend.
void	setFlag (Qgis::MapLayerLegendFlag flag, bool on=true)
	Enables or disables a particular flag (other flags are not affected).
void	setFlags (Qgis::MapLayerLegendFlags flags)
	Sets the flags associated with the legend.

Additional Inherited Members
Signals inherited from QgsMapLayerLegend
void	itemsChanged ()
	Emitted when existing items/nodes got invalid and should be replaced by new ones.
Static Public Member Functions inherited from QgsMapLayerLegend
static QgsMapLayerLegend *	defaultMeshLegend (QgsMeshLayer *ml)
	Create new legend implementation for mesh layer.
static QgsMapLayerLegend *	defaultPointCloudLegend (QgsPointCloudLayer *layer)
	Create new legend implementation for a point cloud layer.
static QgsMapLayerLegend *	defaultRasterLegend (QgsRasterLayer *rl)
	Create new legend implementation for raster layer.
static QgsMapLayerLegend *	defaultVectorLegend (QgsVectorLayer *vl)
	Create new legend implementation for vector layer.

Detailed Description

Default legend implementation for vector layers.

Definition at line 266 of file qgsmaplayerlegend.h.

Constructor & Destructor Documentation

◆ QgsDefaultVectorLayerLegend()

QgsDefaultVectorLayerLegend::QgsDefaultVectorLayerLegend ( QgsVectorLayer * vl )

explicit

Definition at line 358 of file qgsmaplayerlegend.cpp.

Member Function Documentation

◆ createLayerTreeModelLegendNodes()

QList< QgsLayerTreeModelLegendNode * > QgsDefaultVectorLayerLegend::createLayerTreeModelLegendNodes ( QgsLayerTreeLayer * nodeLayer )

overridevirtual

Returns list of legend nodes to be used for a particular layer tree layer node.

Ownership is transferred to the caller.

Implements QgsMapLayerLegend.

Definition at line 365 of file qgsmaplayerlegend.cpp.

◆ readXml()

void QgsDefaultVectorLayerLegend::readXml	(	const QDomElement &	elem,
		const QgsReadWriteContext &	context )

overridevirtual

Reads configuration from a DOM element previously written by writeXml().

Since: QGIS 3.2

Reimplemented from QgsMapLayerLegend.

Definition at line 449 of file qgsmaplayerlegend.cpp.

◆ setShowLabelLegend()

void QgsDefaultVectorLayerLegend::setShowLabelLegend ( bool enabled )

inline

Sets if a legend for the labeling should be shown.

Parameters

enabled true to show label legend entries

Since: QGIS 3.20

Definition at line 300 of file qgsmaplayerlegend.h.

◆ setTextOnSymbolContent()

void QgsDefaultVectorLayerLegend::setTextOnSymbolContent ( const QHash< QString, QString > & content )

inline

Sets per-symbol content of labels for "text on symbol" functionality.

In the passed dictionary the keys are rule keys of legend items, the values are labels to be shown.

Since: QGIS 3.2

Definition at line 326 of file qgsmaplayerlegend.h.

◆ setTextOnSymbolEnabled()

void QgsDefaultVectorLayerLegend::setTextOnSymbolEnabled ( bool enabled )

inline

Sets whether the "text on symbol" functionality is enabled.

When enabled, legend symbols may have extra text rendered on top. The content of labels and their style is controlled by textOnSymbolContent() and textOnSymbolTextFormat().

Since: QGIS 3.2

Definition at line 287 of file qgsmaplayerlegend.h.

◆ setTextOnSymbolTextFormat()

void QgsDefaultVectorLayerLegend::setTextOnSymbolTextFormat ( const QgsTextFormat & format )

inline

Sets text format of symbol labels for "text on symbol" functionality.

Since: QGIS 3.2

Definition at line 312 of file qgsmaplayerlegend.h.

◆ showLabelLegend()

bool QgsDefaultVectorLayerLegend::showLabelLegend ( ) const

inline

Returns whether the legend for the labeling is shown.

Since: QGIS 3.20

Definition at line 293 of file qgsmaplayerlegend.h.

◆ textOnSymbolContent()

QHash< QString, QString > QgsDefaultVectorLayerLegend::textOnSymbolContent ( ) const

inline

Returns per-symbol content of labels for "text on symbol" functionality.

In the passed dictionary the keys are rule keys of legend items, the values are labels to be shown.

Since: QGIS 3.2

Definition at line 319 of file qgsmaplayerlegend.h.

◆ textOnSymbolEnabled()

bool QgsDefaultVectorLayerLegend::textOnSymbolEnabled ( ) const

inline

Returns whether the "text on symbol" functionality is enabled.

When enabled, legend symbols may have extra text rendered on top. The content of labels and their style is controlled by textOnSymbolContent() and textOnSymbolTextFormat().

Since: QGIS 3.2

Definition at line 279 of file qgsmaplayerlegend.h.

◆ textOnSymbolTextFormat()

QgsTextFormat QgsDefaultVectorLayerLegend::textOnSymbolTextFormat ( ) const

inline

Returns text format of symbol labels for "text on symbol" functionality.

Since: QGIS 3.2

Definition at line 306 of file qgsmaplayerlegend.h.

◆ writeXml()

QDomElement QgsDefaultVectorLayerLegend::writeXml	(	QDomDocument &	doc,
		const QgsReadWriteContext &	context ) const

overridevirtual

Writes configuration to a DOM element, to be used later with readXml().

Since: QGIS 3.2

Reimplemented from QgsMapLayerLegend.

Definition at line 475 of file qgsmaplayerlegend.cpp.

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

/build/qgis-3.99.0+git20251210+2fe06baccd8+99sid/src/core/qgsmaplayerlegend.h
/build/qgis-3.99.0+git20251210+2fe06baccd8+99sid/src/core/qgsmaplayerlegend.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QgsDefaultVectorLayerLegend()

Member Function Documentation

◆ createLayerTreeModelLegendNodes()

◆ readXml()

◆ setShowLabelLegend()

◆ setTextOnSymbolContent()

◆ setTextOnSymbolEnabled()

◆ setTextOnSymbolTextFormat()

◆ showLabelLegend()

◆ textOnSymbolContent()

◆ textOnSymbolEnabled()

◆ textOnSymbolTextFormat()

◆ writeXml()