QGIS API Documentation
4.3.0-Master (16eddb2670e)
Toggle main menu visibility
Loading...
Searching...
No Matches
src
core
providers
qgsabstractproviderconnection.h
Go to the documentation of this file.
1
/***************************************************************************
2
qgsabstractproviderconnection.h - QgsAbstractProviderConnection
3
4
---------------------
5
begin : 2.8.2019
6
copyright : (C) 2019 by Alessandro Pasotti
7
email : elpaso at itopen dot it
8
***************************************************************************
9
* *
10
* This program is free software; you can redistribute it and/or modify *
11
* it under the terms of the GNU General Public License as published by *
12
* the Free Software Foundation; either version 2 of the License, or *
13
* (at your option) any later version. *
14
* *
15
***************************************************************************/
16
#ifndef QGSABSTRACTPROVIDERCONNECTION_H
17
#define QGSABSTRACTPROVIDERCONNECTION_H
18
19
#include "qgis_core.h"
20
#include "
qgis_sip.h
"
21
22
#include <QString>
23
#include <QVariantMap>
24
42
class
CORE_EXPORT
QgsAbstractProviderConnection
43
{
44
#ifdef SIP_RUN
45
SIP_CONVERT_TO_SUBCLASS_CODE
46
if
(
dynamic_cast<
QgsAbstractDatabaseProviderConnection
*
>
( sipCpp ) != NULL )
47
{
48
sipType = sipType_QgsAbstractDatabaseProviderConnection;
49
}
50
else
if
(
dynamic_cast<
QgsAbstractProviderConnection
*
>
( sipCpp ) != NULL )
51
{
52
sipType = sipType_QgsAbstractProviderConnection;
53
}
54
else
55
{
56
sipType = 0;
57
}
58
SIP_END
59
#endif
60
61
public
:
62
67
QgsAbstractProviderConnection
(
const
QString &name );
68
74
QgsAbstractProviderConnection
(
const
QString &
uri
,
const
QVariantMap &
configuration
);
75
76
virtual
~QgsAbstractProviderConnection
() =
default
;
77
82
virtual
void
store
(
const
QString &name )
const
= 0;
83
87
virtual
void
remove
(
const
QString &name )
const
= 0;
88
92
virtual
QIcon
icon
()
const
;
93
97
QString
uri
()
const
;
98
102
void
setUri
(
const
QString &
uri
);
103
107
QVariantMap
configuration
()
const
;
108
112
void
setConfiguration
(
const
QVariantMap &
configuration
);
113
114
private
:
115
QString mUri;
116
QVariantMap mConfiguration;
117
};
118
119
#endif
// QGSABSTRACTPROVIDERCONNECTION_H
QgsAbstractDatabaseProviderConnection
Provides common functionality for database based connections.
Definition
qgsabstractdatabaseproviderconnection.h:50
QgsAbstractProviderConnection::icon
virtual QIcon icon() const
Returns an icon representing the connection.
Definition
qgsabstractproviderconnection.cpp:32
QgsAbstractProviderConnection::configuration
QVariantMap configuration() const
Returns the connection configuration parameters.
Definition
qgsabstractproviderconnection.cpp:47
QgsAbstractProviderConnection::~QgsAbstractProviderConnection
virtual ~QgsAbstractProviderConnection()=default
QgsAbstractProviderConnection::setUri
void setUri(const QString &uri)
Sets the connection data source URI to uri.
Definition
qgsabstractproviderconnection.cpp:42
QgsAbstractProviderConnection::QgsAbstractProviderConnection
QgsAbstractProviderConnection(const QString &name)
Creates a new connection with name by reading its configuration from the settings.
Definition
qgsabstractproviderconnection.cpp:20
QgsAbstractProviderConnection::remove
virtual void remove(const QString &name) const =0
Deletes the connection from the settings.
QgsAbstractProviderConnection::store
virtual void store(const QString &name) const =0
Stores the connection in the settings.
QgsAbstractProviderConnection::uri
QString uri() const
Returns the connection data source URI string representation.
Definition
qgsabstractproviderconnection.cpp:37
QgsAbstractProviderConnection::setConfiguration
void setConfiguration(const QVariantMap &configuration)
Sets the connection configuration.
Definition
qgsabstractproviderconnection.cpp:52
qgis_sip.h
SIP_CONVERT_TO_SUBCLASS_CODE
#define SIP_CONVERT_TO_SUBCLASS_CODE(code)
Definition
qgis_sip.h:203
SIP_END
#define SIP_END
Definition
qgis_sip.h:220
Generated on
for QGIS API Documentation by
1.17.0