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
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
|
/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/processing/qgsprocessingparameterdefinitionwidget.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsProcessingAbstractParameterDefinitionWidget : QWidget, QgsExpressionContextGenerator
{
%Docstring(signature="appended")
Abstract base class for widgets which allow users to specify the
properties of a Processing parameter.
.. versionadded:: 3.10
%End
%TypeHeaderCode
#include "qgsprocessingparameterdefinitionwidget.h"
%End
public:
QgsProcessingAbstractParameterDefinitionWidget( QgsProcessingContext &context, const QgsProcessingParameterWidgetContext &widgetContext, const QgsProcessingParameterDefinition *definition = 0, const QgsProcessingAlgorithm *algorithm = 0, QWidget *parent /TransferThis/ = 0 );
%Docstring
Creates a new QgsProcessingAbstractParameterDefinitionWidget, with the
specified ``parent`` widget.
The ``context`` argument must specify a Processing context, which will
be used by the widget to evaluate existing ``definition`` properties
such as default values. Similarly, the ``widgetContext`` argument
specifies the wider GUI context in which the widget will be used.
The optional ``definition`` argument may be used to provide a parameter
definition to use to initially populate the widget's state.
Additionally, the optional ``algorithm`` parameter may be used to
specify the algorithm or model associated with the parameter.
%End
virtual QgsProcessingParameterDefinition *createParameter( const QString &name, const QString &description, Qgis::ProcessingParameterFlags flags ) const = 0 /Factory/;
%Docstring
Returns a new instance of a parameter definition, using the current
settings defined in the dialog.
Common properties for parameters, including the ``name``,
``description``, and parameter ``flags`` are passed to the method.
Subclass implementations must use these properties when crafting a
parameter definition which also respects the additional properties
specific to the parameter type handled by the widget subclass.
%End
virtual void setWidgetContext( const QgsProcessingParameterWidgetContext &context );
%Docstring
Sets the ``context`` in which the Processing definition 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.18
%End
const QgsProcessingParameterWidgetContext &widgetContext() const;
%Docstring
Returns the context in which the Processing definition 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.18
%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.18
%End
virtual QgsExpressionContext createExpressionContext() const;
};
class QgsProcessingParameterDefinitionWidget : QWidget
{
%Docstring(signature="appended")
A widget which allow users to specify the properties of a Processing
parameter.
.. versionadded:: 3.10
%End
%TypeHeaderCode
#include "qgsprocessingparameterdefinitionwidget.h"
%End
public:
QgsProcessingParameterDefinitionWidget( const QString &type, QgsProcessingContext &context, const QgsProcessingParameterWidgetContext &widgetContext, const QgsProcessingParameterDefinition *definition = 0, const QgsProcessingAlgorithm *algorithm = 0, QWidget *parent /TransferThis/ = 0 );
%Docstring
Constructor for QgsProcessingParameterDefinitionWidget, for a parameter
of the specified ``type``.
The ``context`` argument must specify a Processing context, which will
be used by the widget to evaluate existing ``definition`` properties
such as default values. Similarly, the ``widgetContext`` argument
specifies the wider GUI context in which the widget will be used.
The optional ``definition`` argument may be used to provide a parameter
definition to use to initially populate the widget's state.
Additionally, the optional ``algorithm`` parameter may be used to
specify the algorithm or model associated with the parameter.
%End
QgsProcessingParameterDefinition *createParameter( const QString &name = QString() ) const /Factory/;
%Docstring
Returns a new instance of a parameter definition, using the current
settings defined in the dialog.
The ``name`` parameter specifies the name for the newly created
parameter.
%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.18
%End
};
class QgsProcessingParameterDefinitionDialog : QDialog
{
%Docstring(signature="appended")
A dialog which allow users to specify the properties of a Processing
parameter.
.. versionadded:: 3.10
%End
%TypeHeaderCode
#include "qgsprocessingparameterdefinitionwidget.h"
%End
public:
QgsProcessingParameterDefinitionDialog( const QString &type, QgsProcessingContext &context, const QgsProcessingParameterWidgetContext &widgetContext, const QgsProcessingParameterDefinition *definition = 0, const QgsProcessingAlgorithm *algorithm = 0, QWidget *parent /TransferThis/ = 0 );
%Docstring
Constructor for QgsProcessingParameterDefinitionDialog, for a parameter
of the specified ``type``.
The ``context`` argument must specify a Processing context, which will
be used by the widget to evaluate existing ``definition`` properties
such as default values. Similarly, the ``widgetContext`` argument
specifies the wider GUI context in which the widget will be used.
The optional ``definition`` argument may be used to provide a parameter
definition to use to initially populate the dialog's state.
Additionally, the optional ``algorithm`` parameter may be used to
specify the algorithm or model associated with the parameter.
%End
QgsProcessingParameterDefinition *createParameter( const QString &name = QString() ) const /Factory/;
%Docstring
Returns a new instance of a parameter definition, using the current
settings defined in the dialog.
The ``name`` parameter specifies the name for the newly created
parameter.
%End
void setComments( const QString &comments );
%Docstring
Sets the comments for the parameter.
.. seealso:: :py:func:`comments`
.. versionadded:: 3.14
%End
QString comments() const;
%Docstring
Returns the comments for the parameter.
.. seealso:: :py:func:`setComments`
.. versionadded:: 3.14
%End
void setCommentColor( const QColor &color );
%Docstring
Sets the color for the comments for the parameter.
.. seealso:: :py:func:`commentColor`
.. versionadded:: 3.14
%End
QColor commentColor() const;
%Docstring
Returns the color for the comments for the parameter.
.. seealso:: :py:func:`setCommentColor`
.. versionadded:: 3.14
%End
void switchToCommentTab();
%Docstring
Switches the dialog to the comments tab.
%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.18
%End
public slots:
virtual void accept();
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/processing/qgsprocessingparameterdefinitionwidget.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
|
