-
-
Notifications
You must be signed in to change notification settings - Fork 3k
/
qgslayerdefinition.h
126 lines (104 loc) · 5.26 KB
/
qgslayerdefinition.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
/***************************************************************************
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_core.h"
#include "qgis_sip.h"
#include <QString>
#include <QVector>
#include <QDomNode>
class QDomDocument;
class QgsLayerTreeGroup;
class QgsLayerTreeNode;
class QgsMapLayer;
class QgsReadWriteContext;
class QgsProject;
/**
* \ingroup core
* \brief The QgsLayerDefinition class holds generic methods for loading/exporting QLR files.
*
* QLR files are an export of the layer xml including the style and datasource location. There is no link
* to the QLR file once loaded. Consider the QLR file a mini project file for layers and styles. QLR
* files also store the layer tree info for the exported layers, including group information.
*/
class CORE_EXPORT QgsLayerDefinition
{
public:
//! Loads the QLR at path into QGIS. New layers are added to given project into layer tree specified by rootGroup
static bool loadLayerDefinition( const QString &path, QgsProject *project, QgsLayerTreeGroup *rootGroup, QString &errorMessage SIP_OUT );
//! Loads the QLR from the XML document. New layers are added to given project into layer tree specified by rootGroup
static bool loadLayerDefinition( QDomDocument doc, QgsProject *project, QgsLayerTreeGroup *rootGroup, QString &errorMessage SIP_OUT, QgsReadWriteContext &context );
//! Export the selected layer tree nodes to a QLR file
static bool exportLayerDefinition( QString path, const QList<QgsLayerTreeNode *> &selectedTreeNodes, QString &errorMessage SIP_OUT );
//! Export the selected layer tree nodes to a QLR-XML document
static bool exportLayerDefinition( QDomDocument doc, const QList<QgsLayerTreeNode *> &selectedTreeNodes, QString &errorMessage SIP_OUT, const QgsReadWriteContext &context );
/**
* Returns the given layer as a layer definition document
* Layer definitions store the data source as well as styling and custom properties.
*
* Layer definitions can be used to load a layer and styling all from a single file.
*
* This is a low-level routine that does not write layer tree.
* \see exportLayerDefinition()
*/
static QDomDocument exportLayerDefinitionLayers( const QList<QgsMapLayer *> &layers, const QgsReadWriteContext &context );
/**
* Creates new layers from a layer definition document.
* This is a low-level routine that does not resolve layer ID conflicts, dependencies and joins
* \see loadLayerDefinition()
*/
static QList<QgsMapLayer *> loadLayerDefinitionLayers( QDomDocument &document, QgsReadWriteContext &context ) SIP_FACTORY;
/**
* Creates new layers from a layer definition file (.QLR)
* This is a low-level routine that does not resolve layer ID conflicts, dependencies and joins
* \see loadLayerDefinition()
*/
static QList<QgsMapLayer *> loadLayerDefinitionLayers( const QString &qlrfile ) SIP_FACTORY;
/**
* \ingroup core
* \brief Class used to work with layer dependencies stored in a XML project or layer definition file
*/
class CORE_EXPORT DependencySorter
{
public:
/**
* Constructor
* \param doc The XML document containing maplayer elements
*/
DependencySorter( const QDomDocument &doc );
/**
* Constructor
* \param fileName The filename where the XML document is stored
*/
DependencySorter( const QString &fileName );
//! Gets the layer nodes in an order where they can be loaded incrementally without dependency break
QVector<QDomNode> sortedLayerNodes() const { return mSortedLayerNodes; }
//! Gets the layer IDs in an order where they can be loaded incrementally without dependency break
QStringList sortedLayerIds() const { return mSortedLayerIds; }
//! Whether some cyclic dependency has been detected
bool hasCycle() const { return mHasCycle; }
//! Whether some dependency is missing
bool hasMissingDependency() const { return mHasMissingDependency; }
private:
QVector<QDomNode> mSortedLayerNodes;
QStringList mSortedLayerIds;
bool mHasCycle;
bool mHasMissingDependency;
void init( const QDomDocument &doc );
};
private:
static QList<QgsMapLayer *> loadLayerDefinitionLayersInternal( QDomDocument &document, QgsReadWriteContext &context, QString &errorMessage );
};
#endif // QGSLAYERDEFINITION_H