/
qgsattributeeditorcontext.sip.in
242 lines (167 loc) · 5.35 KB
/
qgsattributeeditorcontext.sip.in
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
/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/qgsattributeeditorcontext.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
class QgsAttributeEditorContext
{
%Docstring
This class contains context information for attribute editor widgets.
It will be passed to embedded widgets whenever this occurs (e.g. when
showing an embedded form due to relations)
%End
%TypeHeaderCode
#include "qgsattributeeditorcontext.h"
%End
public:
enum Mode
{
SingleEditMode,
AddFeatureMode,
MultiEditMode,
SearchMode,
AggregateSearchMode,
IdentifyMode
};
enum RelationMode
{
Undefined,
Multiple,
Single
};
enum FormMode
{
Embed,
StandaloneDialog,
Popup
};
QgsAttributeEditorContext();
%Docstring
Constructor for QgsAttributeEditorContext
%End
QgsAttributeEditorContext( const QgsAttributeEditorContext &parentContext, FormMode formMode );
QgsAttributeEditorContext( const QgsAttributeEditorContext &parentContext, const QgsRelation &relation, RelationMode relationMode, FormMode widgetMode );
void setDistanceArea( const QgsDistanceArea &distanceArea );
%Docstring
Sets distance area object, ``distanceArea``, for area/length calculations
.. seealso:: :py:func:`distanceArea`
.. versionadded:: 2.2
%End
const QgsDistanceArea &distanceArea() const;
%Docstring
Returns the distance area object used for area/length calculations.
.. seealso:: :py:func:`setDistanceArea`
.. versionadded:: 2.2
%End
void setMapCanvas( QgsMapCanvas *mapCanvas );
%Docstring
Sets the associated map canvas, ``mapCanvas``, (e.g. to zoom to related features).
.. seealso:: :py:func:`mapCanvas`
.. versionadded:: 3.2
%End
QgsMapCanvas *mapCanvas() const;
%Docstring
Returns the associated map canvas (e.g. to zoom to related features).
.. seealso:: :py:func:`setMapCanvas`
.. versionadded:: 3.2
%End
void setVectorLayerTools( QgsVectorLayerTools *vlTools );
%Docstring
Sets the associated vector layer tools.
:param vlTools: vector layer tools
.. seealso:: :py:func:`vectorLayerTools`
.. versionadded:: 2.2
%End
const QgsVectorLayerTools *vectorLayerTools() const;
%Docstring
Returns the associated vector layer tools.
.. seealso:: :py:func:`setVectorLayerTools`
.. versionadded:: 2.2
%End
void setRelation( const QgsRelation &relation, RelationMode mode );
%Docstring
Set attribute relation and mode
:param relation: relation
:param mode: relation mode
.. seealso:: :py:func:`relation`
.. seealso:: :py:func:`relationMode`
.. versionadded:: 2.6
%End
const QgsRelation &relation() const;
%Docstring
Returns the attribute relation.
.. seealso:: :py:func:`setRelation`
.. seealso:: :py:func:`relationMode`
.. versionadded:: 2.6
%End
RelationMode relationMode() const;
%Docstring
Returns the attribute relation mode.
.. seealso:: :py:func:`setRelation`
.. seealso:: :py:func:`relation`
.. versionadded:: 2.6
%End
FormMode formMode() const;
%Docstring
Returns the form mode.
.. seealso:: :py:func:`setFormMode`
%End
void setFormMode( FormMode mode );
%Docstring
Sets the form mode.
:param mode: form mode
.. seealso:: :py:func:`formMode`
.. versionadded:: 2.16
%End
bool allowCustomUi() const;
%Docstring
Returns true if the attribute editor should permit use of custom UI forms.
.. seealso:: :py:func:`setAllowCustomUi`
.. versionadded:: 2.16
%End
void setAllowCustomUi( bool allow );
%Docstring
Sets whether the attribute editor should permit use of custom UI forms.
:param allow: set to true to allow custom UI forms, or false to disable them and use default generated
QGIS forms
.. seealso:: :py:func:`allowCustomUi`
.. versionadded:: 2.16
%End
const QgsAttributeEditorContext *parentContext() const;
QgsFeature formFeature() const;
%Docstring
Returns current feature from the currently edited form or table row
.. seealso:: :py:func:`setFormFeature`
.. versionadded:: 3.2
%End
void setFormFeature( const QgsFeature &feature );
%Docstring
Set current ``feature`` for the currently edited form or table row
.. seealso:: :py:func:`formFeature`
.. versionadded:: 3.2
%End
Mode attributeFormMode() const;
%Docstring
Returns current attributeFormMode
.. versionadded:: 3.4
%End
void setAttributeFormMode( const Mode attributeFormMode );
%Docstring
Set ``attributeFormMode`` for the edited form
.. versionadded:: 3.4
%End
QString attributeFormModeString() const;
%Docstring
Returns the context as string
.. versionadded:: 3.4
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/qgsattributeeditorcontext.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/