27using namespace Qt::StringLiterals;
29static void _readOldLegendGroup(
const QDomElement &groupElem,
QgsLayerTreeGroup *parent );
30static void _readOldLegendLayer(
const QDomElement &layerElem,
QgsLayerTreeGroup *parent );
34 if ( legendElem.isNull() )
37 const QDomNodeList legendChildren = legendElem.childNodes();
39 for (
int i = 0; i < legendChildren.size(); ++i )
41 const QDomElement currentChildElem = legendChildren.at( i ).toElement();
42 if ( currentChildElem.tagName() ==
"legendlayer"_L1 )
44 _readOldLegendLayer( currentChildElem, root );
46 else if ( currentChildElem.tagName() ==
"legendgroup"_L1 )
48 _readOldLegendGroup( currentChildElem, root );
57static bool _readOldLegendLayerOrderGroup(
const QDomElement &groupElem, QMap<int, QString> &layerIndexes )
59 const QDomNodeList legendChildren = groupElem.childNodes();
61 for (
int i = 0; i < legendChildren.size(); ++i )
63 const QDomElement currentChildElem = legendChildren.at( i ).toElement();
64 if ( currentChildElem.tagName() ==
"legendlayer"_L1 )
66 const QDomElement layerFileElem = currentChildElem.firstChildElement( u
"filegroup"_s ).firstChildElement( u
"legendlayerfile"_s );
68 const int layerIndex = currentChildElem.attribute( u
"drawingOrder"_s ).toInt();
69 if ( layerIndex == -1 )
71 layerIndexes.insert( layerIndex, layerFileElem.attribute( u
"layerid"_s ) );
73 else if ( currentChildElem.tagName() ==
"legendgroup"_L1 )
75 if ( !_readOldLegendLayerOrderGroup( currentChildElem, layerIndexes ) )
86 if ( legendElem.isNull() )
89 hasCustomOrder = legendElem.attribute( u
"updateDrawingOrder"_s ) ==
"false"_L1;
92 QMap<int, QString> layerIndexes;
95 const bool res = _readOldLegendLayerOrderGroup( legendElem, layerIndexes );
97 if ( !res && hasCustomOrder )
100 const auto constLayerIndexes = layerIndexes;
101 for (
const QString &layerId : constLayerIndexes )
104 order.append( layerId );
111static QDomElement _writeOldLegendLayer( QDomDocument &doc,
QgsLayerTreeLayer *nodeLayer,
bool hasCustomOrder,
const QList<QgsMapLayer *> &order )
113 int drawingOrder = -1;
114 if ( hasCustomOrder )
115 drawingOrder = order.indexOf( nodeLayer->
layer() );
117 QDomElement layerElem = doc.createElement( u
"legendlayer"_s );
118 layerElem.setAttribute( u
"drawingOrder"_s, drawingOrder );
119 layerElem.setAttribute( u
"open"_s, nodeLayer->
isExpanded() ? u
"true"_s : u
"false"_s );
121 layerElem.setAttribute( u
"name"_s, nodeLayer->
name() );
122 layerElem.setAttribute( u
"showFeatureCount"_s, nodeLayer->
customProperty( u
"showFeatureCount"_s ).toInt() );
124 QDomElement fileGroupElem = doc.createElement( u
"filegroup"_s );
125 fileGroupElem.setAttribute( u
"open"_s, nodeLayer->
isExpanded() ? u
"true"_s : u
"false"_s );
126 fileGroupElem.setAttribute( u
"hidden"_s, u
"false"_s );
128 QDomElement layerFileElem = doc.createElement( u
"legendlayerfile"_s );
129 layerFileElem.setAttribute( u
"isInOverview"_s, nodeLayer->
customProperty( u
"overview"_s ).toInt() );
130 layerFileElem.setAttribute( u
"layerid"_s, nodeLayer->
layerId() );
131 layerFileElem.setAttribute( u
"visible"_s, nodeLayer->
isVisible() ? 1 : 0 );
133 layerElem.appendChild( fileGroupElem );
134 fileGroupElem.appendChild( layerFileElem );
139static void _writeOldLegendGroupChildren( QDomDocument &doc, QDomElement &groupElem,
QgsLayerTreeGroup *nodeGroup,
bool hasCustomOrder,
const QList<QgsMapLayer *> &order );
141static QDomElement _writeOldLegendGroup( QDomDocument &doc,
QgsLayerTreeGroup *nodeGroup,
bool hasCustomOrder,
const QList<QgsMapLayer *> &order )
143 QDomElement groupElem = doc.createElement( u
"legendgroup"_s );
144 groupElem.setAttribute( u
"open"_s, nodeGroup->
isExpanded() ? u
"true"_s : u
"false"_s );
145 groupElem.setAttribute( u
"name"_s, nodeGroup->
name() );
150 groupElem.setAttribute( u
"embedded"_s, 1 );
151 groupElem.setAttribute( u
"project"_s, nodeGroup->
customProperty( u
"embedded_project"_s ).toString() );
154 _writeOldLegendGroupChildren( doc, groupElem, nodeGroup, hasCustomOrder, order );
159static void _writeOldLegendGroupChildren( QDomDocument &doc, QDomElement &groupElem,
QgsLayerTreeGroup *nodeGroup,
bool hasCustomOrder,
const QList<QgsMapLayer *> &order )
161 const auto constChildren = nodeGroup->
children();
166 groupElem.appendChild( _writeOldLegendGroup( doc,
QgsLayerTree::toGroup( node ), hasCustomOrder, order ) );
170 groupElem.appendChild( _writeOldLegendLayer( doc,
QgsLayerTree::toLayer( node ), hasCustomOrder, order ) );
178 QDomElement legendElem = doc.createElement( u
"legend"_s );
179 legendElem.setAttribute( u
"updateDrawingOrder"_s, hasCustomOrder ? u
"false"_s : u
"true"_s );
181 _writeOldLegendGroupChildren( doc, legendElem, root, hasCustomOrder, order );
192 return u
"Qt::Unchecked"_s;
193 case Qt::PartiallyChecked:
194 return u
"Qt::PartiallyChecked"_s;
196 return u
"Qt::Checked"_s;
203 if ( txt ==
"Qt::Unchecked"_L1 )
204 return Qt::Unchecked;
205 else if ( txt ==
"Qt::PartiallyChecked"_L1 )
206 return Qt::PartiallyChecked;
213static void _readOldLegendGroup(
const QDomElement &groupElem,
QgsLayerTreeGroup *parent )
215 const QDomNodeList groupChildren = groupElem.childNodes();
220 groupNode->
setExpanded( groupElem.attribute( u
"open"_s ) ==
"true"_L1 );
222 if ( groupElem.attribute( u
"embedded"_s ) ==
"1"_L1 )
225 groupNode->
setCustomProperty( u
"embedded_project"_s, groupElem.attribute( u
"project"_s ) );
228 for (
int i = 0; i < groupChildren.size(); ++i )
230 const QDomElement currentChildElem = groupChildren.at( i ).toElement();
231 if ( currentChildElem.tagName() ==
"legendlayer"_L1 )
233 _readOldLegendLayer( currentChildElem, groupNode );
235 else if ( currentChildElem.tagName() ==
"legendgroup"_L1 )
237 _readOldLegendGroup( currentChildElem, groupNode );
244static void _readOldLegendLayer(
const QDomElement &layerElem,
QgsLayerTreeGroup *parent )
246 const QDomElement layerFileElem = layerElem.firstChildElement( u
"filegroup"_s ).firstChildElement( u
"legendlayerfile"_s );
247 const QString layerId = layerFileElem.attribute( u
"layerid"_s );
251 layerNode->
setExpanded( layerElem.attribute( u
"open"_s ) ==
"true"_L1 );
253 if ( layerFileElem.attribute( u
"isInOverview"_s ) ==
"1"_L1 )
256 if ( layerElem.attribute( u
"embedded"_s ) ==
"1"_L1 )
259 if ( layerElem.attribute( u
"showFeatureCount"_s ) ==
"1"_L1 )
269 const auto constLayerNodes = layerNodes;
284 const auto constLayerNodes = layerNodes;
299 QList<QgsLayerTreeNode *> nodesToRemove;
300 const auto constChildren = group->
children();
308 nodesToRemove << node;
312 const auto constNodesToRemove = nodesToRemove;
319 const QDomElement projectLayersElement { doc->documentElement().firstChildElement( u
"projectlayers"_s ) };
331 QDomElement layerElement { projectLayersElement.firstChildElement( u
"maplayer"_s ) };
332 while ( ! layerElement.isNull() )
334 const QString id( layerElement.firstChildElement( u
"id"_s ).firstChild().nodeValue() );
338 QTextStream stream( &str );
339 layerElement.save( stream, 4 );
340 l->setOriginalXmlProperties( u
"<!DOCTYPE qgis PUBLIC 'http://mrcc.com/qgis.dtd' 'SYSTEM'>\n%1"_s.arg( str ) );
343 layerElement = layerElement.nextSiblingElement( );
349 const QList<QgsLayerTreeNode *> constChildren( node->children( ) );
350 for (
const auto &childNode : constChildren )
357 const QList<QgsLayerTreeNode *> children = group->
children();
373 if ( child->itemVisibilityChecked() == Qt::Unchecked )
392 const auto constChildren = group->
children();
397 if ( child->customProperty( u
"embedded"_s ).toInt() )
399 child->setCustomProperty( u
"embedded-invisible-layers"_s,
invisibleLayerList( child ) );
413 const auto constChildren = group->
children();
416 if ( !node->customProperty( u
"embedded_project"_s ).toString().isEmpty() )
419 const QString newPath = project->
writePath( node->customProperty( u
"embedded_project"_s ).toString() );
420 node->setCustomProperty( u
"embedded_project"_s, newPath );
433 layer.
setCustomProperty( u
"legend/expressionFilterEnabled"_s, enabled && !expr.isEmpty() );
438 const QString expression = layer.
customProperty( u
"legend/expressionFilter"_s, QString() ).toString();
440 *enabled = !expression.isEmpty() && layer.
customProperty( u
"legend/expressionFilterEnabled"_s, QString() ).toBool();
446 const auto constFindLayers = group.
findLayers();
451 if ( exprEnabled && !expr.isEmpty() )
478 return parent->
insertLayer( idx + 1, layerToInsert );
481static void _collectMapLayers(
const QList<QgsLayerTreeNode *> &nodes, QSet<QgsMapLayer *> &layersSet )
488 if ( nodeLayer->
layer() )
489 layersSet << nodeLayer->
layer();
500 QSet<QgsMapLayer *> layersSet;
501 _collectMapLayers( nodes, layersSet );
515 const QList<QgsLayerTreeNode *> children = tree->
children();
539 int vectorLineIndex = 0;
540 int vectorPolygonIndex = 0;
541 int pointCloudIndex = 0;
544 int basemapIndex = 0;
546 const QList<QgsLayerTreeNode *> children = group->
children();
553 const QgsMapLayer *childLayer = qobject_cast<const QgsLayerTreeLayer *>( child )->layer();
557 switch ( childLayer->
type() )
564 if ( vectorLineIndex < nodeIdx )
565 vectorLineIndex = nodeIdx;
566 if ( vectorPolygonIndex < nodeIdx )
567 vectorPolygonIndex = nodeIdx;
568 if ( pointCloudIndex < nodeIdx )
569 pointCloudIndex = nodeIdx;
570 if ( meshIndex < nodeIdx )
572 if ( rasterIndex < nodeIdx )
573 rasterIndex = nodeIdx;
574 if ( basemapIndex < nodeIdx )
575 basemapIndex = nodeIdx;
579 if ( vectorPolygonIndex < nodeIdx )
580 vectorPolygonIndex = nodeIdx;
581 if ( pointCloudIndex < nodeIdx )
582 pointCloudIndex = nodeIdx;
583 if ( meshIndex < nodeIdx )
585 if ( rasterIndex < nodeIdx )
586 rasterIndex = nodeIdx;
587 if ( basemapIndex < nodeIdx )
588 basemapIndex = nodeIdx;
592 if ( pointCloudIndex < nodeIdx )
593 pointCloudIndex = nodeIdx;
594 if ( meshIndex < nodeIdx )
596 if ( rasterIndex < nodeIdx )
597 rasterIndex = nodeIdx;
598 if ( basemapIndex < nodeIdx )
599 basemapIndex = nodeIdx;
606 if ( meshIndex < nodeIdx )
608 if ( rasterIndex < nodeIdx )
609 rasterIndex = nodeIdx;
610 if ( basemapIndex < nodeIdx )
611 basemapIndex = nodeIdx;
617 if ( rasterIndex < nodeIdx )
618 rasterIndex = nodeIdx;
619 if ( basemapIndex < nodeIdx )
620 basemapIndex = nodeIdx;
630 if ( basemapIndex < nodeIdx )
631 basemapIndex = nodeIdx;
647 switch ( layer->
type() )
658 index = vectorLineIndex;
662 index = vectorPolygonIndex;
669 index = pointCloudIndex;
687 index = basemapIndex;
694 index = basemapIndex;
@ UsersCannotToggleEditing
Indicates that users are not allowed to toggle editing for this layer. Note that this does not imply ...
@ Group
Composite group layer. Added in QGIS 3.24.
@ Plugin
Plugin based layer.
@ Annotation
Contains freeform, georeferenced annotations. Added in QGIS 3.16.
@ VectorTile
Vector tile layer. Added in QGIS 3.14.
@ Mesh
Mesh layer. Added in QGIS 3.2.
@ PointCloud
Point cloud layer. Added in QGIS 3.18.
virtual QString name() const =0
Returns a provider name.
Layer tree group node serves as a container for layers and further groups.
void removeChildNode(QgsLayerTreeNode *node)
Remove a child node from this group.
QString name() const override
Returns the group's name.
void addChildNode(QgsLayerTreeNode *node)
Append an existing node.
void removeAllChildren()
Remove all child nodes.
QList< QgsLayerTreeLayer * > findLayers() const
Find all layer nodes.
QgsLayerTreeLayer * findLayer(QgsMapLayer *layer) const
Find layer node representing the map layer.
QgsLayerTreeLayer * insertLayer(int index, QgsMapLayer *layer)
Insert a new layer node for given map layer at specified position.
Layer tree node points to a map layer.
QString layerId() const
Returns the ID for the map layer associated with this node.
QString name() const override
Returns the layer's name.
QgsMapLayer * layer() const
Returns the map layer associated with this node.
Base class for nodes in a layer tree.
@ NodeLayer
Leaf node pointing to a layer.
bool isVisible() const
Returns whether a node is really visible (ie checked and all its ancestors checked as well).
void setCustomProperty(const QString &key, const QVariant &value)
Sets a custom property for the node. Properties are stored in a map and saved in project file.
QList< QgsLayerTreeNode * > children()
Gets list of children of the node. Children are owned by the parent.
QVariant customProperty(const QString &key, const QVariant &defaultValue=QVariant()) const
Read a custom property from layer. Properties are stored in a map and saved in project file.
void setExpanded(bool expanded)
Sets whether the node should be shown as expanded or collapsed in GUI.
QgsLayerTreeNode * parent()
Gets pointer to the parent. If parent is nullptr, the node is a root node.
bool isExpanded() const
Returns whether the node should be shown as expanded or collapsed in GUI.
void setItemVisibilityChecked(bool checked)
Check or uncheck a node (independently of its ancestors or children).
bool itemVisibilityChecked() const
Returns whether a node is checked (independently of its ancestors or children).
static bool layersEditable(const QList< QgsLayerTreeLayer * > &layerNodes, bool ignoreLayersWhichCannotBeToggled=false)
Returns true if any of the specified layers is editable.
static QString checkStateToXml(Qt::CheckState state)
Convert Qt::CheckState to QString.
static void replaceChildrenOfEmbeddedGroups(QgsLayerTreeGroup *group)
Remove subtree of embedded groups and replaces it with a custom property embedded-visible-layers.
static QgsLayerTreeLayer * insertLayerBelow(QgsLayerTreeGroup *group, const QgsMapLayer *refLayer, QgsMapLayer *layerToInsert)
Insert a QgsMapLayer just below another one.
static void setLegendFilterByExpression(QgsLayerTreeLayer &layer, const QString &expr, bool enabled=true)
Sets the expression filter of a legend layer.
static QString legendFilterByExpression(const QgsLayerTreeLayer &layer, bool *enabled=nullptr)
Returns the expression filter of a legend layer.
static void storeOriginalLayersProperties(QgsLayerTreeGroup *group, const QDomDocument *doc)
Stores in a layer's originalXmlProperties the layer properties information.
static QSet< QgsMapLayer * > collectMapLayersRecursive(const QList< QgsLayerTreeNode * > &nodes)
Returns map layers from the given list of layer tree nodes.
static bool hasLegendFilterExpression(const QgsLayerTreeGroup &group)
Test if one of the layers in a group has an expression filter.
static int countMapLayerInTree(QgsLayerTreeNode *tree, QgsMapLayer *layer)
Returns how many occurrences of a map layer are there in a layer tree.
static QDomElement writeOldLegend(QDomDocument &doc, QgsLayerTreeGroup *root, bool hasCustomOrder, const QList< QgsMapLayer * > &order)
Returns.
static bool readOldLegendLayerOrder(const QDomElement &legendElem, bool &hasCustomOrder, QStringList &order)
Try to load custom layer order from.
static QgsLayerTreeLayer * insertLayerAtOptimalPlacement(QgsLayerTreeGroup *group, QgsMapLayer *layer)
Inserts a layer within a given group at an optimal index position by insuring a given layer type will...
static void updateEmbeddedGroupsProjectPath(QgsLayerTreeGroup *group, const QgsProject *project)
Updates an embedded group from a project.
static bool readOldLegend(QgsLayerTreeGroup *root, const QDomElement &legendElem)
Try to load layer tree from.
static QgsLayerTreeGroup * firstGroupWithoutCustomProperty(QgsLayerTreeGroup *group, const QString &property)
Returns the first parent which doesn't have the given custom property or the group itself if it doesn...
static void removeInvalidLayers(QgsLayerTreeGroup *group)
Removes layer nodes that refer to invalid layers.
static Qt::CheckState checkStateFromXml(const QString &txt)
Convert QString to Qt::CheckState.
static QStringList invisibleLayerList(QgsLayerTreeNode *node)
Gets invisible layers.
static bool layersModified(const QList< QgsLayerTreeLayer * > &layerNodes)
Returns true if any of the layers is modified.
static QgsLayerTreeLayer * toLayer(QgsLayerTreeNode *node)
Cast node to a layer.
static bool isLayer(const QgsLayerTreeNode *node)
Check whether the node is a valid layer node.
static bool isGroup(QgsLayerTreeNode *node)
Check whether the node is a valid group node.
static QgsLayerTreeGroup * toGroup(QgsLayerTreeNode *node)
Cast node to a group.
Base class for all map layer types.
virtual Qgis::MapLayerProperties properties() const
Returns the map layer properties of this layer.
virtual bool isEditable() const
Returns true if the layer can be edited.
virtual bool isModified() const
Returns true if the layer has been modified since last commit/save.
virtual Q_INVOKABLE QgsDataProvider * dataProvider()
Returns the layer's data provider, it may be nullptr.
Encapsulates a QGIS project, including sets of map layers and their styles, layouts,...
QString writePath(const QString &filename) const
Prepare a filename to save it to the project file.
Represents a vector layer which manages a vector based dataset.
Q_INVOKABLE Qgis::GeometryType geometryType() const
Returns point, line or polygon.
#define QgsDebugMsgLevel(str, level)