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
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
|
/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/processing/qgsprocessingalgorithmconfigurationwidget.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsProcessingAlgorithmConfigurationWidget : QWidget, QgsExpressionContextGenerator
{
%Docstring(signature="appended")
A configuration widget for processing algorithms allows providing
additional configuration options directly on algorithm level, in
addition to parameters.
.. versionadded:: 3.2
%End
%TypeHeaderCode
#include "qgsprocessingalgorithmconfigurationwidget.h"
%End
public:
QgsProcessingAlgorithmConfigurationWidget( QWidget *parent = 0 );
%Docstring
Creates a new QgsProcessingAlgorithmConfigurationWidget
%End
~QgsProcessingAlgorithmConfigurationWidget();
virtual QVariantMap configuration() const = 0;
%Docstring
Read the current configuration from this widget.
%End
virtual void setConfiguration( const QVariantMap &configuration ) = 0;
%Docstring
Set the configuration which this widget should represent.
%End
virtual void setWidgetContext( const QgsProcessingParameterWidgetContext &context );
%Docstring
Sets the ``context`` in which the Processing algorithm widget is shown,
e.g., the parent model algorithm, a linked map canvas, and other
relevant information which allows the widget to fine-tune its behavior.
Subclasses should take care to call the base class method when
reimplementing this method.
.. seealso:: :py:func:`widgetContext`
.. versionadded:: 3.6
%End
const QgsProcessingParameterWidgetContext &widgetContext() const;
%Docstring
Returns the context in which the Processing algorithm widget is shown,
e.g., the parent model algorithm, a linked map canvas, and other
relevant information which allows the widget to fine-tune its behavior.
.. seealso:: :py:func:`setWidgetContext`
.. versionadded:: 3.6
%End
void setAlgorithm( const QgsProcessingAlgorithm *algorithm );
%Docstring
Sets the algorithm instance associated with the widget.
.. seealso:: :py:func:`algorithm`
.. versionadded:: 3.6
%End
const QgsProcessingAlgorithm *algorithm() const;
%Docstring
Returns the algorithm instance associated with this widget.
.. seealso:: :py:func:`setAlgorithm`
.. versionadded:: 3.6
%End
void registerProcessingContextGenerator( QgsProcessingContextGenerator *generator );
%Docstring
Registers a Processing context ``generator`` class that will be used to
retrieve a Processing context for the widget when required.
.. versionadded:: 3.6
%End
virtual QgsExpressionContext createExpressionContext() const;
};
class QgsProcessingAlgorithmConfigurationWidgetFactory
{
%Docstring(signature="appended")
Interface base class for factories for algorithm configuration widgets.
.. versionadded:: 3.2
%End
%TypeHeaderCode
#include "qgsprocessingalgorithmconfigurationwidget.h"
%End
public:
virtual ~QgsProcessingAlgorithmConfigurationWidgetFactory();
virtual QgsProcessingAlgorithmConfigurationWidget *create( const QgsProcessingAlgorithm *algorithm ) const = 0 /Factory/;
%Docstring
Create a new configuration widget for ``algorithm``.
%End
virtual bool canCreateFor( const QgsProcessingAlgorithm *algorithm ) const = 0;
%Docstring
Check if this factory can create widgets for ``algorithm``.
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/processing/qgsprocessingalgorithmconfigurationwidget.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
|
