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
|
/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/qgssourceselectprovider.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsSourceSelectProvider
{
%Docstring(signature="appended")
This is the interface for those who want to add entries to the
:py:class:`QgsDataSourceManagerDialog`
%End
%TypeHeaderCode
#include "qgssourceselectprovider.h"
%End
public:
static const QMetaObject staticMetaObject;
public:
enum Ordering /BaseType=IntEnum/
{
OrderLocalProvider,
OrderDatabaseProvider,
OrderRemoteProvider,
OrderSearchProvider,
OrderOtherProvider,
};
enum class Capability /BaseType=IntFlag/
{
NoCapabilities,
ConfigureFromUri
};
typedef QFlags<QgsSourceSelectProvider::Capability> Capabilities;
virtual ~QgsSourceSelectProvider();
virtual QString providerKey() const = 0;
%Docstring
Data Provider key
%End
virtual QString name() const;
%Docstring
Source select provider name, this is useful to retrieve a particular
source select in case the provider has more than one, it should be
unique among all providers.
The default implementation returns the
:py:func:`~QgsSourceSelectProvider.providerKey`
%End
virtual QString text() const = 0;
%Docstring
Text for the menu item entry, it will be visible to the user so make
sure it's translatable
%End
virtual QString toolTip() const;
%Docstring
Text for the tooltip menu item entry, it will be visible to the user so
make sure it's translatable
The default implementation returns an empty string.
%End
virtual QIcon icon() const = 0;
%Docstring
Creates a new instance of an QIcon for the menu item entry
%End
virtual int ordering() const;
%Docstring
Ordering: the source select provider registry will be able to sort the
source selects (ascending) using this integer value
%End
virtual QgsAbstractDataSourceWidget *createDataSourceWidget( QWidget *parent = 0, Qt::WindowFlags fl = Qt::Widget, QgsProviderRegistry::WidgetMode widgetMode = QgsProviderRegistry::WidgetMode::Embedded ) const = 0 /Factory/;
%Docstring
Create a new instance of :py:class:`QgsAbstractDataSourceWidget` (or
``None``). Caller takes responsibility of deleting created.
%End
virtual Capabilities capabilities();
%Docstring
Returns the source select provider capabilities. The default
implementation returns no capabilities.
.. versionadded:: 3.38
%End
};
QFlags<QgsSourceSelectProvider::Capability> operator|(QgsSourceSelectProvider::Capability f1, QFlags<QgsSourceSelectProvider::Capability> f2);
/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/qgssourceselectprovider.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
|
