QGIS API Documentation  3.21.0-Master (5b68dc587e)
qgslayertreeutils.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgslayertreeutils.h
3  --------------------------------------
4  Date : May 2014
5  Copyright : (C) 2014 by Martin Dobias
6  Email : wonder dot sk at gmail dot com
7  ***************************************************************************
8  * *
9  * This program is free software; you can redistribute it and/or modify *
10  * it under the terms of the GNU General Public License as published by *
11  * the Free Software Foundation; either version 2 of the License, or *
12  * (at your option) any later version. *
13  * *
14  ***************************************************************************/
15 
16 #ifndef QGSLAYERTREEUTILS_H
17 #define QGSLAYERTREEUTILS_H
18 
19 #include <qnamespace.h>
20 #include <QList>
21 #include <QPair>
22 #include <QDomNodeList>
23 #include "qgis_core.h"
24 
25 class QDomElement;
26 class QDomDocument;
27 
28 class QgsLayerTreeNode;
29 class QgsLayerTreeGroup;
30 class QgsLayerTreeLayer;
31 class QgsMapLayer;
32 class QgsProject;
33 
40 class CORE_EXPORT QgsLayerTreeUtils
41 {
42  public:
43 
45  static bool readOldLegend( QgsLayerTreeGroup *root, const QDomElement &legendElem );
47  static bool readOldLegendLayerOrder( const QDomElement &legendElem, bool &hasCustomOrder, QStringList &order );
49  static QDomElement writeOldLegend( QDomDocument &doc, QgsLayerTreeGroup *root, bool hasCustomOrder, const QList<QgsMapLayer *> &order );
50 
52  static QString checkStateToXml( Qt::CheckState state );
54  static Qt::CheckState checkStateFromXml( const QString &txt );
55 
62  static bool layersEditable( const QList<QgsLayerTreeLayer *> &layerNodes, bool ignoreLayersWhichCannotBeToggled = false );
63 
65  static bool layersModified( const QList<QgsLayerTreeLayer *> &layerNodes );
66 
68  static void removeInvalidLayers( QgsLayerTreeGroup *group );
69 
74  static void storeOriginalLayersProperties( QgsLayerTreeGroup *group, const QDomDocument *doc );
75 
77  static void replaceChildrenOfEmbeddedGroups( QgsLayerTreeGroup *group );
78 
82  static void updateEmbeddedGroupsProjectPath( QgsLayerTreeGroup *group, const QgsProject *project );
83 
85  static QStringList invisibleLayerList( QgsLayerTreeNode *node );
86 
88  static void setLegendFilterByExpression( QgsLayerTreeLayer &layer, const QString &expr, bool enabled = true );
90  static QString legendFilterByExpression( const QgsLayerTreeLayer &layer, bool *enabled = nullptr );
92  static bool hasLegendFilterExpression( const QgsLayerTreeGroup &group );
93 
101  static QgsLayerTreeLayer *insertLayerBelow( QgsLayerTreeGroup *group, const QgsMapLayer *refLayer, QgsMapLayer *layerToInsert );
102 
108  static QSet<QgsMapLayer *> collectMapLayersRecursive( const QList<QgsLayerTreeNode *> &nodes );
109 
122  static int countMapLayerInTree( QgsLayerTreeNode *tree, QgsMapLayer *layer );
123 
131  static QgsLayerTreeGroup *firstGroupWithoutCustomProperty( QgsLayerTreeGroup *group, const QString &property );
132 };
133 
134 #endif // QGSLAYERTREEUTILS_H
Layer tree group node serves as a container for layers and further groups.
Layer tree node points to a map layer.
This class is a base class for nodes in a layer tree.
Assorted functions for dealing with layer trees.
Base class for all map layer types.
Definition: qgsmaplayer.h:73
Encapsulates a QGIS project, including sets of map layers and their styles, layouts,...
Definition: qgsproject.h:101