QgsMapLayerLegendUtils Class Reference

Miscellaneous utility functions for handling of map layer legend. More...

#include <qgsmaplayerlegend.h>

Static Public Member Functions
static void	applyLayerNodeProperties (QgsLayerTreeLayer *nodeLayer, QList< QgsLayerTreeModelLegendNode *> &nodes)
	update according to layer node's custom properties (order of items, user labels for items) More...
static bool	hasLegendNodeOrder (QgsLayerTreeLayer *nodeLayer)
static bool	hasLegendNodeUserLabel (QgsLayerTreeLayer *nodeLayer, int originalIndex)
static QList< int >	legendNodeOrder (QgsLayerTreeLayer *nodeLayer)
static QString	legendNodeUserLabel (QgsLayerTreeLayer *nodeLayer, int originalIndex)
static void	setLegendNodeOrder (QgsLayerTreeLayer *nodeLayer, const QList< int > &order)
static void	setLegendNodeUserLabel (QgsLayerTreeLayer *nodeLayer, int originalIndex, const QString &newLabel)

Detailed Description

Miscellaneous utility functions for handling of map layer legend.

Note

added in 2.6

Definition at line 70 of file qgsmaplayerlegend.h.

Member Function Documentation

applyLayerNodeProperties()

void QgsMapLayerLegendUtils::applyLayerNodeProperties ( QgsLayerTreeLayer *  nodeLayer, QList< QgsLayerTreeModelLegendNode *> &  nodes  )

static

update according to layer node's custom properties (order of items, user labels for items)

Definition at line 135 of file qgsmaplayerlegend.cpp.

hasLegendNodeOrder()

bool QgsMapLayerLegendUtils::hasLegendNodeOrder ( QgsLayerTreeLayer *  nodeLayer )

static

Definition at line 114 of file qgsmaplayerlegend.cpp.

hasLegendNodeUserLabel()

bool QgsMapLayerLegendUtils::hasLegendNodeUserLabel ( QgsLayerTreeLayer *  nodeLayer, int  originalIndex  )

static

Definition at line 129 of file qgsmaplayerlegend.cpp.

legendNodeOrder()

QList< int > QgsMapLayerLegendUtils::legendNodeOrder ( QgsLayerTreeLayer *  nodeLayer )

static

Definition at line 88 of file qgsmaplayerlegend.cpp.

legendNodeUserLabel()

QString QgsMapLayerLegendUtils::legendNodeUserLabel ( QgsLayerTreeLayer *  nodeLayer, int  originalIndex  )

static

Definition at line 124 of file qgsmaplayerlegend.cpp.

setLegendNodeOrder()

void QgsMapLayerLegendUtils::setLegendNodeOrder ( QgsLayerTreeLayer *  nodeLayer, const QList< int > &  order  )

static

Definition at line 52 of file qgsmaplayerlegend.cpp.

setLegendNodeUserLabel()

void QgsMapLayerLegendUtils::setLegendNodeUserLabel ( QgsLayerTreeLayer *  nodeLayer, int  originalIndex, const QString &  newLabel  )

static

Definition at line 119 of file qgsmaplayerlegend.cpp.

---

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

• /tmp/buildd/qgis-2.18.21+99unstable/src/core/qgsmaplayerlegend.h
• /tmp/buildd/qgis-2.18.21+99unstable/src/core/qgsmaplayerlegend.cpp