qgslayertreegroup.h

Go to the documentation of this file.

/***************************************************************************
  qgslayertreegroup.h
  --------------------------------------
  Date                 : May 2014
  Copyright            : (C) 2014 by Martin Dobias
  Email                : wonder dot sk at gmail dot com
 ***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
 
#ifndef QGSLAYERTREEGROUP_H
#define QGSLAYERTREEGROUP_H
 
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgsgrouplayer.h"
#include "qgslayertreenode.h"
#include "qgsmaplayerref.h"
 
#include <QString>
 
using namespace Qt::StringLiterals;
 
class QgsMapLayer;
class QgsLayerTreeLayer;
class QgsLayerTreeCustomNode;
class QgsGroupLayer;

class CORE_EXPORT QgsLayerTreeGroup : public QgsLayerTreeNode
{
    Q_OBJECT
  public:
    QgsLayerTreeGroup( const QString &name = QString(), bool checked = true );
 
#ifndef SIP_RUN
    QgsLayerTreeGroup( const QgsLayerTreeGroup &other );
#endif
 
#ifdef SIP_RUN
    // clang-format off
    SIP_PYOBJECT __repr__();
    % MethodCode
    QString str = u"<QgsLayerTreeGroup: %1>"_s.arg( sipCpp->name() );
    sipRes = PyUnicode_FromString( str.toUtf8().constData() );
    % End
// clang-format on
#endif

        QString name() const override;

    void setName( const QString &n ) override;
 
    QString id() const override { return mId; }

    QgsLayerTreeGroup *insertGroup( int index, const QString &name );

    QgsLayerTreeGroup *addGroup( const QString &name );

    QgsLayerTreeLayer *insertLayer( int index, QgsMapLayer *layer );

    QgsLayerTreeLayer *addLayer( QgsMapLayer *layer );

    QgsLayerTreeCustomNode *insertCustomNode( int index, const QString &id, const QString &name = QString() );

    QgsLayerTreeCustomNode *insertCustomNode( int index, QgsLayerTreeCustomNode *node SIP_TRANSFER );

    QgsLayerTreeCustomNode *addCustomNode( const QString &id, const QString &name = QString() );

    void insertChildNodes( int index, const QList<QgsLayerTreeNode *> &nodes SIP_TRANSFER );

    void insertChildNode( int index, QgsLayerTreeNode *node SIP_TRANSFER );

    void addChildNode( QgsLayerTreeNode *node SIP_TRANSFER );

    void removeChildNode( QgsLayerTreeNode *node );

    void removeLayer( QgsMapLayer *layer );

    void removeCustomNode( QgsLayerTreeCustomNode *customNode );

    void removeChildren( int from, int count );

    void removeChildrenGroupWithoutLayers();

    void removeAllChildren();

    QgsLayerTreeLayer *findLayer( QgsMapLayer *layer ) const;

    QgsLayerTreeLayer *findLayer( const QString &layerId ) const;

    QList<QgsLayerTreeLayer *> findLayers() const;

    QgsLayerTreeCustomNode *findCustomNode( const QString &id ) const;

    QList<QgsLayerTreeNode *> findLayersAndCustomNodes() const;

    void reorderGroupLayers( const QList< QgsMapLayer * > &order );

    void reorderGroupLayersAndCustomNodes( const QList< QgsLayerTreeNode * > &order );

    QList<QgsMapLayer *> layerOrderRespectingGroupLayers() const SIP_SKIP;

    QList<QgsLayerTreeNode *> layerAndCustomNodeOrderRespectingGroupLayers() const SIP_SKIP;

    QStringList findLayerIds() const;

    QStringList findCustomNodeIds() const;

    QgsLayerTreeGroup *findGroup( const QString &name );

    QList<QgsLayerTreeGroup *> findGroups( bool recursive = false ) const;

    static QgsLayerTreeGroup *readXml( const QDomElement &element, const QgsReadWriteContext &context ) SIP_FACTORY; // cppcheck-suppress duplInheritedMember

    static QgsLayerTreeGroup *readXml( const QDomElement &element, const QgsProject *project, const QgsReadWriteContext &context ) SIP_FACTORY;

    void writeXml( QDomElement &parentElement, const QgsReadWriteContext &context ) override;

    void readChildrenFromXml( const QDomElement &element, const QgsReadWriteContext &context );

    QString dump() const override;

    QgsLayerTreeGroup *clone() const override SIP_FACTORY;

    void resolveReferences( const QgsProject *project, bool looseMatching = false ) override;

    void setItemVisibilityCheckedRecursive( bool checked ) override;

    bool isMutuallyExclusive() const;

    void setIsMutuallyExclusive( bool enabled, int initialChildIndex = -1 );

    QgsGroupLayer *groupLayer();

    void setGroupLayer( QgsGroupLayer *layer );

    QgsGroupLayer *convertToGroupLayer( const QgsGroupLayer::LayerOptions &options ) SIP_FACTORY;

    QgsMapLayerServerProperties *serverProperties();

    const QgsMapLayerServerProperties *serverProperties() const SIP_SKIP;

    Q_DECL_DEPRECATED void setHasWmsTimeDimension( const bool hasWmsTimeDimension ) SIP_DEPRECATED;

    bool hasWmsTimeDimension() const;

    Qgis::WmsGroupRequestMode wmsGroupRequestMode() const;

    void setWmsGroupRequestMode( Qgis::WmsGroupRequestMode groupRequestMode );
 
  protected slots:
 
    void nodeVisibilityChanged( QgsLayerTreeNode *node );
 
  protected:
    void updateChildVisibilityMutuallyExclusive();
 
    QString mName;
 
    QString mId;
 
    bool mChangingChildVisibility = false;

    bool mMutuallyExclusive = false;

    int mMutuallyExclusiveChildIndex = -1;

    void makeOrphan() override SIP_SKIP;
 
  private:
#ifdef SIP_RUN

    QgsLayerTreeGroup( const QgsLayerTreeGroup &other );
#endif
 
    QgsLayerTreeGroup &operator=( const QgsLayerTreeGroup & ) = delete;
 
    // only QgsLayerTreeUtils::regenerateGroupIds may assign a new id
    friend class QgsLayerTreeUtils;
    void setId( const QString &id );

    static void readLegacyServerProperties( QgsLayerTreeGroup *groupNode );
 
    void init();
    void updateGroupLayers();
    void refreshParentGroupLayerMembers();
 
    QgsMapLayerRef mGroupLayer;

    std::unique_ptr< QgsMapLayerServerProperties > mServerProperties;
 
    Qgis::WmsGroupRequestMode mWmsGroupRequestMode = Qgis::WmsGroupRequestMode::Normal;
};
 
 
#endif // QGSLAYERTREEGROUP_H