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
|
/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/qgsfeaturelistcombobox.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
class QgsFeatureListComboBox : QComboBox
{
%Docstring(signature="appended")
This offers a combobox with autocompleter that allows selecting features from a layer.
It will show up to 100 entries at a time. The entries can be chosen based on the displayExpression
and whenever text is typed into the combobox, the completer and popup will adjust to features matching the typed text.
.. versionadded:: 3.0
%End
%TypeHeaderCode
#include "qgsfeaturelistcombobox.h"
%End
public:
QgsFeatureListComboBox( QWidget *parent = 0 );
%Docstring
Create a new QgsFeatureListComboBox, optionally specifying a ``parent``.
%End
QgsVectorLayer *sourceLayer() const;
%Docstring
The layer from which features should be listed.
%End
void setSourceLayer( QgsVectorLayer *sourceLayer );
%Docstring
The layer from which features should be listed.
%End
void setCurrentFeature( const QgsFeature &feature );
%Docstring
Sets the current index by using the given feature
.. versionadded:: 3.10
%End
QString displayExpression() const;
%Docstring
The display expression will be used to display features as well as
the value to match the typed text against.
%End
void setDisplayExpression( const QString &displayExpression );
%Docstring
The display expression will be used to display features as well as
the value to match the typed text against.
%End
QString filterExpression() const;
%Docstring
An additional expression to further restrict the available features.
This can be used to integrate additional spatial or other constraints.
%End
int nullIndex() const;
%Docstring
Returns the current index of the NULL value, or -1 if NULL values are
not allowed.
.. versionadded:: 3.2
%End
void setFilterExpression( const QString &filterExpression );
%Docstring
An additional expression to further restrict the available features.
This can be used to integrate additional spatial or other constraints.
%End
QVariant identifierValue() const /Deprecated/;
%Docstring
The identifier value of the currently selected feature. A value from the
identifierField.
.. deprecated:: QGIS 3.10
%End
QVariantList identifierValues() const;
%Docstring
The identifier values of the currently selected feature. A value from the
identifierField.
.. versionadded:: 3.10
%End
void setIdentifierValue( const QVariant &identifierValue ) /Deprecated/;
%Docstring
The identifier value of the currently selected feature. A value from the
identifierField.
.. deprecated:: QGIS 3.10
use setIdentifierValues
%End
void setIdentifierValues( const QVariantList &identifierValues );
%Docstring
The identifier values of the currently selected feature. A value from the
identifierFields.
.. versionadded:: 3.10
%End
void setIdentifierValuesToNull();
%Docstring
Sets the identifier values of the currently selected feature to NULL value(s).
.. versionadded:: 3.10
%End
QgsFeatureRequest currentFeatureRequest() const;
%Docstring
Shorthand for getting a feature request to query the currently selected
feature.
%End
bool allowNull() const;
%Docstring
Determines if a NULL value should be available in the list.
%End
void setAllowNull( bool allowNull );
%Docstring
Determines if a NULL value should be available in the list.
%End
QString identifierField() const /Deprecated/;
%Docstring
Field name that will be used to uniquely identify the current feature.
Normally the primary key of the layer.
.. deprecated:: QGIS 3.10
%End
QStringList identifierFields() const;
%Docstring
Field name that will be used to uniquely identify the current feature.
Normally the primary key of the layer.
.. versionadded:: 3.10
%End
void setIdentifierField( const QString &identifierField ) /Deprecated/;
%Docstring
Field name that will be used to uniquely identify the current feature.
Normally the primary key of the layer.
.. deprecated:: QGIS 3.10
%End
void setIdentifierFields( const QStringList &identifierFields );
%Docstring
Field name that will be used to uniquely identify the current feature.
Normally the primary key of the layer.
.. versionadded:: 3.10
%End
QModelIndex currentModelIndex() const;
%Docstring
The index of the currently selected item.
%End
virtual void focusOutEvent( QFocusEvent *event );
virtual void keyPressEvent( QKeyEvent *event );
signals:
void modelUpdated();
%Docstring
The underlying model has been updated.
.. versionadded:: 3.2
%End
void sourceLayerChanged();
%Docstring
The layer from which features should be listed.
%End
void displayExpressionChanged();
%Docstring
The display expression will be used to display features as well as
the the value to match the typed text against.
%End
void filterExpressionChanged();
%Docstring
An additional expression to further restrict the available features.
This can be used to integrate additional spatial or other constraints.
%End
void identifierValueChanged();
%Docstring
The identifier value of the currently selected feature. A value from the
identifierField.
%End
void identifierFieldChanged();
%Docstring
Field name that will be used to uniquely identify the current feature.
Normally the primary key of the layer.
%End
void allowNullChanged();
%Docstring
Determines if a NULL value should be available in the list.
%End
void currentFeatureChanged();
%Docstring
Emitted when the current feature changes
.. versionadded:: 3.16.5
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/qgsfeaturelistcombobox.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
|
