QGIS API Documentation
3.43.0-Master (a93bf8b6462)
Toggle main menu visibility
Main Page
Related Pages
Topics
Namespaces
Namespace List
Namespace Members
All
a
b
c
d
f
g
h
i
l
m
n
o
p
q
r
s
t
w
Functions
a
b
c
d
f
g
h
i
l
m
n
o
p
r
s
t
w
Variables
Typedefs
Enumerations
Enumerator
Classes
Class List
Class Index
Class Hierarchy
Class Members
All
2
3
_
a
b
c
d
e
f
g
h
i
j
k
l
m
n
o
p
q
r
s
t
u
v
w
x
y
z
~
Functions
2
3
_
a
b
c
d
e
f
g
h
i
j
k
l
m
n
o
p
q
r
s
t
u
v
w
x
y
z
~
Variables
a
b
c
d
e
f
g
h
i
j
k
l
m
n
o
p
q
r
s
t
u
v
w
x
y
z
Typedefs
a
b
c
d
e
f
g
h
i
k
l
m
o
p
r
s
t
u
v
w
z
Enumerations
a
b
c
d
e
f
g
h
i
j
k
l
m
n
o
p
q
r
s
t
u
v
w
z
Enumerator
a
b
c
d
e
f
g
h
i
j
k
l
m
n
o
p
q
r
s
t
u
v
w
x
y
z
Properties
a
b
c
d
e
f
g
h
i
l
m
n
o
p
r
s
t
u
v
w
x
y
z
Related Symbols
3
a
b
c
d
e
f
g
h
i
l
m
n
o
p
q
r
s
t
u
v
Files
File List
File Members
All
3
_
a
b
c
d
e
f
g
h
i
j
k
l
m
n
o
p
q
r
s
t
u
v
w
y
z
Functions
_
a
b
c
d
e
f
g
h
i
j
l
m
n
o
p
q
r
s
t
u
v
w
z
Variables
a
b
c
e
f
g
h
i
l
n
o
p
q
r
s
t
w
Typedefs
3
a
c
d
e
f
g
h
i
l
m
n
o
p
q
r
s
t
u
v
w
Enumerations
Enumerator
Macros
a
b
c
d
e
f
g
h
i
k
l
m
n
o
p
q
r
s
t
w
y
Loading...
Searching...
No Matches
src
gui
processing
qgsprocessingguiutils.h
Go to the documentation of this file.
1
/***************************************************************************
2
qgsprocessingguiutils.h
3
------------------------
4
Date : June 2025
5
Copyright : (C) 2025 Nyall Dawson
6
Email : nyall dot dawson at gmail dot com
7
***************************************************************************
8
* *
9
* This program is free software; you can redistribute it and/or modify *
10
* it under the terms of the GNU General Public License as published by *
11
* the Free Software Foundation; either version 2 of the License, or *
12
* (at your option) any later version. *
13
* *
14
***************************************************************************/
15
16
#ifndef QGSPROCESSINGGUIUTILS_H
17
#define QGSPROCESSINGGUIUTILS_H
18
19
#include "
qgis.h
"
20
#include "qgis_gui.h"
21
#include "
qgsprocessingcontext.h
"
22
23
class
QgsLayerTreeLayer
;
24
class
QgsLayerTreeView
;
25
36
class
GUI_EXPORT
QgsProcessingGuiUtils
37
{
38
public
:
44
class
GUI_EXPORT
ResultLayerDetails
45
{
46
public
:
52
ResultLayerDetails
(
QgsMapLayer
*layer
SIP_TRANSFER
)
53
: layer( layer )
54
{}
52
ResultLayerDetails
(
QgsMapLayer
*layer
SIP_TRANSFER
) {
…
}
55
59
QgsMapLayer
*layer =
nullptr
;
60
64
QgsLayerTreeGroup
*targetLayerTreeGroup =
nullptr
;
65
69
int
sortKey = 0;
70
74
QgsProject
*destinationProject =
nullptr
;
75
};
44
class
GUI_EXPORT
ResultLayerDetails
{
…
};
76
80
static
void
configureResultLayerTreeLayer(
QgsLayerTreeLayer
*layerTreeLayer );
81
86
static
QgsLayerTreeGroup
*layerTreeResultsGroup(
const
QgsProcessingContext::LayerDetails
&layerDetails,
const
QgsProcessingContext
&context );
87
91
static
void
addResultLayers(
const
QVector< QgsProcessingGuiUtils::ResultLayerDetails > &layers,
const
QgsProcessingContext
&context,
QgsLayerTreeView
*view =
nullptr
);
92
};
36
class
GUI_EXPORT
QgsProcessingGuiUtils
{
…
};
93
94
95
#endif
// QGSPROCESSINGGUIUTILS_H
QgsLayerTreeGroup
Layer tree group node serves as a container for layers and further groups.
Definition
qgslayertreegroup.h:40
QgsLayerTreeLayer
Layer tree node points to a map layer.
Definition
qgslayertreelayer.h:43
QgsLayerTreeView
Extends QTreeView and provides additional functionality when working with a layer tree.
Definition
qgslayertreeview.h:115
QgsMapLayer
Base class for all map layer types.
Definition
qgsmaplayer.h:77
QgsProcessingContext::LayerDetails
Details for layers to load into projects.
Definition
qgsprocessingcontext.h:248
QgsProcessingContext
Contains information about the context in which a processing algorithm is executed.
Definition
qgsprocessingcontext.h:45
QgsProcessingGuiUtils::ResultLayerDetails
Contains details of a layer result from running an algorithm.
Definition
qgsprocessingguiutils.h:45
QgsProcessingGuiUtils::ResultLayerDetails::ResultLayerDetails
ResultLayerDetails(QgsMapLayer *layer)
Constructor for ResultLayerDetails.
Definition
qgsprocessingguiutils.h:52
QgsProcessingGuiUtils
Contains utility functions relating to Processing GUI components.
Definition
qgsprocessingguiutils.h:37
QgsProject
Encapsulates a QGIS project, including sets of map layers and their styles, layouts,...
Definition
qgsproject.h:107
qgis.h
SIP_TRANSFER
#define SIP_TRANSFER
Definition
qgis_sip.h:36
qgsprocessingcontext.h
Generated on Wed Jun 18 2025 04:23:59 for QGIS API Documentation by
1.9.8