26#include "moc_qgslayertreegroup.cpp"
43 , mGroupLayer( other.mGroupLayer )
51void QgsLayerTreeGroup::init()
114 if (
id.trimmed().isEmpty() )
119 if ( customNodeIds.contains(
id ) )
129 if ( node->nodeId().trimmed().isEmpty() )
134 if ( customNodeIds.contains( node->nodeId() ) )
143 if (
id.trimmed().isEmpty() )
148 if ( customNodeIds.contains(
id ) )
158 QList<QgsLayerTreeNode *> nodes;
184 index =
mChildren.count() - nodes.count();
216 if ( childLayer->
layer() == layer )
295 if ( childLayer->
layerId() == layerId )
310 QList<QgsLayerTreeLayer *> list;
328 if ( childCustom->
nodeId() ==
id )
343 QList<QgsLayerTreeNode *> list;
356 const QList< QgsLayerTreeLayer * > childLayers =
findLayers();
362 if ( layerNode->layer() == targetLayer )
382 if ( childNode == targetNode )
396 QList<QgsMapLayer *> list;
424 QList<QgsLayerTreeNode *> list;
476 QList<QgsLayerTreeGroup *> list;
493 if ( element.tagName() != QLatin1String(
"layer-tree-group" ) )
497 bool isExpanded = ( element.attribute( QStringLiteral(
"expanded" ), QStringLiteral(
"1" ) ) == QLatin1String(
"1" ) );
499 bool isMutuallyExclusive = element.attribute( QStringLiteral(
"mutually-exclusive" ), QStringLiteral(
"0" ) ) == QLatin1String(
"1" );
500 int mutuallyExclusiveChildIndex = element.attribute( QStringLiteral(
"mutually-exclusive-child" ), QStringLiteral(
"-1" ) ).toInt();
511 groupNode->
mWmsHasTimeDimension = element.attribute( QStringLiteral(
"wms-has-time-dimension" ), QStringLiteral(
"0" ) ) == QLatin1String(
"1" );
513 groupNode->mGroupLayer =
QgsMapLayerRef( element.attribute( QStringLiteral(
"groupLayer" ) ) );
515 readLegacyServerProperties( groupNode );
522void QgsLayerTreeGroup::readLegacyServerProperties(
QgsLayerTreeGroup *groupNode )
524 const QVariant wmsShortName = groupNode->
customProperty( QStringLiteral(
"wmsShortName" ) );
525 if ( wmsShortName.isValid() )
531 const QVariant wmsTitle = groupNode->
customProperty( QStringLiteral(
"wmsTitle" ) );
532 if ( wmsTitle.isValid() )
538 const QVariant wmsAbstract = groupNode->
customProperty( QStringLiteral(
"wmsAbstract" ) );
539 if ( wmsAbstract.isValid() )
559 QDomDocument doc = parentElement.ownerDocument();
560 QDomElement elem = doc.createElement( QStringLiteral(
"layer-tree-group" ) );
561 elem.setAttribute( QStringLiteral(
"name" ),
mName );
562 elem.setAttribute( QStringLiteral(
"expanded" ),
mExpanded ? QStringLiteral(
"1" ) : QStringLiteral(
"0" ) );
563 elem.setAttribute( QStringLiteral(
"checked" ),
mChecked ? QStringLiteral(
"Qt::Checked" ) : QStringLiteral(
"Qt::Unchecked" ) );
566 elem.setAttribute( QStringLiteral(
"mutually-exclusive" ), QStringLiteral(
"1" ) );
572 elem.setAttribute( QStringLiteral(
"wms-has-time-dimension" ), QStringLiteral(
"1" ) );
575 elem.setAttribute( QStringLiteral(
"groupLayer" ), mGroupLayer.layerId );
582 node->writeXml( elem, context );
584 parentElement.appendChild( elem );
589 QList<QgsLayerTreeNode *> nodes;
590 QDomElement childElem = element.firstChildElement();
591 while ( !childElem.isNull() )
597 childElem = childElem.nextSiblingElement();
605 QString header = QStringLiteral(
"GROUP: %1 checked=%2 expanded=%3\n" ).arg(
name() ).arg(
mChecked ).arg(
mExpanded );
606 QStringList childrenDump;
608 childrenDump << node->dump().split(
'\n' );
609 for (
int i = 0; i < childrenDump.count(); ++i )
610 childrenDump[i].prepend(
" " );
611 return header + childrenDump.join( QLatin1Char(
'\n' ) );
622 node->resolveReferences( project, looseMatching );
624 mGroupLayer.resolve( project );
654 if ( _nodeIsChecked( child ) )
668 return qobject_cast< QgsGroupLayer * >( mGroupLayer.layer );
677 groupLayer->prepareLayersForRemovalFromGroup();
680 mGroupLayer.setLayer( layer );
681 refreshParentGroupLayerMembers();
686 if ( !mGroupLayer.layerId.isEmpty() )
689 auto res = std::make_unique< QgsGroupLayer >(
name(), options );
691 mGroupLayer.setLayer( res.get() );
694 return res.release();
697void QgsLayerTreeGroup::refreshParentGroupLayerMembers()
700 while ( parentGroup )
702 if (
QgsLayerTree *layerTree = qobject_cast< QgsLayerTree * >( parentGroup ) )
703 layerTree->emit layerOrderChanged();
705 parentGroup->updateGroupLayers();
706 parentGroup = qobject_cast< QgsLayerTreeGroup * >( parentGroup->
parent() );
738 int childIndex =
mChildren.indexOf( node );
739 if ( childIndex == -1 )
747 if ( _nodeIsChecked( node ) )
785void QgsLayerTreeGroup::updateGroupLayers()
791 QList< QgsMapLayer * > layers;
794 findGroupLayerChildren = [&layers, &findGroupLayerChildren](
QgsLayerTreeGroup * group )
796 for (
auto it = group->mChildren.crbegin(); it != group->mChildren.crend(); ++it )
798 if (
QgsLayerTreeLayer *layerTreeLayer = qobject_cast< QgsLayerTreeLayer * >( *it ) )
800 if ( layerTreeLayer->layer() && layerTreeLayer->isVisible() )
801 layers << layerTreeLayer->layer();
803 else if (
QgsLayerTreeGroup *childGroup = qobject_cast< QgsLayerTreeGroup * >( *it ) )
805 if ( childGroup->isVisible() )
807 if ( QgsGroupLayer *
groupLayer = childGroup->groupLayer() )
810 findGroupLayerChildren( childGroup );
815 findGroupLayerChildren(
this );
818 refreshParentGroupLayerMembers();
841 return mServerProperties.get();
846 return mServerProperties.get();
A map layer which consists of a set of child layers, where all component layers are rendered as a sin...
Layer tree custom node serves as a node for objects that are not layers nor groups.
QString nodeId() const
Returns the node's unique identifier.
Layer tree group node serves as a container for layers and further groups.
QStringList findCustomNodeIds() const
Find custom node IDs.
void insertChildNode(int index, QgsLayerTreeNode *node)
Insert existing node at specified position.
QgsLayerTreeCustomNode * insertCustomNode(int index, const QString &id, const QString &name=QString())
Insert a new custom node with the given id and name at specified index.
QgsLayerTreeCustomNode * findCustomNode(const QString &id) const
Find custom node representing an object specified by its ID.
void setName(const QString &n) override
Sets the group's name.
void resolveReferences(const QgsProject *project, bool looseMatching=false) override
Calls resolveReferences() on child tree nodes.
QgsLayerTreeGroup * findGroup(const QString &name)
Find group node with specified name.
QgsGroupLayer * convertToGroupLayer(const QgsGroupLayer::LayerOptions &options)
Converts the group to a QgsGroupLayer.
void setHasWmsTimeDimension(const bool hasWmsTimeDimension)
Sets whether the WMS time dimension should be computed for this group or not.
QgsLayerTreeGroup * insertGroup(int index, const QString &name)
Insert a new group node with given name at specified position.
void readChildrenFromXml(const QDomElement &element, const QgsReadWriteContext &context)
Read children from XML and append them to the group.
void removeChildNode(QgsLayerTreeNode *node)
Remove a child node from this group.
QList< QgsLayerTreeNode * > findLayersAndCustomNodes() const
Find all layer and custom nodes.
QList< QgsLayerTreeGroup * > findGroups(bool recursive=false) const
Find group layer nodes.
void writeXml(QDomElement &parentElement, const QgsReadWriteContext &context) override
Write group (tree) as XML element <layer-tree-group> and add it to the given parent element.
QString name() const override
Returns the group's name.
QgsLayerTreeGroup(const QString &name=QString(), bool checked=true)
Constructor.
QStringList findLayerIds() const
Find layer IDs used in all layer nodes.
QList< QgsMapLayer * > layerOrderRespectingGroupLayers() const
Returns an ordered list of map layers in the group, ignoring any layers which are child layers of Qgs...
void removeCustomNode(const QString &id)
Remove a custom node from this group.
bool mChangingChildVisibility
QgsMapLayerServerProperties * serverProperties()
Returns QGIS Server Properties for the layer tree group.
void addChildNode(QgsLayerTreeNode *node)
Append an existing node.
QList< QgsLayerTreeNode * > layerAndCustomNodeOrderRespectingGroupLayers() const
Returns an ordered list of map layers and custom nodes in the group, ignoring any layers which are ch...
void insertChildNodes(int index, const QList< QgsLayerTreeNode * > &nodes)
Insert existing nodes at specified position.
void removeAllChildren()
Remove all child nodes.
bool mMutuallyExclusive
Whether the group is mutually exclusive (i.e. only one child can be checked at a time).
void setIsMutuallyExclusive(bool enabled, int initialChildIndex=-1)
Set whether the group is mutually exclusive (only one child can be checked at a time).
void setItemVisibilityCheckedRecursive(bool checked) override
Check or uncheck a node and all its children (taking into account exclusion rules).
QgsLayerTreeGroup * clone() const override
Returns a clone of the group.
QList< QgsLayerTreeLayer * > findLayers() const
Find all layer nodes.
bool mWmsHasTimeDimension
QgsLayerTreeLayer * findLayer(QgsMapLayer *layer) const
Find layer node representing the map layer.
bool isMutuallyExclusive() const
Returns whether the group is mutually exclusive (only one child can be checked at a time).
QgsLayerTreeCustomNode * addCustomNode(const QString &id, const QString &name=QString())
Append a new custom node with the given id and name.
void updateChildVisibilityMutuallyExclusive()
Set check state of children - if mutually exclusive.
bool hasWmsTimeDimension() const
Returns whether the WMS time dimension should be computed for this group or not.
static QgsLayerTreeGroup * readXml(const QDomElement &element, const QgsReadWriteContext &context)
Read group (tree) from XML element <layer-tree-group> and return the newly created group (or nullptr ...
void setGroupLayer(QgsGroupLayer *layer)
Sets the associated group layer, if the layer tree group will be treated as group layer during map re...
QgsLayerTreeGroup * addGroup(const QString &name)
Append a new group node with given name.
void removeChildren(int from, int count)
Remove child nodes from index "from".
void removeChildrenGroupWithoutLayers()
Remove all child group nodes without layers.
QgsLayerTreeLayer * addLayer(QgsMapLayer *layer)
Append a new layer node for given map layer.
void makeOrphan() override
Sets parent to nullptr and disconnects all external and forwarded signals.
void removeLayer(QgsMapLayer *layer)
Remove map layer's node from this group.
QgsLayerTreeLayer * insertLayer(int index, QgsMapLayer *layer)
Insert a new layer node for given map layer at specified position.
QString dump() const override
Returns text representation of the tree.
void nodeVisibilityChanged(QgsLayerTreeNode *node)
void reorderGroupLayers(const QList< QgsMapLayer * > &order)
Reorders layers in the group to match the order specified by order.
int mMutuallyExclusiveChildIndex
Keeps track which child has been most recently selected (so if the whole group is unchecked and check...
void reorderGroupLayersAndCustomNodes(const QList< QgsLayerTreeNode * > &order)
Reorders layers and custom nodes in the group to match the order specified by order.
QgsGroupLayer * groupLayer()
Returns a reference to the associated group layer, if the layer tree group will be treated as group l...
Layer tree node points to a map layer.
QString layerId() const
Returns the ID for the map layer associated with this node.
QgsMapLayer * layer() const
Returns the map layer associated with this node.
QgsLayerTreeLayer * clone() const override
Create a copy of the node. Returns new instance.
Base class for nodes in a layer tree.
virtual void makeOrphan()
Sets parent to nullptr and disconnects all external and forwarded signals.
@ NodeGroup
Container of other groups and layers.
void removedChildren(QgsLayerTreeNode *node, int indexFrom, int indexTo)
Emitted when one or more nodes has been removed from a node within the tree.
void nameChanged(QgsLayerTreeNode *node, QString name)
Emitted when the name of the node is changed.
static QgsLayerTreeNode * readXml(QDomElement &element, const QgsReadWriteContext &context)
Read layer tree from XML.
QList< QgsLayerTreeNode * > children()
Gets list of children of the node. Children are owned by the parent.
void removeCustomProperty(const QString &key)
Remove a custom property from layer. Properties are stored in a map and saved in project file.
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.
QgsLayerTreeNode(NodeType t, bool checked=true)
Constructor.
void writeCommonXml(QDomElement &element)
Write common XML elements.
void insertChildrenPrivate(int index, const QList< QgsLayerTreeNode * > &nodes)
Low-level insertion of children to the node. The children must not have any parent yet!
void addedChildren(QgsLayerTreeNode *node, int indexFrom, int indexTo)
Emitted when one or more nodes have been added to a node within the tree.
void visibilityChanged(QgsLayerTreeNode *node)
Emitted when check state of a node within the tree has been changed.
QList< QgsLayerTreeNode * > mChildren
list of children - node is responsible for their deletion
bool mExpanded
whether the node should be shown in GUI as expanded
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).
void readCommonXml(const QDomElement &element)
Read common XML elements.
bool itemVisibilityChecked() const
Returns whether a node is checked (independently of its ancestors or children).
void removeChildrenPrivate(int from, int count, bool destroy=true)
Low-level removal of children from the node.
static Qt::CheckState checkStateFromXml(const QString &txt)
Convert QString to Qt::CheckState.
Namespace with helper functions for layer tree operations.
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.
static bool isCustomNode(const QgsLayerTreeNode *node)
Check whether the node is a valid custom node.
static QgsLayerTreeCustomNode * toCustomNode(QgsLayerTreeNode *node)
Cast node to a custom node.
Manages QGIS Server properties for a map layer.
void readXml(const QDomNode &layer_node)
Reads server properties from project file.
void setAbstract(const QString &abstract)
Sets the abstract of the layer used by QGIS Server in GetCapabilities request.
void setShortName(const QString &name)
Sets the short name of the layer used by QGIS Server to identify the layer.
void writeXml(QDomNode &layer_node, QDomDocument &document) const
Saves server properties to xml under the layer node.
void setTitle(const QString &title)
Sets the title of the layer used by QGIS Server in GetCapabilities request.
Base class for all map layer types.
virtual bool isSpatial() const
Returns true if the layer is considered a spatial layer, ie it has some form of geometry associated w...
virtual QString translate(const QString &context, const QString &sourceText, const char *disambiguation=nullptr, int n=-1) const =0
Translates a string using the Qt QTranslator mechanism.
Encapsulates a QGIS project, including sets of map layers and their styles, layouts,...
A container for the context for various read/write operations on objects.
const QgsProjectTranslator * projectTranslator() const
Returns the project translator.
_LayerRef< QgsMapLayer > QgsMapLayerRef
Setting options for loading group layers.
TYPE * get() const
Returns a pointer to the layer, or nullptr if the reference has not yet been matched to a layer.