QGIS API Documentation  3.16.0-Hannover (43b64b13f3)
qgsconnectionregistry.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgsconnectionregistry.h
3  ------------------------
4  begin : March 2020
5  copyright : (C) 2020 by Nyall Dawson
6  email : nyall dot dawson at gmail dot com
7  ***************************************************************************/
8 
9 /***************************************************************************
10  * *
11  * This program is free software; you can redistribute it and/or modify *
12  * it under the terms of the GNU General Public License as published by *
13  * the Free Software Foundation; either version 2 of the License, or *
14  * (at your option) any later version. *
15  * *
16  ***************************************************************************/
17 
18 #ifndef QGSCONNECTIONREGISTRY_H
19 #define QGSCONNECTIONREGISTRY_H
20 
21 #include "qgis_core.h"
22 #include "qgis.h"
23 #include <QObject>
24 
26 
27 
38 class CORE_EXPORT QgsConnectionRegistry : public QObject
39 {
40  Q_OBJECT
41 
42  public:
43 
47  QgsConnectionRegistry( QObject *parent SIP_TRANSFERTHIS = nullptr );
48 
50  QgsConnectionRegistry( const QgsConnectionRegistry &other ) = delete;
53 
64  QgsAbstractProviderConnection *createConnection( const QString &name ) SIP_THROW( QgsProviderConnectionException ) SIP_FACTORY;
65 
66  private:
67 
68 #ifdef SIP_RUN
70 #endif
71 };
72 
73 #endif // QGSCONNECTIONREGISTRY_H
74 
75 
QgsConnectionRegistry
A registry for saved data provider connections, allowing retrieval of saved connections by name and p...
Definition: qgsconnectionregistry.h:39
qgis.h
SIP_FACTORY
#define SIP_FACTORY
Definition: qgis_sip.h:76
SIP_THROW
#define SIP_THROW(name)
Definition: qgis_sip.h:189
QgsConnectionRegistry::QgsConnectionRegistry
QgsConnectionRegistry(const QgsConnectionRegistry &other)=delete
Registry cannot be copied.
QgsProviderConnectionException
Custom exception class for provider connection related exceptions.
Definition: qgsexception.h:101
QgsConnectionRegistry::operator=
QgsConnectionRegistry & operator=(const QgsConnectionRegistry &other)=delete
Registry cannot be copied.
QgsAbstractProviderConnection
The QgsAbstractProviderConnection provides an interface for data provider connections.
Definition: qgsabstractproviderconnection.h:45
SIP_TRANSFERTHIS
#define SIP_TRANSFERTHIS
Definition: qgis_sip.h:53