QGIS API Documentation
4.3.0-Master (16eddb2670e)
Toggle main menu visibility
Loading...
Searching...
No Matches
src
core
project
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
27
class
QgsMapLayer
;
28
34
class
CORE_EXPORT
QgsProjectUtils
35
{
36
public
:
42
static
QList< QgsMapLayer * >
layersMatchingPath
(
const
QgsProject
*project,
const
QString &path );
43
49
static
QList< QgsMapLayer * >
layersMatchingUri
(
const
QgsProject
*project,
const
QString &provider,
const
QString &uri,
Qgis::SourceHierarchyLevel
level =
Qgis::SourceHierarchyLevel::Object
);
50
57
static
bool
updateLayerPath
(
QgsProject
*project,
const
QString &oldPath,
const
QString &newPath );
58
64
static
bool
layerIsContainedInGroupLayer
(
QgsProject
*project,
QgsMapLayer
*layer );
65
71
static
Qgis::ProjectTrustStatus
checkUserTrust
(
QgsProject
*project );
72
};
73
74
#endif
// QGSPROJECTUTILS_H
Qgis::ProjectTrustStatus
ProjectTrustStatus
Project trust status.
Definition
qgis.h:496
Qgis::SourceHierarchyLevel
SourceHierarchyLevel
Defines the structural levels within a data source hierarchy.
Definition
qgis.h:1547
Qgis::SourceHierarchyLevel::Object
@ Object
Represents a specific data entity, e.g. a table, view, or layer.
Definition
qgis.h:1550
QgsMapLayer
Base class for all map layer types.
Definition
qgsmaplayer.h:83
QgsProjectUtils
Contains utility functions for working with QGIS projects.
Definition
qgsprojectutils.h:35
QgsProjectUtils::updateLayerPath
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...
Definition
qgsprojectutils.cpp:78
QgsProjectUtils::layersMatchingUri
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...
Definition
qgsprojectutils.cpp:50
QgsProjectUtils::checkUserTrust
static Qgis::ProjectTrustStatus checkUserTrust(QgsProject *project)
Returns the current trust status of the specified project.
Definition
qgsprojectutils.cpp:129
QgsProjectUtils::layerIsContainedInGroupLayer
static bool layerIsContainedInGroupLayer(QgsProject *project, QgsMapLayer *layer)
Returns true if the specified layer is a child layer from any QgsGroupLayer in the given project.
Definition
qgsprojectutils.cpp:95
QgsProjectUtils::layersMatchingPath
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.
Definition
qgsprojectutils.cpp:33
QgsProject
Encapsulates a QGIS project, including sets of map layers and their styles, layouts,...
Definition
qgsproject.h:114
qgis.h
qgis_sip.h
qgsproject.h
Generated on
for QGIS API Documentation by
1.17.0