QGIS API Documentation  3.37.0-Master (a5b4d9743e8)
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_sip.h"
21 #include "qgslayertreenode.h"
22 #include "qgsmaplayerref.h"
23 #include "qgsreadwritecontext.h"
24 #include "qgslegendpatchshape.h"
25 
26 class QgsMapLayer;
27 
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 #ifdef SIP_RUN
58  SIP_PYOBJECT __repr__();
59  % MethodCode
60  QString str = QStringLiteral( "<QgsLayerTreeLayer: %1>" ).arg( sipCpp->name() );
61  sipRes = PyUnicode_FromString( str.toUtf8().constData() );
62  % End
63 #endif
64 
70  QString layerId() const { return mRef.layerId; }
71 
81  QgsMapLayer *layer() const { return mRef.get(); }
82 
89  QString name() const override;
90 
97  void setName( const QString &n ) override;
98 
104  void setUseLayerName( bool use = true );
105 
110  bool useLayerName() const;
111 
116  static QgsLayerTreeLayer *readXml( QDomElement &element, const QgsReadWriteContext &context ) SIP_FACTORY;
117 
122  static QgsLayerTreeLayer *readXml( QDomElement &element, const QgsProject *project, const QgsReadWriteContext &context ) SIP_FACTORY;
123 
124  void writeXml( QDomElement &parentElement, const QgsReadWriteContext &context ) override;
125 
126  QString dump() const override;
127 
128  QgsLayerTreeLayer *clone() const override SIP_FACTORY;
129 
133  void resolveReferences( const QgsProject *project, bool looseMatching = false ) override;
134 
140  void setLabelExpression( const QString &expression );
141 
147  QString labelExpression() const { return mLabelExpression; }
148 
155  QgsLegendPatchShape patchShape() const;
156 
163  void setPatchShape( const QgsLegendPatchShape &shape );
164 
174  QSizeF patchSize() const { return mPatchSize; }
175 
185  void setPatchSize( QSizeF size ) { mPatchSize = size; }
186 
193  {
197  };
198 
207  LegendNodesSplitBehavior legendSplitBehavior() const { return mSplitBehavior; }
208 
217  void setLegendSplitBehavior( LegendNodesSplitBehavior behavior ) { mSplitBehavior = behavior; }
218 
219  signals:
220 
224  void layerLoaded();
225 
230 
231  protected:
232  void attachToLayer();
233 
237  QString mLayerName;
240 
242  bool mUseLayerName = true;
243 
244  private slots:
245 
249  void layerNameChanged();
250 
254  void layerWillBeDeleted();
255 
256  private:
257 
258 #ifdef SIP_RUN
259 
263  QgsLayerTreeLayer( const QgsLayerTreeLayer &other );
264 #endif
265 
266  QgsLegendPatchShape mPatchShape;
267  QSizeF mPatchSize;
268  LegendNodesSplitBehavior mSplitBehavior = UseDefaultLegendSetting;
269 
270  QgsLayerTreeLayer &operator=( const QgsLayerTreeLayer & ) = delete;
271 };
272 
273 
274 
275 #endif // QGSLAYERTREELAYER_H
Layer tree node points to a map layer.
QString layerId() const
Returns the ID for the map layer associated with this node.
QString mLabelExpression
Expression to evaluate in the legend.
void setPatchSize(QSizeF size)
Sets the user (overridden) size for the legend node.
QgsMapLayerRef mRef
Weak reference to the layer (or just it's ID if the reference is not resolved yet)
void layerWillBeUnloaded()
Emitted when a previously available layer got unloaded (from layer registry).
LegendNodesSplitBehavior
Legend node column split behavior.
@ AllowSplittingLegendNodesOverMultipleColumns
Allow splitting node's legend nodes across multiple columns.
@ PreventSplittingLegendNodesOverMultipleColumns
Prevent splitting node's legend nodes across multiple columns.
@ UseDefaultLegendSetting
Inherit default legend column splitting setting.
void layerLoaded()
Emitted when a previously unavailable layer got loaded.
QgsMapLayer * layer() const
Returns the map layer associated with this node.
void setLegendSplitBehavior(LegendNodesSplitBehavior behavior)
Sets the column split behavior for the node.
LegendNodesSplitBehavior legendSplitBehavior() const
Returns the column split behavior for the node.
QString mLayerName
Layer name - only used if layer does not exist or if mUseLayerName is false.
QSizeF patchSize() const
Returns the user (overridden) size for the legend node.
This class is a base class for nodes in a layer tree.
virtual void setName(const QString &name)=0
Set name of the node.
virtual QString dump() const =0
Returns string with layer tree structure. For debug purposes only.
virtual void writeXml(QDomElement &parentElement, const QgsReadWriteContext &context)=0
Write layer tree to XML.
static QgsLayerTreeNode * readXml(QDomElement &element, const QgsReadWriteContext &context)
Read layer tree from XML.
virtual QgsLayerTreeNode * clone() const =0
Create a copy of the node. Returns new instance.
virtual QString name() const =0
Returns name of the node.
Represents a patch shape for use in map legends.
Base class for all map layer types.
Definition: qgsmaplayer.h:75
Encapsulates a QGIS project, including sets of map layers and their styles, layouts,...
Definition: qgsproject.h:107
The class is used as a container of context for various read/write operations on other objects.
#define str(x)
Definition: qgis.cpp:38
#define SIP_FACTORY
Definition: qgis_sip.h:76