File: qgsdatabaseschemacombobox.sip.in

package info (click to toggle)
qgis 3.40.10%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 1,183,672 kB
  • sloc: cpp: 1,595,771; python: 372,544; xml: 23,474; sh: 3,761; perl: 3,664; ansic: 2,257; sql: 2,137; yacc: 1,068; lex: 577; javascript: 540; lisp: 411; makefile: 161
file content (111 lines) | stat: -rw-r--r-- 3,397 bytes parent folder | download | duplicates (12)
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/qgsdatabaseschemacombobox.h                                  *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.py again   *
 ************************************************************************/






class QgsDatabaseSchemaComboBox : QWidget
{
%Docstring(signature="appended")
The :py:class:`QgsDatabaseSchemaComboBox` class is a combo box which
displays the list of schemas 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 "qgsdatabaseschemacombobox.h"
%End
  public:
    explicit QgsDatabaseSchemaComboBox( const QString &provider, const QString &connection, QWidget *parent /TransferThis/ = 0 );
%Docstring
Constructor for QgsDatabaseSchemaComboBox, for the specified
``provider`` and ``connection``.

.. 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 QgsDatabaseSchemaComboBox( QgsAbstractDatabaseProviderConnection *connection /Transfer/, QWidget *parent /TransferThis/ = 0 );
%Docstring
Constructor for QgsDatabaseSchemaComboBox, for the specified
``connection``.

Ownership of ``connection`` is transferred to the combobox.
%End

    void setAllowEmptySchema( bool allowEmpty );
%Docstring
Sets whether an optional empty schema ("not set") option is present in
the combobox.

.. seealso:: :py:func:`allowEmptySchema`
%End

    bool allowEmptySchema() const;
%Docstring
Returns ``True`` if the combobox allows the empty schema ("not set")
choice.

.. seealso:: :py:func:`setAllowEmptySchema`
%End

    QString currentSchema() const;
%Docstring
Returns the name of the current schema selected in the combo box.
%End

    QComboBox *comboBox();
%Docstring
Returns the combobox portion of the widget.
%End

  public slots:

    void setSchema( const QString &schema );
%Docstring
Sets the current schema selected in the combo box.
%End

    void setConnectionName( const QString &connection, const QString &provider = QString() );
%Docstring
Sets the database connection name from which to retrieve the available
schemas.

Optionally the ``provider`` can be reset too.
%End

    void refreshSchemas();
%Docstring
Refreshes the list of available schemas.
%End

  signals:
    void schemaChanged( const QString &schema );
%Docstring
Emitted whenever the currently selected schema changes.
%End

};

/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/gui/qgsdatabaseschemacombobox.h                                  *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.py again   *
 ************************************************************************/