28#include "moc_qgslayertreegroup.cpp"
30using namespace Qt::StringLiterals;
49 , mGroupLayer( other.mGroupLayer )
51 , mWmsGroupRequestMode( other.mWmsGroupRequestMode )
58void QgsLayerTreeGroup::init()
80void QgsLayerTreeGroup::setId(
const QString &
id )
126 if (
id.trimmed().isEmpty() )
131 if ( customNodeIds.contains(
id ) )
141 if ( node->id().trimmed().isEmpty() )
146 if ( customNodeIds.contains( node->id() ) )
155 if (
id.trimmed().isEmpty() )
160 if ( customNodeIds.contains(
id ) )
170 QList<QgsLayerTreeNode *> nodes;
196 index =
mChildren.count() - nodes.count();
228 if ( childLayer->
layer() == layer )
246 if ( childCustom->
id() == customNode->
id() )
316 if ( childLayer->
layerId() == layerId )
331 QList<QgsLayerTreeLayer *> list;
349 if ( childCustom->
id() ==
id )
364 QList<QgsLayerTreeNode *> list;
377 const QList< QgsLayerTreeLayer * > childLayers =
findLayers();
383 if ( layerNode->layer() == targetLayer )
403 if ( childNode == targetNode )
417 QList<QgsMapLayer *> list;
445 QList<QgsLayerTreeNode *> list;
497 QList<QgsLayerTreeGroup *> list;
514 if ( element.tagName() !=
"layer-tree-group"_L1 )
518 bool isExpanded = ( element.attribute( u
"expanded"_s, u
"1"_s ) ==
"1"_L1 );
521 int mutuallyExclusiveChildIndex = element.attribute( u
"mutually-exclusive-child"_s, u
"-1"_s ).toInt();
525 const QString
id = element.attribute( u
"id"_s );
536 groupNode->
mWmsHasTimeDimension = element.attribute( u
"wms-has-time-dimension"_s, u
"0"_s ) ==
"1"_L1;
540 groupNode->mGroupLayer =
QgsMapLayerRef( element.attribute( u
"groupLayer"_s ) );
542 readLegacyServerProperties( groupNode );
549void QgsLayerTreeGroup::readLegacyServerProperties(
QgsLayerTreeGroup *groupNode )
551 const QVariant wmsShortName = groupNode->
customProperty( u
"wmsShortName"_s );
552 if ( wmsShortName.isValid() )
558 const QVariant wmsTitle = groupNode->
customProperty( u
"wmsTitle"_s );
559 if ( wmsTitle.isValid() )
565 const QVariant wmsAbstract = groupNode->
customProperty( u
"wmsAbstract"_s );
566 if ( wmsAbstract.isValid() )
586 QDomDocument doc = parentElement.ownerDocument();
587 QDomElement elem = doc.createElement( u
"layer-tree-group"_s );
588 elem.setAttribute( u
"name"_s,
mName );
589 elem.setAttribute( u
"id"_s,
mId );
590 elem.setAttribute( u
"expanded"_s,
mExpanded ? u
"1"_s : u
"0"_s );
591 elem.setAttribute( u
"checked"_s,
mChecked ? u
"Qt::Checked"_s : u
"Qt::Unchecked"_s );
594 elem.setAttribute( u
"mutually-exclusive"_s, u
"1"_s );
600 elem.setAttribute( u
"wms-has-time-dimension"_s, u
"1"_s );
603 elem.setAttribute( u
"wms-group-request-mode"_s,
qgsEnumValueToKey( mWmsGroupRequestMode ) );
605 elem.setAttribute( u
"groupLayer"_s, mGroupLayer.layerId );
612 node->writeXml( elem, context );
614 parentElement.appendChild( elem );
619 QList<QgsLayerTreeNode *> nodes;
620 QDomElement childElem = element.firstChildElement();
621 while ( !childElem.isNull() )
627 childElem = childElem.nextSiblingElement();
635 QString header = u
"GROUP: %1 checked=%2 expanded=%3\n"_s.arg(
name() ).arg(
mChecked ).arg(
mExpanded );
636 QStringList childrenDump;
638 childrenDump << node->dump().split(
'\n' );
639 for (
int i = 0; i < childrenDump.count(); ++i )
640 childrenDump[i].prepend(
" " );
641 return header + childrenDump.join( QLatin1Char(
'\n' ) );
652 node->resolveReferences( project, looseMatching );
654 mGroupLayer.resolve( project );
684 if ( _nodeIsChecked( child ) )
698 return qobject_cast< QgsGroupLayer * >( mGroupLayer.layer );
707 groupLayer->prepareLayersForRemovalFromGroup();
710 mGroupLayer.setLayer( layer );
711 refreshParentGroupLayerMembers();
716 if ( !mGroupLayer.layerId.isEmpty() )
719 auto res = std::make_unique< QgsGroupLayer >(
name(), options );
721 mGroupLayer.setLayer( res.get() );
724 return res.release();
727void QgsLayerTreeGroup::refreshParentGroupLayerMembers()
730 while ( parentGroup )
732 if (
QgsLayerTree *layerTree = qobject_cast< QgsLayerTree * >( parentGroup ) )
733 layerTree->emit layerOrderChanged();
735 parentGroup->updateGroupLayers();
736 parentGroup = qobject_cast< QgsLayerTreeGroup * >( parentGroup->
parent() );
768 int childIndex =
mChildren.indexOf( node );
769 if ( childIndex == -1 )
777 if ( _nodeIsChecked( node ) )
815void QgsLayerTreeGroup::updateGroupLayers()
821 QList< QgsMapLayer * > layers;
824 findGroupLayerChildren = [&layers, &findGroupLayerChildren](
QgsLayerTreeGroup *group ) {
825 for (
auto it = group->mChildren.crbegin(); it != group->mChildren.crend(); ++it )
827 if (
QgsLayerTreeLayer *layerTreeLayer = qobject_cast< QgsLayerTreeLayer * >( *it ) )
829 if ( layerTreeLayer->layer() && layerTreeLayer->isVisible() )
830 layers << layerTreeLayer->layer();
832 else if (
QgsLayerTreeGroup *childGroup = qobject_cast< QgsLayerTreeGroup * >( *it ) )
834 if ( childGroup->isVisible() )
836 if ( QgsGroupLayer *
groupLayer = childGroup->groupLayer() )
839 findGroupLayerChildren( childGroup );
844 findGroupLayerChildren(
this );
847 refreshParentGroupLayerMembers();
870 return mServerProperties.get();
875 return mServerProperties.get();
890 return mWmsGroupRequestMode;
895 mWmsGroupRequestMode = groupRequestMode;
WmsGroupRequestMode
Request mode of groups in a WMS context.
@ Normal
Group and children can be requested.
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 id() const override
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(QgsLayerTreeCustomNode *customNode)
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).
QString id() const override
Returns the node's unique identifier.
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.
Qgis::WmsGroupRequestMode wmsGroupRequestMode() const
Returns the request mode of the group.
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.
void setWmsGroupRequestMode(Qgis::WmsGroupRequestMode groupRequestMode)
Sets the request mode of the 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.
Utility functions for working with strings.
T qgsEnumKeyToValue(const QString &key, const T &defaultValue, bool tryValueAsKey=true, bool *returnOk=nullptr)
Returns the value corresponding to the given key of an enum.
QString qgsEnumValueToKey(const T &value, bool *returnOk=nullptr)
Returns the value for the given key of an enum.
_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.