QGIS API Documentation
4.3.0-Master (16eddb2670e)
Toggle main menu visibility
Loading...
Searching...
No Matches
src
core
processing
qgsprocessingprojectmodelprovider.h
Go to the documentation of this file.
1
/***************************************************************************
2
qgsprocessingprojectmodelprovider.h
3
------------------------
4
begin : August 2026
5
copyright : (C) 2026 by 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
18
#ifndef QGSPROCESSINGPROJECTMODELPROVIDER_H
19
#define QGSPROCESSINGPROJECTMODELPROVIDER_H
20
21
#include "qgis_core.h"
22
#include "
qgsprocessingprovider.h
"
23
24
#include <QDomDocument>
25
#include <QPointer>
26
27
class
QgsProcessingModelAlgorithm;
28
34
class
CORE_EXPORT
QgsProcessingProjectModelProvider
:
public
QgsProcessingProvider
35
{
36
Q_OBJECT
37
38
public
:
42
QgsProcessingProjectModelProvider
(
QgsProject
*project, QObject *parent
SIP_TRANSFERTHIS
=
nullptr
);
43
44
QString
name
()
const override
;
45
QString
longName
()
const override
;
46
QString
id
()
const override
;
47
QIcon
icon
()
const override
;
48
QString
svgIconPath
()
const override
;
49
bool
supportsNonFileBasedOutput
()
const override
;
50
bool
load
()
override
;
51
55
void
clear
();
56
60
void
addModel
(
const
QgsProcessingModelAlgorithm &model );
61
65
void
removeModel
(
const
QgsProcessingModelAlgorithm *model );
66
67
public
slots:
68
72
void
readProject
(
const
QDomDocument &document );
73
77
void
writeProject
( QDomDocument &document );
78
79
protected
:
80
void
loadAlgorithms
()
override
;
81
82
private
slots:
83
void
onProviderAdded(
const
QString &providerId );
84
85
private
:
86
QPointer< QgsProject > mProject;
87
QMap< QString, QVariant > mModelDefinitions;
88
bool
mIsLoading =
false
;
89
};
90
91
#endif
// QGSPROCESSINGPROJECTMODELPROVIDER_H
QgsProcessingProjectModelProvider::writeProject
void writeProject(QDomDocument &document)
Writes project model definitions into a project DOM document document.
Definition
qgsprocessingprojectmodelprovider.cpp:136
QgsProcessingProjectModelProvider::readProject
void readProject(const QDomDocument &document)
Reads project model definitions from a project DOM document document.
Definition
qgsprocessingprojectmodelprovider.cpp:113
QgsProcessingProjectModelProvider::removeModel
void removeModel(const QgsProcessingModelAlgorithm *model)
Removes a model from the provider.
Definition
qgsprocessingprojectmodelprovider.cpp:101
QgsProcessingProjectModelProvider::addModel
void addModel(const QgsProcessingModelAlgorithm &model)
Adds a model to the provider.
Definition
qgsprocessingprojectmodelprovider.cpp:93
QgsProcessingProjectModelProvider::clear
void clear()
Clears all models from the provider.
Definition
qgsprocessingprojectmodelprovider.cpp:87
QgsProcessingProjectModelProvider::QgsProcessingProjectModelProvider
QgsProcessingProjectModelProvider(QgsProject *project, QObject *parent=nullptr)
Constructor for QgsProcessingProjectModelProvider, storing models in the specified project.
Definition
qgsprocessingprojectmodelprovider.cpp:34
QgsProcessingProvider::icon
virtual QIcon icon() const
Returns an icon for the provider.
Definition
qgsprocessingprovider.cpp:42
QgsProcessingProvider::name
virtual QString name() const =0
Returns the provider name, which is used to describe the provider within the GUI.
QgsProcessingProvider::QgsProcessingProvider
QgsProcessingProvider(QObject *parent=nullptr)
Constructor for QgsProcessingProvider.
Definition
qgsprocessingprovider.cpp:32
QgsProcessingProvider::svgIconPath
virtual QString svgIconPath() const
Returns a path to an SVG version of the provider's icon.
Definition
qgsprocessingprovider.cpp:47
QgsProcessingProvider::id
virtual QString id() const =0
Returns the unique provider id, used for identifying the provider.
QgsProcessingProvider::load
virtual bool load()
Loads the provider.
Definition
qgsprocessingprovider.h:355
QgsProcessingProvider::loadAlgorithms
virtual void loadAlgorithms()=0
Loads all algorithms belonging to this provider.
QgsProcessingProvider::longName
virtual QString longName() const
Returns the longer version of the provider name, which can include extra details such as version numb...
Definition
qgsprocessingprovider.cpp:62
QgsProcessingProvider::supportsNonFileBasedOutput
virtual bool supportsNonFileBasedOutput() const
Returns true if the provider supports non-file based outputs (such as memory layers or direct databas...
Definition
qgsprocessingprovider.cpp:400
QgsProject
Encapsulates a QGIS project, including sets of map layers and their styles, layouts,...
Definition
qgsproject.h:114
SIP_TRANSFERTHIS
#define SIP_TRANSFERTHIS
Definition
qgis_sip.h:52
qgsprocessingprovider.h
Generated on
for QGIS API Documentation by
1.17.0