QGIS API Documentation  2.99.0-Master (19b062c)
qgslayertreegroup.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgslayertreegroup.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 QGSLAYERTREEGROUP_H
17 #define QGSLAYERTREEGROUP_H
18 
19 #include "qgis_core.h"
20 #include "qgis.h"
21 #include "qgslayertreenode.h"
22 
23 class QgsMapLayer;
24 class QgsLayerTreeLayer;
25 
34 class CORE_EXPORT QgsLayerTreeGroup : public QgsLayerTreeNode
35 {
36  Q_OBJECT
37  public:
38 
42  QgsLayerTreeGroup( const QString &name = QString(), bool checked = true );
43 
44 #ifndef SIP_RUN
45  QgsLayerTreeGroup( const QgsLayerTreeGroup &other );
46 #endif
47 
51  QString name() const override;
52 
56  void setName( const QString &n ) override;
57 
61  QgsLayerTreeGroup *insertGroup( int index, const QString &name );
62 
66  QgsLayerTreeGroup *addGroup( const QString &name );
67 
71  QgsLayerTreeLayer *insertLayer( int index, QgsMapLayer *layer );
72 
76  QgsLayerTreeLayer *addLayer( QgsMapLayer *layer );
77 
81  void insertChildNodes( int index, const QList<QgsLayerTreeNode *> &nodes SIP_TRANSFER );
82 
86  void insertChildNode( int index, QgsLayerTreeNode *node SIP_TRANSFER );
87 
91  void addChildNode( QgsLayerTreeNode *node SIP_TRANSFER );
92 
96  void removeChildNode( QgsLayerTreeNode *node );
97 
101  void removeLayer( QgsMapLayer *layer );
102 
106  void removeChildren( int from, int count );
107 
111  void removeChildrenGroupWithoutLayers();
112 
116  void removeAllChildren();
117 
122  QgsLayerTreeLayer *findLayer( QgsMapLayer *layer ) const;
123 
127  QgsLayerTreeLayer *findLayer( const QString &layerId ) const;
128 
132  QList<QgsLayerTreeLayer *> findLayers() const;
133 
137  QStringList findLayerIds() const;
138 
142  QgsLayerTreeGroup *findGroup( const QString &name );
143 
148  static QgsLayerTreeGroup *readXml( QDomElement &element, const QgsReadWriteContext &context ) SIP_FACTORY;
149 
155  static QgsLayerTreeGroup *readXml( QDomElement &element, const QgsProject *project, const QgsReadWriteContext &context ) SIP_FACTORY;
156 
160  virtual void writeXml( QDomElement &parentElement, const QgsReadWriteContext &context ) override;
161 
166  void readChildrenFromXml( QDomElement &element, const QgsReadWriteContext &context );
167 
171  virtual QString dump() const override;
172 
176  virtual QgsLayerTreeGroup *clone() const override SIP_FACTORY;
177 
182  virtual void resolveReferences( const QgsProject *project, bool looseMatching = false ) override;
183 
187  virtual void setItemVisibilityCheckedRecursive( bool checked ) override;
188 
193  bool isMutuallyExclusive() const;
194 
201  void setIsMutuallyExclusive( bool enabled, int initialChildIndex = -1 );
202 
203  protected slots:
204  void nodeVisibilityChanged( QgsLayerTreeNode *node );
205 
206  protected:
207 
211  void updateChildVisibilityMutuallyExclusive();
212 
213  QString mName;
214 
215  bool mChangingChildVisibility = false;
216 
218  bool mMutuallyExclusive = false;
219 
224  int mMutuallyExclusiveChildIndex = -1;
225 
226  private:
227 
228 #ifdef SIP_RUN
229 
233  QgsLayerTreeGroup( const QgsLayerTreeGroup &other );
234 #endif
235 
236 };
237 
238 
239 #endif // QGSLAYERTREEGROUP_H
Layer tree group node serves as a container for layers and further groups.
The class is used as a container of context for various read/write operations on other objects...
Base class for all map layer types.
Definition: qgsmaplayer.h:56
virtual QString name() const =0
Return name of the node.
virtual void setName(const QString &name)=0
Set name of the node.
virtual void writeXml(QDomElement &parentElement, const QgsReadWriteContext &context)=0
Write layer tree to XML.
virtual QgsLayerTreeNode * clone() const =0
Create a copy of the node. Returns new instance.
virtual QString dump() const =0
Return string with layer tree structure. For debug purposes only.
static QgsLayerTreeNode * readXml(QDomElement &element, const QgsReadWriteContext &context)
Read layer tree from XML.
virtual void setItemVisibilityCheckedRecursive(bool checked)
Check or uncheck a node and all its children (taking into account exclusion rules) ...
#define SIP_TRANSFER
Definition: qgis_sip.h:36
This class is a base class for nodes in a layer tree.
Reads and writes project states.
Definition: qgsproject.h:81
#define SIP_FACTORY
Definition: qgis_sip.h:69
virtual void resolveReferences(const QgsProject *project, bool looseMatching=false)=0
Turn textual references to layers into map layer object from project.
Layer tree node points to a map layer.