qgslayertreeutils.h

Go to the documentation of this file.

/***************************************************************************
  qgslayertreeutils.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 QGSLAYERTREEUTILS_H
#define QGSLAYERTREEUTILS_H
 
#include "qgis_core.h"
 
#include <QDomNodeList>
#include <QList>
#include <QPair>
#include <qnamespace.h>
 
class QDomElement;
class QDomDocument;
 
class QgsLayerTreeNode;
class QgsLayerTreeGroup;
class QgsLayerTreeLayer;
class QgsMapLayer;
class QgsProject;

class CORE_EXPORT QgsLayerTreeUtils
{
  public:

    static bool readOldLegend( QgsLayerTreeGroup *root, const QDomElement &legendElem );
    static bool readOldLegendLayerOrder( const QDomElement &legendElem, bool &hasCustomOrder, QStringList &order );
    static QDomElement writeOldLegend( QDomDocument &doc, QgsLayerTreeGroup *root, bool hasCustomOrder, const QList<QgsMapLayer *> &order );

    static QString checkStateToXml( Qt::CheckState state );
    static Qt::CheckState checkStateFromXml( const QString &txt );

    static bool layersEditable( const QList<QgsLayerTreeLayer *> &layerNodes, bool ignoreLayersWhichCannotBeToggled = false );

    static bool layersModified( const QList<QgsLayerTreeLayer *> &layerNodes );

    static void removeInvalidLayers( QgsLayerTreeGroup *group );

    static void storeOriginalLayersProperties( QgsLayerTreeGroup *group, const QDomDocument *doc );

    static void replaceChildrenOfEmbeddedGroups( QgsLayerTreeGroup *group );

    static void updateEmbeddedGroupsProjectPath( QgsLayerTreeGroup *group, const QgsProject *project );

    static QStringList invisibleLayerList( QgsLayerTreeNode *node );

    static void setLegendFilterByExpression( QgsLayerTreeLayer &layer, const QString &expr, bool enabled = true );
    static QString legendFilterByExpression( const QgsLayerTreeLayer &layer, bool *enabled = nullptr );
    static bool hasLegendFilterExpression( const QgsLayerTreeGroup &group );

    static QgsLayerTreeLayer *insertLayerBelow( QgsLayerTreeGroup *group, const QgsMapLayer *refLayer, QgsMapLayer *layerToInsert );

    static QSet<QgsMapLayer *> collectMapLayersRecursive( const QList<QgsLayerTreeNode *> &nodes );

    static int countMapLayerInTree( QgsLayerTreeNode *tree, QgsMapLayer *layer );

    static QgsLayerTreeGroup *firstGroupWithoutCustomProperty( QgsLayerTreeGroup *group, const QString &property );

    static QgsLayerTreeLayer *insertLayerAtOptimalPlacement( QgsLayerTreeGroup *group, QgsMapLayer *layer );
};
 
#endif // QGSLAYERTREEUTILS_H