File: qgsproviderconnectioncombobox.sip.in

package info (click to toggle)
qgis 3.22.16%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 1,186,020 kB
  • sloc: cpp: 1,275,562; python: 194,091; xml: 15,597; perl: 3,471; sh: 3,368; sql: 2,485; ansic: 2,219; yacc: 1,056; lex: 574; javascript: 504; lisp: 411; makefile: 227
file content (98 lines) | stat: -rw-r--r-- 3,117 bytes parent folder | download | duplicates (5)
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
/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/gui/qgsproviderconnectioncombobox.h                              *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.pl again   *
 ************************************************************************/






class QgsProviderConnectionComboBox : QComboBox
{
%Docstring(signature="appended")
The :py:class:`QgsProviderConnectionComboBox` class is a combo box which displays the list of connections registered for a given provider.

.. warning::

   The provider must support the connection API methods in its :py:class:`QgsProviderMetadata` implementation
   in order for the model to work correctly.

.. versionadded:: 3.14
%End

%TypeHeaderCode
#include "qgsproviderconnectioncombobox.h"
%End
  public:

    explicit QgsProviderConnectionComboBox( const QString &provider, QWidget *parent /TransferThis/ = 0 );
%Docstring
Constructor for QgsProviderConnectionComboBox, for the specified ``provider``.

.. warning::

   The provider must support the connection API methods in its :py:class:`QgsProviderMetadata` implementation
   in order for the model to work correctly.
%End


    void setProvider( const QString &provider );
%Docstring
Sets the provider to be used.

.. warning::

   The provider must support the connection API methods in its :py:class:`QgsProviderMetadata` implementation
   in order for the model to work correctly.
%End

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

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

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

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

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

    QString currentConnectionUri() const;
%Docstring
Returns the uri of the current connection selected in the combo box.
%End

  public slots:

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

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

};

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