QGIS API Documentation  2.6.0-Brighton
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
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 setLegendNodeOrder (QgsLayerTreeLayer *nodeLayer, const QList< int > &order)
static QList< int > legendNodeOrder (QgsLayerTreeLayer *nodeLayer)
static bool hasLegendNodeOrder (QgsLayerTreeLayer *nodeLayer)
static void setLegendNodeUserLabel (QgsLayerTreeLayer *nodeLayer, int originalIndex, const QString &newLabel)
static QString legendNodeUserLabel (QgsLayerTreeLayer *nodeLayer, int originalIndex)
static bool hasLegendNodeUserLabel (QgsLayerTreeLayer *nodeLayer, int originalIndex)
static void applyLayerNodeProperties (QgsLayerTreeLayer *nodeLayer, QList< QgsLayerTreeModelLegendNode * > &nodes)
 update according to layer node's custom properties (order of items, user labels for items)

Detailed Description

Miscellaneous utility functions for handling of map layer legend.

Note
added in 2.6

Member Function Documentation

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

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

bool QgsMapLayerLegendUtils::hasLegendNodeOrder ( QgsLayerTreeLayer nodeLayer)
static
bool QgsMapLayerLegendUtils::hasLegendNodeUserLabel ( QgsLayerTreeLayer nodeLayer,
int  originalIndex 
)
static
QList< int > QgsMapLayerLegendUtils::legendNodeOrder ( QgsLayerTreeLayer nodeLayer)
static
QString QgsMapLayerLegendUtils::legendNodeUserLabel ( QgsLayerTreeLayer nodeLayer,
int  originalIndex 
)
static
void QgsMapLayerLegendUtils::setLegendNodeOrder ( QgsLayerTreeLayer nodeLayer,
const QList< int > &  order 
)
static
void QgsMapLayerLegendUtils::setLegendNodeUserLabel ( QgsLayerTreeLayer nodeLayer,
int  originalIndex,
const QString &  newLabel 
)
static

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