QGIS API Documentation  3.17.0-Master (ca637cfeb2)
Public Attributes | List of all members
QgsLayerTreeModel::LayerLegendTree Struct Reference

Structure that stores tree representation of map layer's legend. More...

#include <qgslayertreemodel.h>

Public Attributes

QMap< QgsLayerTreeModelLegendNode *, QList< QgsLayerTreeModelLegendNode * > > children
 List of children for each active node. Top-level nodes are under nullptr key. Pointers are not owned. More...
 
QMap< QgsLayerTreeModelLegendNode *, QgsLayerTreeModelLegendNode * > parents
 Pointer to parent for each active node. Top-level nodes have nullptr parent. Pointers are not owned. More...
 

Detailed Description

Structure that stores tree representation of map layer's legend.

This structure is used only when the following requirements are met:

tree legend representation is enabled in model (ShowLegendAsTree flag)

some legend nodes have non-null parent rule key (accessible via data(ParentRuleKeyRole) method)

The tree structure (parents and children of each node) is extracted by analyzing nodes' parent rules.

Note
not available in Python bindings

Definition at line 391 of file qgslayertreemodel.h.

Member Data Documentation

◆ children

QMap<QgsLayerTreeModelLegendNode *, QList<QgsLayerTreeModelLegendNode *> > QgsLayerTreeModel::LayerLegendTree::children

List of children for each active node. Top-level nodes are under nullptr key. Pointers are not owned.

Definition at line 396 of file qgslayertreemodel.h.

◆ parents

QMap<QgsLayerTreeModelLegendNode *, QgsLayerTreeModelLegendNode *> QgsLayerTreeModel::LayerLegendTree::parents

Pointer to parent for each active node. Top-level nodes have nullptr parent. Pointers are not owned.

Definition at line 394 of file qgslayertreemodel.h.


The documentation for this struct was generated from the following file: