QGIS API Documentation  3.11.0-Master (68611307d7)
Static Public Member Functions | List of all members
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.

Since
QGIS 2.6

Definition at line 94 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 150 of file qgsmaplayerlegend.cpp.

◆ hasLegendNodeOrder()

bool QgsMapLayerLegendUtils::hasLegendNodeOrder ( QgsLayerTreeLayer nodeLayer)
static

Definition at line 129 of file qgsmaplayerlegend.cpp.

◆ hasLegendNodeUserLabel()

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

Definition at line 144 of file qgsmaplayerlegend.cpp.

◆ legendNodeOrder()

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

Definition at line 102 of file qgsmaplayerlegend.cpp.

◆ legendNodeUserLabel()

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

Definition at line 139 of file qgsmaplayerlegend.cpp.

◆ setLegendNodeOrder()

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

Definition at line 65 of file qgsmaplayerlegend.cpp.

◆ setLegendNodeUserLabel()

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

Definition at line 134 of file qgsmaplayerlegend.cpp.


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