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
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
|
/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/editorwidgets/qgsrelationwidgetwrapper.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsRelationWidgetWrapper : QgsWidgetWrapper
{
%TypeHeaderCode
#include "qgsrelationwidgetwrapper.h"
%End
public:
QgsRelationWidgetWrapper(
QgsVectorLayer *vl,
const QgsRelation &relation,
QWidget *editor /Constrained/ = 0,
QWidget *parent /TransferThis,Constrained/ = 0
);
%Docstring
Constructor for QgsRelationWidgetWrapper
%End
QgsRelationWidgetWrapper(
const QString &relationEditorName,
QgsVectorLayer *vl,
const QgsRelation &relation,
QWidget *editor = 0,
QWidget *parent /TransferThis/ = 0
);
%Docstring
Constructor for QgsRelationWidgetWrapper
%End
bool showLabel() const /Deprecated/;
%Docstring
Defines if a title label should be shown for this widget. Only has an
effect after :py:func:`~QgsRelationWidgetWrapper.widget` has been called
at least once.
.. deprecated:: 3.20
Label is handled directly in :py:class:`QgsAttributeForm`.
%End
void setShowLabel( bool showLabel ) /Deprecated/;
%Docstring
Defines if a title label should be shown for this widget. Only has an
effect after :py:func:`~QgsRelationWidgetWrapper.widget` has been called
at least once.
.. deprecated:: 3.20
Label is handled directly in :py:class:`QgsAttributeForm`.
%End
bool showLinkButton() const /Deprecated/;
%Docstring
Determines if the "link feature" button should be shown
.. deprecated:: 3.16
Use :py:func:`~QgsRelationWidgetWrapper.visibleButtons` instead.
%End
void setShowLinkButton( bool showLinkButton ) /Deprecated/;
%Docstring
Determines if the "link feature" button should be shown
.. deprecated:: 3.16
Use :py:func:`~QgsRelationWidgetWrapper.setVisibleButtons` instead.
%End
bool showUnlinkButton() const /Deprecated/;
%Docstring
Determines if the "unlink feature" button should be shown
.. deprecated:: 3.16
Use :py:func:`~QgsRelationWidgetWrapper.visibleButtons` instead.
%End
void setShowUnlinkButton( bool showUnlinkButton ) /Deprecated/;
%Docstring
Determines if the "unlink feature" button should be shown
.. deprecated:: 3.16
Use :py:func:`~QgsRelationWidgetWrapper.setVisibleButtons` instead.
%End
void setShowSaveChildEditsButton( bool showChildEdits ) /Deprecated/;
%Docstring
Determines if the "Save child layer edits" button should be shown
.. versionadded:: 3.14
.. deprecated:: 3.16
Use :py:func:`~QgsRelationWidgetWrapper.setVisibleButtons` instead.
%End
bool showSaveChildEditsButton() const /Deprecated/;
%Docstring
Determines if the "Save child layer edits" button should be shown
.. versionadded:: 3.14
.. deprecated:: 3.16
Use :py:func:`~QgsRelationWidgetWrapper.visibleButtons` instead.
%End
void setVisibleButtons( const QgsAttributeEditorRelation::Buttons &buttons ) /Deprecated/;
%Docstring
Defines the buttons which are shown
.. versionadded:: 3.16
.. deprecated:: 3.18
Use :py:func:`~QgsRelationWidgetWrapper.setWidgetConfig` instead.
%End
QgsAttributeEditorRelation::Buttons visibleButtons() const /Deprecated/;
%Docstring
Returns the buttons which are shown
.. versionadded:: 3.16
.. deprecated:: 3.18
Use :py:func:`~QgsRelationWidgetWrapper.widgetConfig` instead.
%End
void setWidgetConfig( const QVariantMap &config );
%Docstring
Will set the config of this widget wrapper to the specified config.
:param config: The config for this wrapper
.. versionadded:: 3.18
%End
QVariantMap widgetConfig() const;
%Docstring
Returns the whole widget config
.. versionadded:: 3.18
%End
bool forceSuppressFormPopup() const;
%Docstring
Determines the force suppress form popup status that is configured for
this widget
.. versionadded:: 3.16
%End
void setForceSuppressFormPopup( bool forceSuppressFormPopup );
%Docstring
Sets force suppress form popup status to ``forceSuppressFormPopup`` for
this widget and for the vectorLayerTools (if ``True``). This flag will
override the layer and general settings regarding the automatic opening
of the attribute form dialog when digitizing is completed.
.. versionadded:: 3.16
%End
QVariant nmRelationId() const;
%Docstring
Determines the relation id of the second relation involved in an N:M
relation.
.. versionadded:: 3.16
%End
void setNmRelationId( const QVariant &nmRelationId = QVariant() );
%Docstring
Sets ``nmRelationId`` for the relation id of the second relation
involved in an N:M relation. If it's empty, then it's considered as a
1:M relationship.
.. versionadded:: 3.16
%End
QString label() const /Deprecated/;
%Docstring
Determines the label of this element
.. versionadded:: 3.16
.. deprecated:: 3.20
Label is handled directly in :py:class:`QgsAttributeForm`.
%End
void setLabel( const QString &label = QString() ) /Deprecated/;
%Docstring
Sets ``label`` for this element If it's empty it takes the relation id
as label
.. versionadded:: 3.16
.. deprecated:: 3.20
Label is handled directly in :py:class:`QgsAttributeForm`.
%End
QgsRelation relation() const;
%Docstring
The relation for which this wrapper is created.
%End
void widgetValueChanged( const QString &attribute, const QVariant &newValue, bool attributeChanged );
%Docstring
Will be called when a value in the current edited form or table row
changes
Forward the signal to the embedded form
:param attribute: The name of the attribute that changed.
:param newValue: The new value of the attribute.
:param attributeChanged: If ``True``, it corresponds to an actual change
of the feature attribute
.. versionadded:: 3.14
%End
protected:
virtual QWidget *createWidget( QWidget *parent );
virtual void initWidget( QWidget *editor );
virtual bool valid() const;
signals:
void relatedFeaturesChanged();
%Docstring
Emit this signal, whenever the related features changed. This happens
for example when related features are added, removed, linked or
unlinked.
.. versionadded:: 3.22
%End
public slots:
virtual void setFeature( const QgsFeature &feature );
void setMultiEditFeatureIds( const QgsFeatureIds &fids );
%Docstring
Set multiple feature to edit simultaneously.
:param fids: Multiple Id of features to edit
.. versionadded:: 3.24
%End
void setVisible( bool visible );
%Docstring
Sets the visibility of the wrapper's widget.
:param visible: set to ``True`` to show widget, ``False`` to hide widget
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/editorwidgets/qgsrelationwidgetwrapper.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
|
