mirror of
https://github.com/qgis/QGIS.git
synced 2025-11-04 00:04:25 -05:00
53 lines
2.3 KiB
Plaintext
53 lines
2.3 KiB
Plaintext
/**
|
|
* @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 QgsLayerDefinition
|
|
{
|
|
%TypeHeaderCode
|
|
#include <qgslayerdefinition.h>
|
|
%End
|
|
public:
|
|
/** Loads the QLR at path into QGIS. New layers are added to rootGroup and the map layer registry*/
|
|
static bool loadLayerDefinition( const QString & path, QgsLayerTreeGroup* rootGroup, QString &errorMessage /Out/ );
|
|
/** Loads the QLR from the XML document. New layers are added to rootGroup and the map layer registry */
|
|
static bool loadLayerDefinition( QDomDocument doc, QgsLayerTreeGroup* rootGroup, QString &errorMessage /Out/ );
|
|
/** Export the selected layer tree nodes to a QLR file */
|
|
static bool exportLayerDefinition( QString path, const QList<QgsLayerTreeNode*>& selectedTreeNodes, QString &errorMessage /Out/ );
|
|
/** Export the selected layer tree nodes to a QLR-XML document */
|
|
static bool exportLayerDefinition( QDomDocument doc, const QList<QgsLayerTreeNode*>& selectedTreeNodes, QString &errorMessage, const QString& relativeBasePath = QString::null );
|
|
|
|
/**
|
|
* Class used to work with layer dependencies stored in a XML project or layer definition file
|
|
*/
|
|
class 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 );
|
|
|
|
/** Get the layer nodes in an order where they can be loaded incrementally without dependency break */
|
|
QVector<QDomNode> sortedLayerNodes() const;
|
|
|
|
/** Get the layer IDs in an order where they can be loaded incrementally without dependency break */
|
|
QStringList sortedLayerIds() const;
|
|
|
|
/** Whether some cyclic dependency has been detected */
|
|
bool hasCycle() const;
|
|
|
|
/** Whether some dependency is missing */
|
|
bool hasMissingDependency() const;
|
|
};
|
|
};
|
|
|