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
|
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/providers/qgsprovidersublayertask.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsProviderSublayerTask : QgsTask
{
%Docstring(signature="appended")
A :py:class:`QgsTask` which retrieves sublayer details for a URI.
This task executes a call to
:py:func:`QgsProviderRegistry.querySublayers()` in a background thread.
Depending on the URI queried it can be expensive to calculate the
sublayers (e.g. in the case where a full table scan is required to
resolve mixed geometry type layers), so it is beneficial to perform
these queries in the background wherever possible.
While :py:func:`QgsProviderRegistry.querySublayers()` offers various
flags to control how in-depth the querying will be, these flags are not
exposed through :py:class:`QgsProviderSublayerTask`. Rather
:py:class:`QgsProviderSublayerTask` will always execute the most
thorough query possible, regardless of how expensive this may be.
.. versionadded:: 3.22
%End
%TypeHeaderCode
#include "qgsprovidersublayertask.h"
%End
public:
QgsProviderSublayerTask( const QString &uri, bool includeSystemTables = false );
%Docstring
Constructor for QgsProviderSublayerTask, which retrieves sublayer
details for the specified ``uri``.
%End
QgsProviderSublayerTask( const QString &uri, const QString &providerKey, bool includeSystemTables = false );
%Docstring
Constructor for QgsProviderSublayerTask, which retrieves sublayer
details for the specified ``uri``, restricted to a particular provider.
.. versionadded:: 3.30
%End
~QgsProviderSublayerTask();
QList<QgsProviderSublayerDetails> results() const;
%Docstring
Returns the sublayer details as calculated by the task.
%End
virtual void cancel();
protected:
virtual bool run();
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/providers/qgsprovidersublayertask.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
|
