qgslayerdefinition.h

Go to the documentation of this file.

/***************************************************************************
    qgslayerdefinition.h
    ---------------------
    begin                : January 2015
    copyright            : (C) 2015 by Nathan Woodrow
    email                : woodrow dot nathan 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 QGSLAYERDEFINITION_H
#define QGSLAYERDEFINITION_H
 
 
#include "qgis.h"
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgslayertreeregistrybridge.h"
 
#include <QDomNode>
#include <QSet>
#include <QString>
#include <QVector>
 
class QDomDocument;
 
class QgsLayerTreeGroup;
class QgsLayerTreeNode;
class QgsMapLayer;
class QgsReadWriteContext;
class QgsProject;

class CORE_EXPORT QgsLayerDefinition
{
  public:
    static bool loadLayerDefinition(
      const QString &path,
      QgsProject *project,
      QgsLayerTreeGroup *rootGroup,
      QString &errorMessage SIP_OUT,
      Qgis::LayerTreeInsertionMethod insertMethod = Qgis::LayerTreeInsertionMethod::OptimalInInsertionGroup,
      const QgsLayerTreeRegistryBridge::InsertionPoint *insertPoint = nullptr
    );

    static bool loadLayerDefinition(
      QDomDocument doc,
      QgsProject *project,
      QgsLayerTreeGroup *rootGroup,
      QString &errorMessage SIP_OUT,
      QgsReadWriteContext &context,
      Qgis::LayerTreeInsertionMethod insertMethod = Qgis::LayerTreeInsertionMethod::OptimalInInsertionGroup,
      const QgsLayerTreeRegistryBridge::InsertionPoint *insertPoint = nullptr
    );
 
    // TODO QGIS 5.0 -- remove this in favour of the version with explicit Qgis::FilePathType parameter
    Q_DECL_DEPRECATED static bool exportLayerDefinition( const QString &path, const QList<QgsLayerTreeNode *> &selectedTreeNodes, QString &errorMessage SIP_OUT ) SIP_DEPRECATED;

    static bool exportLayerDefinition( const QString &path, const QList<QgsLayerTreeNode *> &selectedTreeNodes, Qgis::FilePathType pathType, QString &errorMessage SIP_OUT );

    static bool exportLayerDefinition( QDomDocument doc, const QList<QgsLayerTreeNode *> &selectedTreeNodes, QString &errorMessage SIP_OUT, const QgsReadWriteContext &context );

    static QDomDocument exportLayerDefinitionLayers( const QList<QgsMapLayer *> &layers, const QgsReadWriteContext &context );

    static QList<QgsMapLayer *> loadLayerDefinitionLayers( QDomDocument &document, QgsReadWriteContext &context ) SIP_FACTORY;

    static QList<QgsMapLayer *> loadLayerDefinitionLayers( const QString &qlrfile ) SIP_FACTORY;

    class CORE_EXPORT DependencySorter
    {
      public:
        explicit DependencySorter( const QDomDocument &doc );

        explicit DependencySorter( const QString &fileName );

        QVector<QDomNode> sortedLayerNodes() const { return mSortedLayerNodes; }

        QStringList sortedLayerIds() const { return mSortedLayerIds; }

        bool hasCycle() const { return mHasCycle; }

        bool hasMissingDependency() const { return mHasMissingDependency; }

        bool isLayerDependent( const QString &layerId ) const;
 
      private:
        QVector<QDomNode> mSortedLayerNodes;
        QStringList mSortedLayerIds;
        QSet<QString> mDependentLayerIds;
        bool mHasCycle;
        bool mHasMissingDependency;
        void init( const QDomDocument &doc );
    };
 
  private:
    static QList<QgsMapLayer *> loadLayerDefinitionLayersInternal( QDomDocument &document, QgsReadWriteContext &context, QString &errorMessage );
};
 
#endif // QGSLAYERDEFINITION_H