QGIS API Documentation  3.8.0-Zanzibar (11aff65)
Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
QgsOwsConnection Class Reference

Connections management. More...

#include <qgsowsconnection.h>

Inheritance diagram for QgsOwsConnection:
Inheritance graph
[legend]

Public Member Functions

 QgsOwsConnection (const QString &service, const QString &connName)
 Constructor. More...
 
QString connectionInfo () const
 Returns connection info string. More...
 
QString connectionName () const
 Returns the connection name. More...
 
QString service () const
 Returns a string representing the service type, e.g. More...
 
QgsDataSourceUri uri () const
 Returns the connection uri. More...
 

Static Public Member Functions

static QgsDataSourceUriaddWfsConnectionSettings (QgsDataSourceUri &uri, const QString &settingsKey)
 Adds uri parameters relating to the settings for a WFS connection to a QgsDataSourceUri uri. More...
 
static QgsDataSourceUriaddWmsWcsConnectionSettings (QgsDataSourceUri &uri, const QString &settingsKey)
 Adds uri parameters relating to the settings for a WMS or WCS connection to a QgsDataSourceUri uri. More...
 
static QStringList connectionList (const QString &service)
 Returns the list of connections for the specified service. More...
 
static void deleteConnection (const QString &service, const QString &name)
 Deletes the connection for the specified service with the specified name. More...
 
static QString selectedConnection (const QString &service)
 Retrieves the selected connection for the specified service. More...
 
static void setSelectedConnection (const QString &service, const QString &name)
 Marks the specified connection for the specified service as selected. More...
 

Protected Attributes

QgsDataSourceUri mUri
 

Detailed Description

Connections management.

Definition at line 35 of file qgsowsconnection.h.

Constructor & Destructor Documentation

◆ QgsOwsConnection()

QgsOwsConnection::QgsOwsConnection ( const QString &  service,
const QString &  connName 
)

Constructor.

Parameters
serviceservice name: WMS,WFS,WCS
connNameconnection name

Definition at line 37 of file qgsowsconnection.cpp.

Member Function Documentation

◆ addWfsConnectionSettings()

QgsDataSourceUri & QgsOwsConnection::addWfsConnectionSettings ( QgsDataSourceUri uri,
const QString &  settingsKey 
)
static

Adds uri parameters relating to the settings for a WFS connection to a QgsDataSourceUri uri.

Connection settings are taken from the specified QSettings settingsKey.

Since
QGIS 3.0

Definition at line 139 of file qgsowsconnection.cpp.

◆ addWmsWcsConnectionSettings()

QgsDataSourceUri & QgsOwsConnection::addWmsWcsConnectionSettings ( QgsDataSourceUri uri,
const QString &  settingsKey 
)
static

Adds uri parameters relating to the settings for a WMS or WCS connection to a QgsDataSourceUri uri.

Connection settings are taken from the specified QSettings settingsKey.

Since
QGIS 3.0

Definition at line 108 of file qgsowsconnection.cpp.

◆ connectionInfo()

QString QgsOwsConnection::connectionInfo ( ) const

Returns connection info string.

Since
QGIS 3.0

Definition at line 93 of file qgsowsconnection.cpp.

◆ connectionList()

QStringList QgsOwsConnection::connectionList ( const QString &  service)
static

Returns the list of connections for the specified service.

Definition at line 159 of file qgsowsconnection.cpp.

◆ connectionName()

QString QgsOwsConnection::connectionName ( ) const

Returns the connection name.

Since
QGIS 3.0

Definition at line 88 of file qgsowsconnection.cpp.

◆ deleteConnection()

void QgsOwsConnection::deleteConnection ( const QString &  service,
const QString &  name 
)
static

Deletes the connection for the specified service with the specified name.

Definition at line 192 of file qgsowsconnection.cpp.

◆ selectedConnection()

QString QgsOwsConnection::selectedConnection ( const QString &  service)
static

Retrieves the selected connection for the specified service.

Definition at line 166 of file qgsowsconnection.cpp.

◆ service()

QString QgsOwsConnection::service ( ) const

Returns a string representing the service type, e.g.

"WMS".

Since
QGIS 3.0

Definition at line 98 of file qgsowsconnection.cpp.

◆ setSelectedConnection()

void QgsOwsConnection::setSelectedConnection ( const QString &  service,
const QString &  name 
)
static

Marks the specified connection for the specified service as selected.

Definition at line 172 of file qgsowsconnection.cpp.

◆ uri()

QgsDataSourceUri QgsOwsConnection::uri ( ) const

Returns the connection uri.

Definition at line 103 of file qgsowsconnection.cpp.

Member Data Documentation

◆ mUri

QgsDataSourceUri QgsOwsConnection::mUri
protected

Definition at line 97 of file qgsowsconnection.h.


The documentation for this class was generated from the following files: