-
-
Notifications
You must be signed in to change notification settings - Fork 3k
/
qgsdataprovider.sip
427 lines (319 loc) · 11.5 KB
/
qgsdataprovider.sip
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
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/qgsdataprovider.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
class QgsDataProvider : QObject
{
%Docstring
Abstract base class for spatial data provider implementations.
This object needs to inherit from QObject to enable event
processing in the Postgres/PostGIS provider (QgsPostgresProvider).
It is called *here* so that this vtable and the vtable for
QgsPostgresProvider don't get misaligned -
the QgsVectorLayer class factory (which refers
to generic QgsVectorDataProvider's) depends on it.
%End
%TypeHeaderCode
#include "qgsdataprovider.h"
%End
%ConvertToSubClassCode
if ( qobject_cast<QgsVectorDataProvider *>( sipCpp ) )
{
sipType = sipType_QgsVectorDataProvider;
}
else if ( qobject_cast<QgsRasterDataProvider *>( sipCpp ) )
{
sipType = sipType_QgsRasterDataProvider;
}
else
{
sipType = 0;
}
%End
public:
enum DataCapability
{
NoDataCapabilities,
File,
Dir,
Database,
Net
};
enum ProviderProperty
{
EvaluateDefaultValues,
CustomData
};
QgsDataProvider( const QString &uri = QString() );
%Docstring
Create a new dataprovider with the specified in the ``uri``.
%End
virtual QgsCoordinateReferenceSystem crs() const = 0;
%Docstring
Returns the coordinate system for the data source.
If the provider isn't capable of returning its projection then an invalid
QgsCoordinateReferenceSystem will be returned.
:rtype: QgsCoordinateReferenceSystem
%End
virtual void setDataSourceUri( const QString &uri );
%Docstring
Set the data source specification. This may be a path or database
connection string
\param uri source specification
%End
virtual QString dataSourceUri( bool expandAuthConfig = false ) const;
%Docstring
Get the data source specification. This may be a path or database
connection string
\param expandAuthConfig Whether to expand any assigned authentication configuration
:return: data source specification
.. note::
The default authentication configuration expansion is FALSE. This keeps credentials
out of layer data source URIs and project files. Expansion should be specifically done
only when needed within a provider
:rtype: str
%End
void setUri( const QgsDataSourceUri &uri );
%Docstring
Set the data source specification.
.. versionadded:: 3.0
%End
QgsDataSourceUri uri() const;
%Docstring
Get the data source specification.
.. versionadded:: 3.0
:rtype: QgsDataSourceUri
%End
virtual QgsRectangle extent() const = 0;
%Docstring
Returns the extent of the layer
:return: QgsRectangle containing the extent of the layer
:rtype: QgsRectangle
%End
virtual bool isValid() const = 0;
%Docstring
Returns true if this is a valid layer. It is up to individual providers
to determine what constitutes a valid layer.
:rtype: bool
%End
virtual void updateExtents();
%Docstring
Update the extents of the layer. Not implemented by default.
%End
virtual bool setSubsetString( const QString &subset, bool updateFeatureCount = true );
%Docstring
Set the subset string used to create a subset of features in
the layer. This may be a sql where clause or any other string
that can be used by the data provider to create a subset.
Must be implemented in the dataprovider.
:rtype: bool
%End
virtual bool supportsSubsetString() const;
%Docstring
Returns true if the provider supports setting of subset strings.
:rtype: bool
%End
virtual QString subsetString() const;
%Docstring
Returns the subset definition string (typically sql) currently in
use by the layer and used by the provider to limit the feature set.
Must be overridden in the dataprovider, otherwise returns a null
QString.
:rtype: str
%End
virtual QStringList subLayers() const;
%Docstring
Sub-layers handled by this provider, in order from bottom to top
Sub-layers are used when the provider's source can combine layers
it knows about in some way before it hands them off to the provider.
:rtype: list of str
%End
virtual QStringList subLayerStyles() const;
%Docstring
Sub-layer styles for each sub-layer handled by this provider,
in order from bottom to top
Sub-layer styles are used to abstract the way the provider's source can symbolise
layers in some way at the server, before it serves them to the provider.
:rtype: list of str
%End
virtual uint subLayerCount() const;
%Docstring
return the number of layers for the current data source
:rtype: uint
%End
virtual void setLayerOrder( const QStringList &layers );
%Docstring
Reorder the list of layer names to be rendered by this provider
(in order from bottom to top)
.. note::
layers must have been previously added.
%End
virtual void setSubLayerVisibility( const QString &name, bool vis );
%Docstring
Set the visibility of the given sublayer name
%End
virtual QString name() const = 0;
%Docstring
Return a provider name
Essentially just returns the provider key. Should be used to build file
dialogs so that providers can be shown with their supported types. Thus
if more than one provider supports a given format, the user is able to
select a specific provider to open that file.
\note
Instead of being pure virtual, might be better to generalize this
behavior and presume that none of the sub-classes are going to do
anything strange with regards to their name or description?
:rtype: str
%End
virtual QString description() const = 0;
%Docstring
Return description
Return a terse string describing what the provider is.
\note
Instead of being pure virtual, might be better to generalize this
behavior and presume that none of the sub-classes are going to do
anything strange with regards to their name or description?
:rtype: str
%End
virtual QString fileVectorFilters() const;
%Docstring
Return vector file filter string
Returns a string suitable for a QFileDialog of vector file formats
supported by the data provider. Naturally this will be an empty string
for those data providers that do not deal with plain files, such as
databases and servers.
.. note::
It'd be nice to eventually be raster/vector neutral.
:rtype: str
%End
virtual QString fileRasterFilters() const;
%Docstring
Return raster file filter string
Returns a string suitable for a QFileDialog of raster file formats
supported by the data provider. Naturally this will be an empty string
for those data providers that do not deal with plain files, such as
databases and servers.
.. note::
It'd be nice to eventually be raster/vector neutral.
:rtype: str
%End
virtual void reloadData();
%Docstring
Reloads the data from the source. Needs to be implemented by providers with data caches to
synchronize with changes in the data source
%End
virtual QDateTime timestamp() const;
%Docstring
Time stamp of data source in the moment when data/metadata were loaded by provider
:rtype: QDateTime
%End
virtual QDateTime dataTimestamp() const;
%Docstring
Current time stamp of data source
:rtype: QDateTime
%End
virtual QgsError error() const;
%Docstring
Get current status error. This error describes some principal problem
for which provider cannot work and thus is not valid. It is not last error
after accessing data by block(), identify() etc.
:rtype: QgsError
%End
virtual void invalidateConnections( const QString &connection );
%Docstring
Invalidate connections corresponding to specified name
.. versionadded:: 2.16
%End
virtual bool enterUpdateMode();
%Docstring
Enter update mode.
This is aimed at providers that can open differently the connection to
the datasource, according it to be in update mode or in read-only mode.
A call to this method shall be balanced with a call to leaveUpdateMode(),
if this method returns true.
Most providers will have an empty implementation for that method.
For backward compatibility, providers that implement enterUpdateMode() should
still make sure to allow editing operations to work even if enterUpdateMode()
is not explicitly called.
Several successive calls to enterUpdateMode() can be done. So there is
a concept of stack of calls that must be handled by the provider. Only the first
call to enterUpdateMode() will really turn update mode on.
:return: true in case of success (or no-op implementation), false in case of failure.
.. versionadded:: 2.16
:rtype: bool
%End
virtual bool leaveUpdateMode();
%Docstring
Leave update mode.
This is aimed at providers that can open differently the connection to
the datasource, according it to be in update mode or in read-only mode.
This method shall be balanced with a successful call to enterUpdateMode().
Most providers will have an empty implementation for that method.
Several successive calls to enterUpdateMode() can be done. So there is
a concept of stack of calls that must be handled by the provider. Only the last
call to leaveUpdateMode() will really turn update mode off.
:return: true in case of success (or no-op implementation), false in case of failure.
.. versionadded:: 2.16
:rtype: bool
%End
void setProviderProperty( ProviderProperty property, const QVariant &value );
%Docstring
Allows setting arbitrary properties on the provider.
It depends on the provider which properties are supported.
.. versionadded:: 2.16
%End
QVariant providerProperty( ProviderProperty property, const QVariant &defaultValue = QVariant() ) const;
%Docstring
Get the current value of a certain provider property.
It depends on the provider which properties are supported.
.. versionadded:: 2.16
:rtype: QVariant
%End
virtual void setListening( bool isListening );
%Docstring
Set whether the provider will listen to datasource notifications
If set, the provider will issue notify signals.
The default implementation does nothing.
.. seealso:: notify
.. versionadded:: 3.0
%End
signals:
void fullExtentCalculated();
%Docstring
This is emitted whenever the worker thread has fully calculated the
PostGIS extents for this layer, and its event has been received by this
provider.
%End
void dataChanged();
%Docstring
This is emitted whenever an asynchronous operation has finished
and the data should be redrawn
When emitted from a QgsVectorDataProvider, any cached information such as
feature ids should be invalidated.
%End
void notify( const QString &msg ) const;
%Docstring
Emitted when datasource issues a notification
.. seealso:: setListening
.. versionadded:: 3.0
%End
protected:
void appendError( const QgsErrorMessage &message );
%Docstring
Add error message
%End
void setError( const QgsError &error );
%Docstring
Set error message
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/qgsdataprovider.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/