QGIS API Documentation 3.99.0-Master (a8f284845db)
Loading...
Searching...
No Matches
qgsprojectutils.h
Go to the documentation of this file.
1/***************************************************************************
2 qgsprojectutils.h
3 -------------------
4 begin : July 2021
5 copyright : (C) 2021 Nyall Dawson
6 email : nyall dot dawson at gmail dot com
7 ***************************************************************************/
8
9/***************************************************************************
10 * *
11 * This program is free software; you can redistribute it and/or modify *
12 * it under the terms of the GNU General Public License as published by *
13 * the Free Software Foundation; either version 2 of the License, or *
14 * (at your option) any later version. *
15 * *
16 ***************************************************************************/
17#ifndef QGSPROJECTUTILS_H
18#define QGSPROJECTUTILS_H
19
20#include "qgis.h"
21#include "qgis_core.h"
22#include "qgis_sip.h"
23#include "qgsproject.h"
24
25#include <QList>
26
27class QgsMapLayer;
28
34class CORE_EXPORT QgsProjectUtils
35{
36
37 public:
38
44 static QList< QgsMapLayer * > layersMatchingPath( const QgsProject *project, const QString &path );
45
51 static QList< QgsMapLayer * > layersMatchingUri( const QgsProject *project, const QString &provider, const QString &uri, Qgis::SourceHierarchyLevel level = Qgis::SourceHierarchyLevel::Object );
52
59 static bool updateLayerPath( QgsProject *project, const QString &oldPath, const QString &newPath );
60
66 static bool layerIsContainedInGroupLayer( QgsProject *project, QgsMapLayer *layer );
67
74
75};
76
77#endif // QGSPROJECTUTILS_H
78
79
ProjectTrustStatus
Project trust status.
Definition qgis.h:473
SourceHierarchyLevel
Defines the structural levels within a data source hierarchy.
Definition qgis.h:1451
@ Object
Represents a specific data entity, e.g. a table, view, or layer.
Definition qgis.h:1454
Base class for all map layer types.
Definition qgsmaplayer.h:83
Contains utility functions for working with QGIS projects.
static bool updateLayerPath(QgsProject *project, const QString &oldPath, const QString &newPath)
Updates a project, replacing the data source for all layers which match the given oldPath with source...
static QList< QgsMapLayer * > layersMatchingUri(const QgsProject *project, const QString &provider, const QString &uri, Qgis::SourceHierarchyLevel level=Qgis::SourceHierarchyLevel::Object)
Returns a list of all layers in the specified project point to the same uri resource at the specified...
static Qgis::ProjectTrustStatus checkUserTrust(QgsProject *project)
Returns the current trust status of the specified project.
static bool layerIsContainedInGroupLayer(QgsProject *project, QgsMapLayer *layer)
Returns true if the specified layer is a child layer from any QgsGroupLayer in the given project.
static QList< QgsMapLayer * > layersMatchingPath(const QgsProject *project, const QString &path)
Returns a list of all layers in the specified project which match the given path.
Encapsulates a QGIS project, including sets of map layers and their styles, layouts,...
Definition qgsproject.h:113