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
|
/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/qgssourceselectproviderregistry.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsSourceSelectProviderRegistry : QObject
{
%Docstring(signature="appended")
This class keeps a list of source select providers that may add items to
the :py:class:`QgsDataSourceManagerDialog` When created, it
automatically adds providers from data provider plugins (e.g. PostGIS,
WMS, ...)
:py:class:`QgsSourceSelectProviderRegistry` is not usually directly
created, but rather accessed through
:py:func:`QgsGui.sourceSelectProviderRegistry()`.
%End
%TypeHeaderCode
#include "qgssourceselectproviderregistry.h"
%End
public:
QgsSourceSelectProviderRegistry();
~QgsSourceSelectProviderRegistry();
QList<QgsSourceSelectProvider *> providers();
%Docstring
Gets list of available providers
%End
void addProvider( QgsSourceSelectProvider *provider /Transfer/ );
%Docstring
Add a ``provider`` implementation. Takes ownership of the object.
%End
bool removeProvider( QgsSourceSelectProvider *provider /Transfer/ );
%Docstring
Remove ``provider`` implementation from the list (``provider`` object is
deleted)
:return: ``True`` if the provider was actually removed and deleted
%End
void initializeFromProviderGuiRegistry( QgsProviderGuiRegistry *providerGuiRegistry );
%Docstring
Initializes the registry. The registry needs to be passed explicitly
(instead of using singleton) because this gets called from
:py:class:`QgsGui` constructor.
.. versionadded:: 3.10
%End
QgsSourceSelectProvider *providerByName( const QString &name );
%Docstring
Returns a provider by ``name`` or ``None`` if not found
%End
QList<QgsSourceSelectProvider *> providersByKey( const QString &providerKey );
%Docstring
Returns a (possibly empty) list of providers by data ``providerkey``
%End
QgsAbstractDataSourceWidget *createSelectionWidget(
const QString &name,
QWidget *parent,
Qt::WindowFlags fl,
QgsProviderRegistry::WidgetMode widgetMode
);
%Docstring
Gets select widget from provider with ``name``
The function is replacement of
:py:func:`QgsProviderRegistry.createSelectionWidget()` from QGIS 3.8
.. versionadded:: 3.10
%End
signals:
void providerAdded( const QString &name );
%Docstring
Emitted whenever a provider is added to the registry.
.. versionadded:: 3.30
%End
void providerRemoved( const QString &name );
%Docstring
Emitted whenever a provider is removed from the registry.
.. versionadded:: 3.30
%End
private:
QgsSourceSelectProviderRegistry( const QgsSourceSelectProviderRegistry &rh );
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/qgssourceselectproviderregistry.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
|
