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.h"
#include "qgslayertreenode.h"

class QgsMapLayer;
class QgsLayerTreeLayer;

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

    QString name() const override;

    void setName( const QString &n ) override;

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

    QgsLayerTreeGroup *addGroup( const QString &name );

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

    QgsLayerTreeLayer *addLayer( QgsMapLayer *layer );

    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 removeChildren( int from, int count );

    void removeChildrenGroupWithoutLayers();

    void removeAllChildren();

    QgsLayerTreeLayer *findLayer( QgsMapLayer *layer ) const;

    QgsLayerTreeLayer *findLayer( const QString &layerId ) const;

    QList<QgsLayerTreeLayer *> findLayers() const;

    QStringList findLayerIds() const;

    QgsLayerTreeGroup *findGroup( const QString &name );

    QList<QgsLayerTreeGroup *> findGroups() const;

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

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

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

    void readChildrenFromXml( 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 );

  protected slots:
    void nodeVisibilityChanged( QgsLayerTreeNode *node );

  protected:

    void updateChildVisibilityMutuallyExclusive();

    QString mName;

    bool mChangingChildVisibility = false;

    bool mMutuallyExclusive = false;

    int mMutuallyExclusiveChildIndex = -1;

  private:

#ifdef SIP_RUN

    QgsLayerTreeGroup( const QgsLayerTreeGroup &other );
#endif

};


#endif // QGSLAYERTREEGROUP_H