QgsMapLayerLegend Class Reference

The QgsMapLayerLegend class is abstract interface for implementations of legends for one map layer. More...

#include <qgsmaplayerlegend.h>

Inheritance diagram for QgsMapLayerLegend:

Signals
void	itemsChanged ()
	Emitted when existing items/nodes got invalid and should be replaced by new ones.

Public Member Functions
	QgsMapLayerLegend (QObject *parent=nullptr)
	Constructor for QgsMapLayerLegend.
virtual QList< QgsLayerTreeModelLegendNode * >	createLayerTreeModelLegendNodes (QgsLayerTreeLayer *nodeLayer)=0
	Returns list of legend nodes to be used for a particular layer tree layer node.
virtual void	readXml (const QDomElement &elem, const QgsReadWriteContext &context)
	Reads configuration from a DOM element previously written by writeXml()
virtual QDomElement	writeXml (QDomDocument &doc, const QgsReadWriteContext &context) const
	Writes configuration to a DOM element, to be used later with readXml()

Static Public Member Functions
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

The QgsMapLayerLegend class is abstract interface for implementations of legends for one map layer.

Definition at line 46 of file qgsmaplayerlegend.h.

Constructor & Destructor Documentation

QgsMapLayerLegend()

QgsMapLayerLegend::QgsMapLayerLegend ( QObject *  parent = nullptr )

explicit

Constructor for QgsMapLayerLegend.

Definition at line 37 of file qgsmaplayerlegend.cpp.

Member Function Documentation

createLayerTreeModelLegendNodes()

virtual QList< QgsLayerTreeModelLegendNode * > QgsMapLayerLegend::createLayerTreeModelLegendNodes ( QgsLayerTreeLayer *  nodeLayer )

pure virtual

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

Ownership is transferred to the caller.

Implemented in QgsDefaultVectorLayerLegend, QgsDefaultRasterLayerLegend, QgsDefaultMeshLayerLegend, and QgsDefaultPointCloudLayerLegend.

defaultMeshLegend()

QgsMapLayerLegend * QgsMapLayerLegend::defaultMeshLegend ( QgsMeshLayer *  ml )

static

Create new legend implementation for mesh layer.

Definition at line 65 of file qgsmaplayerlegend.cpp.

defaultPointCloudLegend()

QgsMapLayerLegend * QgsMapLayerLegend::defaultPointCloudLegend ( QgsPointCloudLayer *  layer )

static

Create new legend implementation for a point cloud layer.

Since

QGIS 3.18

Definition at line 70 of file qgsmaplayerlegend.cpp.

defaultRasterLegend()

QgsMapLayerLegend * QgsMapLayerLegend::defaultRasterLegend ( QgsRasterLayer *  rl )

static

Create new legend implementation for raster layer.

Definition at line 60 of file qgsmaplayerlegend.cpp.

defaultVectorLegend()

QgsMapLayerLegend * QgsMapLayerLegend::defaultVectorLegend ( QgsVectorLayer *  vl )

static

Create new legend implementation for vector layer.

Definition at line 55 of file qgsmaplayerlegend.cpp.

itemsChanged

void QgsMapLayerLegend::itemsChanged ( )

signal

Emitted when existing items/nodes got invalid and should be replaced by new ones.

readXml()

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

virtual

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

Since

QGIS 3.2

Reimplemented in QgsDefaultVectorLayerLegend.

Definition at line 42 of file qgsmaplayerlegend.cpp.

writeXml()

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

virtual

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

Since

QGIS 3.2

Reimplemented in QgsDefaultVectorLayerLegend.

Definition at line 48 of file qgsmaplayerlegend.cpp.

---

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

• /build/qgis-3.41.0+git20241116+25ec5511245+99sid/src/core/qgsmaplayerlegend.h
• /build/qgis-3.41.0+git20241116+25ec5511245+99sid/src/core/qgsmaplayerlegend.cpp