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=0)
virtual QList < QgsLayerTreeModelLegendNode * >	createLayerTreeModelLegendNodes (QgsLayerTreeLayer *nodeLayer)=0
	Return list of legend nodes to be used for a particular layer tree layer node.

Static Public Member Functions
static QgsMapLayerLegend *	defaultVectorLegend (QgsVectorLayer *vl)
	Create new legend implementation for vector layer.
static QgsMapLayerLegend *	defaultRasterLegend (QgsRasterLayer *rl)
	Create new legend implementation for raster layer.
static QgsMapLayerLegend *	defaultPluginLegend (QgsPluginLayer *pl)
	Create new legend implementation for raster layer.

Detailed Description

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

Note

added in 2.6

Constructor & Destructor Documentation

QgsMapLayerLegend::QgsMapLayerLegend ( QObject *  parent = 0 )

explicit

Member Function Documentation

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

pure virtual

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

Ownership is transferred to the caller.

Implemented in QgsDefaultPluginLayerLegend, QgsDefaultRasterLayerLegend, and QgsDefaultVectorLayerLegend.

QgsMapLayerLegend * QgsMapLayerLegend::defaultPluginLegend ( QgsPluginLayer *  pl )

static

Create new legend implementation for raster layer.

QgsMapLayerLegend * QgsMapLayerLegend::defaultRasterLegend ( QgsRasterLayer *  rl )

static

Create new legend implementation for raster layer.

QgsMapLayerLegend * QgsMapLayerLegend::defaultVectorLegend ( QgsVectorLayer *  vl )

static

Create new legend implementation for vector layer.

void QgsMapLayerLegend::itemsChanged ( )

signal

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

---

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

• /tmp/buildd/qgis-2.6.0+wheezy1/src/core/qgsmaplayerlegend.h
• /tmp/buildd/qgis-2.6.0+wheezy1/src/core/qgsmaplayerlegend.cpp