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
|
/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/qgsdatabasetablecombobox.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsDatabaseTableComboBox : QWidget
{
%Docstring(signature="appended")
The :py:class:`QgsDatabaseTableComboBox` class is a combo box which
displays the list of tables for a specific database connection.
.. warning::
The provider must support the connection API methods in its :py:class:`QgsProviderMetadata` implementation
in order for the combobox to work correctly.
.. versionadded:: 3.14
%End
%TypeHeaderCode
#include "qgsdatabasetablecombobox.h"
%End
public:
explicit QgsDatabaseTableComboBox( const QString &provider, const QString &connection, const QString &schema = QString(), QWidget *parent /TransferThis/ = 0 );
%Docstring
Constructor for QgsDatabaseTableComboBox, for the specified ``provider``
and ``connection``.
The optional ``schema`` argument can be used to restrict the listed
tables to a specific schema.
.. warning::
The provider must support the connection API methods in its :py:class:`QgsProviderMetadata` implementation
in order for the model to work correctly.
%End
explicit QgsDatabaseTableComboBox( QgsAbstractDatabaseProviderConnection *connection /Transfer/, const QString &schema = QString(), QWidget *parent /TransferThis/ = 0 );
%Docstring
Constructor for QgsDatabaseTableComboBox, for the specified
``connection``.
The optional ``schema`` argument can be used to restrict the listed
tables to a specific schema.
Ownership of ``connection`` is transferred to the combobox.
%End
void setAllowEmptyTable( bool allowEmpty );
%Docstring
Sets whether an optional empty table ("not set") option is present in
the combobox.
.. seealso:: :py:func:`allowEmptyTable`
%End
bool allowEmptyTable() const;
%Docstring
Returns ``True`` if the combobox allows the empty table ("not set")
choice.
.. seealso:: :py:func:`setAllowEmptyTable`
%End
QString currentTable() const;
%Docstring
Returns the name of the current table selected in the combo box.
%End
QString currentSchema() const;
%Docstring
Returns the schema of the current table selected in the combo box.
%End
QComboBox *comboBox();
%Docstring
Returns the combobox portion of the widget.
%End
public slots:
void setTable( const QString &table, const QString &schema = QString() );
%Docstring
Sets the current table selected in the combo box.
If necessary, the ``schema`` can be specified too.
%End
void setConnectionName( const QString &connection, const QString &provider = QString() );
%Docstring
Sets the database connection name from which to retrieve the available
tables.
Optionally the ``provider`` can be reset too.
%End
void setSchema( const QString &schema );
%Docstring
Sets the ``schema`` from which to retrieve the available tables.
%End
void refreshTables();
%Docstring
Refreshes the list of available tables.
%End
signals:
void tableChanged( const QString &table, const QString &schema = QString() );
%Docstring
Emitted whenever the currently selected table changes.
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/qgsdatabasetablecombobox.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
|
