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

class QgsMapLayer;
class QgsLayerTreeLayer;

class CORE_EXPORT QgsLayerTreeGroup : public QgsLayerTreeNode
{
    Q_OBJECT
  public:
    QgsLayerTreeGroup( const QString& name = QString(), Qt::CheckState checked = Qt::Checked );
    QgsLayerTreeGroup( const QgsLayerTreeGroup& other );

    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 );
    void insertChildNode( int index, QgsLayerTreeNode* node );
    void addChildNode( QgsLayerTreeNode* node );

    void removeChildNode( QgsLayerTreeNode* node );
    void removeLayer( QgsMapLayer* layer );
    void removeChildren( int from, int count );
    void removeChildrenGroupWithoutLayers();
    void removeAllChildren();

    QgsLayerTreeLayer* findLayer( const QString& layerId ) const;
    QList<QgsLayerTreeLayer*> findLayers() const;
    QStringList findLayerIds() const;
    QgsLayerTreeGroup* findGroup( const QString& name );

    static QgsLayerTreeGroup* readXML( QDomElement& element, bool looseMatch = false );

    virtual void writeXML( QDomElement& parentElement ) override;
    void readChildrenFromXML( QDomElement& element, bool looseMatch = false );

    virtual QString dump() const override;

    virtual QgsLayerTreeGroup* clone() const override;

    Qt::CheckState isVisible() const { return mChecked; }
    void setVisible( Qt::CheckState state );

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

  protected slots:
    void layerDestroyed();
    void nodeVisibilityChanged( QgsLayerTreeNode* node );

  protected:
    void updateVisibilityFromChildren();
    void updateChildVisibility();
    void updateChildVisibilityMutuallyExclusive();

  protected:
    QString mName;
    Qt::CheckState mChecked;

    bool mChangingChildVisibility;

    bool mMutuallyExclusive;
    int mMutuallyExclusiveChildIndex;
};


#endif // QGSLAYERTREEGROUP_H