File: qgsconnectionregistry.sip.in

package info (click to toggle)
qgis 3.40.11%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,183,800 kB
  • sloc: cpp: 1,595,841; python: 372,637; 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: 154
file content (63 lines) | stat: -rw-r--r-- 2,154 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
/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/core/qgsconnectionregistry.h                                     *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.py again   *
 ************************************************************************/






class QgsConnectionRegistry : QObject
{
%Docstring(signature="appended")
A registry for saved data provider connections, allowing retrieval of
saved connections by name and provider type.

:py:class:`QgsConnectionRegistry` is not usually directly created, but
rather accessed through :py:func:`QgsApplication.connectionRegistry()`.

.. versionadded:: 3.14
%End

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

    QgsConnectionRegistry( QObject *parent /TransferThis/ = 0 );
%Docstring
Constructor for QgsConnectionRegistry.
%End


    QgsAbstractProviderConnection *createConnection( const QString &name ) throw( QgsProviderConnectionException ) /Factory/;
%Docstring
Creates a new connection by loading the connection with the given ``id``
from the settings.

The ``id`` string must be of the format "provider://connection_name",
e.g. "postgres://my_connection" for the PostgreSQL connection saved as
"my_connection".

Ownership is transferred to the caller.

:raises QgsProviderConnectionException: 
%End

  private:
    QgsConnectionRegistry( const QgsConnectionRegistry &other );
};



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