QGIS/python/core/auto_generated/qgsowsconnection.sip.in
Nyall Dawson 3f6b490218 Sipify
2025-04-02 11:11:10 +10:00

131 lines
4.1 KiB
Plaintext

/************************************************************************
* This file has been generated automatically from *
* *
* src/core/qgsowsconnection.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsOwsConnection : QObject
{
%Docstring(signature="appended")
Connections management for OWS connections.
%End
%TypeHeaderCode
#include "qgsowsconnection.h"
%End
public:
QgsOwsConnection( const QString &service, const QString &connName );
%Docstring
Constructor
:param service: service name: WMS,WFS,WCS
:param connName: connection name
%End
QString connectionName() const;
%Docstring
Returns the connection name.
%End
QString connectionInfo() const;
%Docstring
Returns connection info string.
%End
QString service() const;
%Docstring
Returns a string representing the service type, e.g. "WMS".
%End
QgsDataSourceUri uri() const;
%Docstring
Returns the connection uri.
%End
static QgsDataSourceUri &addWmsWcsConnectionSettings( QgsDataSourceUri &uri, const QString &settingsKey ) /Deprecated="Since 3.26. Use addWmsWcsConnectionSettings with service and connection name parameters."/;
%Docstring
Adds uri parameters relating to the settings for a WMS or WCS connection
to a :py:class:`QgsDataSourceUri` ``uri``. Connection settings are taken
from the specified QSettings ``settingsKey``.
.. deprecated:: 3.26
Use addWmsWcsConnectionSettings with service and connection name parameters.
%End
static QgsDataSourceUri &addWmsWcsConnectionSettings( QgsDataSourceUri &uri, const QString &service, const QString &connName );
%Docstring
Adds uri parameters relating to the settings for a WMS or WCS connection
to a :py:class:`QgsDataSourceUri` ``uri``. Connection settings are taken
from the specified ``servcie`` and ``connName``
.. versionadded:: 3.26
%End
static QgsDataSourceUri &addWfsConnectionSettings( QgsDataSourceUri &uri, const QString &settingsKey ) /Deprecated="Since 3.26. Use addWfsConnectionSettings with service and connection name parameters."/;
%Docstring
Adds uri parameters relating to the settings for a WFS connection to a
:py:class:`QgsDataSourceUri` ``uri``. Connection settings are taken from
the specified QSettings ``settingsKey``.
.. deprecated:: 3.26
Use addWfsConnectionSettings with service and connection name parameters.
%End
static QgsDataSourceUri &addWfsConnectionSettings( QgsDataSourceUri &uri, const QString &service, const QString &connName );
%Docstring
Adds uri parameters relating to the settings for a WFS connection to a
:py:class:`QgsDataSourceUri` ``uri``. Connection settings are taken from
the specified ``servcie`` and ``connName``
.. versionadded:: 3.26
%End
static QStringList connectionList( const QString &service );
%Docstring
Returns the list of connections for the specified service
%End
static void deleteConnection( const QString &service, const QString &name );
%Docstring
Deletes the connection for the specified service with the specified name
%End
static QString selectedConnection( const QString &service );
%Docstring
Retrieves the selected connection for the specified service
%End
static void setSelectedConnection( const QString &service, const QString &name );
%Docstring
Marks the specified connection for the specified service as selected
%End
protected:
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/qgsowsconnection.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/