File: qgsprocessingguiutils.sip.in

package info (click to toggle)
qgis 3.40.10%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 1,183,672 kB
  • sloc: cpp: 1,595,771; python: 372,544; xml: 23,474; sh: 3,761; perl: 3,664; ansic: 2,257; sql: 2,137; yacc: 1,068; lex: 577; javascript: 540; lisp: 411; makefile: 161
file content (83 lines) | stat: -rw-r--r-- 2,714 bytes parent folder | download | duplicates (8)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/gui/processing/qgsprocessingguiutils.h                           *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.py again   *
 ************************************************************************/




class QgsProcessingGuiUtils
{
%Docstring(signature="appended")
Contains utility functions relating to Processing GUI components.

.. warning::

   This is not considered stable API, and is exposed to Python for internal use only.

.. versionadded:: 3.44
%End

%TypeHeaderCode
#include "qgsprocessingguiutils.h"
%End
  public:
    class ResultLayerDetails
{
%Docstring(signature="appended")
Contains details of a layer result from running an algorithm.

.. versionadded:: 3.44
%End

%TypeHeaderCode
#include "qgsprocessingguiutils.h"
%End
      public:
        ResultLayerDetails( QgsMapLayer *layer /Transfer/ );
%Docstring
Constructor for ResultLayerDetails.

Takes ownership of ``layer``.
%End

        QgsMapLayer *layer;

        QgsLayerTreeGroup *targetLayerTreeGroup;

        int sortKey;

        QgsProject *destinationProject;
    };

    static void configureResultLayerTreeLayer( QgsLayerTreeLayer *layerTreeLayer );
%Docstring
Applies post-processing steps to the :py:class:`QgsLayerTreeLayer`
created for an algorithm's output.
%End

    static QgsLayerTreeGroup *layerTreeResultsGroup( const QgsProcessingContext::LayerDetails &layerDetails, const QgsProcessingContext &context );
%Docstring
Returns the destination layer tree group to store results in, or
``None`` if there is no specific destination tree group associated with
the layer.
%End

    static void addResultLayers( const QVector< QgsProcessingGuiUtils::ResultLayerDetails > &layers, const QgsProcessingContext &context, QgsLayerTreeView *view = 0 );
%Docstring
Responsible for adding layers created by an algorithm to a project and
the project's layer tree in the correct location.
%End
};


/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/gui/processing/qgsprocessingguiutils.h                           *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.py again   *
 ************************************************************************/