QGIS API Documentation  2.99.0-Master (19b062c)
qgslayertreelayer.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgslayertreelayer.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 QGSLAYERTREELAYER_H
17 #define QGSLAYERTREELAYER_H
18 
19 #include "qgis_core.h"
20 #include "qgis.h"
21 #include "qgslayertreenode.h"
22 #include "qgsmaplayerref.h"
23 #include "qgsreadwritecontext.h"
24 
25 class QgsMapLayer;
26 
42 class CORE_EXPORT QgsLayerTreeLayer : public QgsLayerTreeNode
43 {
44  Q_OBJECT
45  public:
46  explicit QgsLayerTreeLayer( QgsMapLayer *layer );
47 
48 #ifndef SIP_RUN
49  QgsLayerTreeLayer( const QgsLayerTreeLayer &other );
50 #endif
51 
55  explicit QgsLayerTreeLayer( const QString &layerId, const QString &name = QString(), const QString &source = QString(), const QString &provider = QString() );
56 
57  QString layerId() const { return mRef.layerId; }
58 
59  QgsMapLayer *layer() const { return mRef.get(); }
60 
65  QString name() const override;
66 
71  void setName( const QString &n ) override;
72 
77  static QgsLayerTreeLayer *readXml( QDomElement &element, const QgsReadWriteContext &context ) SIP_FACTORY;
78 
84  static QgsLayerTreeLayer *readXml( QDomElement &element, const QgsProject *project, const QgsReadWriteContext &context ) SIP_FACTORY;
85 
86  virtual void writeXml( QDomElement &parentElement, const QgsReadWriteContext &context ) override;
87 
88  virtual QString dump() const override;
89 
90  virtual QgsLayerTreeLayer *clone() const override SIP_FACTORY;
91 
96  virtual void resolveReferences( const QgsProject *project, bool looseMatching = false ) override;
97 
98  signals:
99 
103  void layerLoaded();
104 
109  void layerWillBeUnloaded();
110 
111  protected:
112  void attachToLayer();
113 
117  QString mLayerName;
118 
119  private slots:
120 
125  void layerNameChanged();
126 
131  void layerWillBeDeleted();
132 
133  private:
134 
135 #ifdef SIP_RUN
136 
140  QgsLayerTreeLayer( const QgsLayerTreeLayer &other );
141 #endif
142 };
143 
144 
145 
146 #endif // QGSLAYERTREELAYER_H
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.
QString layerId() const
QgsMapLayerRef mRef
Weak reference to the layer (or just it's ID if the reference is not resolved yet) ...
QString mLayerName
Layer name - only used if layer does not exist.
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
QgsMapLayer * layer() const
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.