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
|
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/processing/models/qgsprocessingmodelcomponent.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsProcessingModelComponent
{
%Docstring(signature="appended")
Represents a component of a model algorithm.
%End
%TypeHeaderCode
#include "qgsprocessingmodelcomponent.h"
%End
public:
virtual ~QgsProcessingModelComponent();
QString description() const;
%Docstring
Returns the friendly description text for the component.
.. seealso:: :py:func:`setDescription`
%End
void setDescription( const QString &description );
%Docstring
Sets the friendly ``description`` text for the component.
.. seealso:: :py:func:`description`
%End
QPointF position() const;
%Docstring
Returns the position of the model component within the model designer.
.. seealso:: :py:func:`setPosition`
%End
void setPosition( QPointF position );
%Docstring
Sets the ``position`` of the model component within the model designer.
.. seealso:: :py:func:`position`
%End
QSizeF size() const;
%Docstring
Returns the size of the model component within the model designer.
.. seealso:: :py:func:`setSize`
.. versionadded:: 3.14
%End
void setSize( QSizeF size );
%Docstring
Sets the ``size`` of the model component within the model designer.
.. seealso:: :py:func:`size`
.. versionadded:: 3.14
%End
QColor color() const;
%Docstring
Returns the color of the model component within the model designer.
An invalid color indicates that the default color for the component
should be used.
.. seealso:: :py:func:`setColor`
.. versionadded:: 3.14
%End
void setColor( const QColor &color );
%Docstring
Sets the ``color`` of the model component within the model designer. An
invalid ``color`` indicates that the default color for the component
should be used.
.. seealso:: :py:func:`color`
.. versionadded:: 3.14
%End
bool linksCollapsed( Qt::Edge edge ) const;
%Docstring
Returns ``True`` if the link points for the specified ``edge`` should be
shown collapsed or not.
.. seealso:: :py:func:`setLinksCollapsed`
%End
void setLinksCollapsed( Qt::Edge edge, bool collapsed );
%Docstring
Sets whether the link points for the specified ``edge`` for this
component should be shown collapsed in the model designer.
.. seealso:: :py:func:`linksCollapsed`
%End
virtual QgsProcessingModelComment *comment();
%Docstring
Returns the comment attached to this component (may be ``None``)
.. seealso:: :py:func:`setComment`
%End
virtual void setComment( const QgsProcessingModelComment &comment );
%Docstring
Sets the ``comment`` attached to this component.
.. seealso:: :py:func:`comment`
%End
virtual QgsProcessingModelComponent *clone() const = 0 /Factory/;
%Docstring
Clones the component.
Ownership is transferred to the caller.
%End
protected:
QgsProcessingModelComponent( const QString &description = QString() );
%Docstring
Only subclasses can be created
%End
QgsProcessingModelComponent( const QgsProcessingModelComponent &other );
%Docstring
Copies are protected to avoid slicing
%End
void saveCommonProperties( QVariantMap &map ) const;
%Docstring
Saves the component properties to a QVariantMap.
.. seealso:: :py:func:`restoreCommonProperties`
%End
void restoreCommonProperties( const QVariantMap &map );
%Docstring
Restores the component properties from a QVariantMap.
.. seealso:: :py:func:`saveCommonProperties`
%End
void copyNonDefinitionProperties( const QgsProcessingModelComponent &other );
%Docstring
Copies all non-specific definition properties from the ``other``
component definition.
This includes properties like the size and position of the component,
but not properties like the specific algorithm or input details.
.. versionadded:: 3.14
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/processing/models/qgsprocessingmodelcomponent.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
|
