Represents connections to tiled scene data sources. More...

#include <qgstiledsceneconnection.h>

Inheritance diagram for QgsTiledSceneProviderConnection:

Classes
struct	Data
	Represents decoded data of a tiled scene connection. More...

Public Member Functions
PRIVATE	QgsTiledSceneProviderConnection (const QString &name)
	Constructor for QgsTiledSceneProviderConnection, using the stored settings with the specified connection name. More...

	QgsTiledSceneProviderConnection (const QString &uri, const QString &provider, const QVariantMap &configuration)
	Constructor for QgsTiledSceneProviderConnection, using the a specific connection uri, provider name and configuration. More...

QString	providerKey () const
	Returns the data provider associated with the connection. More...

virtual void	remove (const QString &name) const override
	Deletes the connection from the settings. More...

virtual void	store (const QString &name) const override
	Stores the connection in the settings. More...

Public Member Functions inherited from QgsAbstractProviderConnection
	QgsAbstractProviderConnection (const QString &name)
	Creates a new connection with name by reading its configuration from the settings. More...

	QgsAbstractProviderConnection (const QString &uri, const QVariantMap &configuration)
	Creates a new connection from the given uri and configuration. More...

virtual	~QgsAbstractProviderConnection ()=default

QVariantMap	configuration () const
	Returns the connection configuration parameters. More...

virtual QIcon	icon () const
	Returns an icon representing the connection. More...

virtual void	remove (const QString &name) const =0
	Deletes the connection from the settings. More...

void	setConfiguration (const QVariantMap &configuration)
	Sets the connection configuration. More...

void	setUri (const QString &uri)
	Sets the connection data source URI to uri. More...

virtual void	store (const QString &name) const =0
	Stores the connection in the settings. More...

QString	uri () const
	Returns the connection data source URI string representation. More...

Static Public Member Functions
static void	addConnection (const QString &name, const Data &connection)
	Stores a new connection, under the specified connection name. More...

static Data	connection (const QString &name)
	Returns connection details for the stored connection with the specified name. More...

static QStringList	connectionList ()
	Returns a list of the stored connection names. More...

static Data	decodedUri (const QString &uri)
	Returns a connection uri decoded to a data structure. More...

static QString	encodedLayerUri (const Data &data)
	Returns connection data encoded as a string containing a URI for a QgsTiledSceneLayer. More...

static QString	encodedUri (const Data &data)
	Returns connection data encoded as a string. More...

static QString	selectedConnection ()
	Returns the name of the last used connection. More...

static void	setSelectedConnection (const QString &name)
	Stores the name of the last used connection. More...

Detailed Description

Represents connections to tiled scene data sources.

Note: Not available in Python bindings.

Since: QGIS 3.34

Definition at line 42 of file qgstiledsceneconnection.h.

Constructor & Destructor Documentation

◆ QgsTiledSceneProviderConnection() [1/2]

QgsTiledSceneProviderConnection::QgsTiledSceneProviderConnection ( const QString & name )

Constructor for QgsTiledSceneProviderConnection, using the stored settings with the specified connection name.

Definition at line 130 of file qgstiledsceneconnection.cpp.

◆ QgsTiledSceneProviderConnection() [2/2]

QgsTiledSceneProviderConnection::QgsTiledSceneProviderConnection	(	const QString &	uri,
		const QString &	provider,
		const QVariantMap &	configuration
	)

Constructor for QgsTiledSceneProviderConnection, using the a specific connection uri, provider name and configuration.

Definition at line 138 of file qgstiledsceneconnection.cpp.

Member Function Documentation

◆ addConnection()

void QgsTiledSceneProviderConnection::addConnection	(	const QString &	name,
		const Data &	connection
	)

static

Stores a new connection, under the specified connection name.

Definition at line 110 of file qgstiledsceneconnection.cpp.

◆ connection()

QgsTiledSceneProviderConnection::Data QgsTiledSceneProviderConnection::connection ( const QString & name )

static

Returns connection details for the stored connection with the specified name.

Definition at line 92 of file qgstiledsceneconnection.cpp.

◆ connectionList()

QStringList QgsTiledSceneProviderConnection::connectionList ( )

static

Returns a list of the stored connection names.

Definition at line 87 of file qgstiledsceneconnection.cpp.

◆ decodedUri()

QgsTiledSceneProviderConnection::Data QgsTiledSceneProviderConnection::decodedUri ( const QString & uri )

static

Returns a connection uri decoded to a data structure.

See also: encodedUri(); encodedLayerUri()

Definition at line 55 of file qgstiledsceneconnection.cpp.

◆ encodedLayerUri()

QString QgsTiledSceneProviderConnection::encodedLayerUri ( const Data & data )

static

Returns connection data encoded as a string containing a URI for a QgsTiledSceneLayer.

See also: encodedUri(); decodedUri()

Definition at line 70 of file qgstiledsceneconnection.cpp.

◆ encodedUri()

QString QgsTiledSceneProviderConnection::encodedUri ( const Data & data )

static

Returns connection data encoded as a string.

See also: encodedLayerUri(); decodedUri()

Definition at line 37 of file qgstiledsceneconnection.cpp.

◆ providerKey()

QString QgsTiledSceneProviderConnection::providerKey ( ) const

inline

Returns the data provider associated with the connection.

Definition at line 78 of file qgstiledsceneconnection.h.

◆ remove()

void QgsTiledSceneProviderConnection::remove ( const QString & name ) const

overridevirtual

Deletes the connection from the settings.

Implements QgsAbstractProviderConnection.

Definition at line 151 of file qgstiledsceneconnection.cpp.

◆ selectedConnection()

QString QgsTiledSceneProviderConnection::selectedConnection ( )

static

Returns the name of the last used connection.

See also: setSelectedConnection()

Definition at line 120 of file qgstiledsceneconnection.cpp.

◆ setSelectedConnection()

void QgsTiledSceneProviderConnection::setSelectedConnection ( const QString & name )

static

Stores the name of the last used connection.

See also: selectedConnection()

Definition at line 125 of file qgstiledsceneconnection.cpp.

◆ store()

void QgsTiledSceneProviderConnection::store ( const QString & name ) const

overridevirtual

Stores the connection in the settings.

Parameters

name	the name under which the connection will be stored

Implements QgsAbstractProviderConnection.

Definition at line 144 of file qgstiledsceneconnection.cpp.

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

/build/qgis-3.37.0+git20240325+fdefdf9c27f+17bookworm/src/core/tiledscene/qgstiledsceneconnection.h
/build/qgis-3.37.0+git20240325+fdefdf9c27f+17bookworm/src/core/tiledscene/qgstiledsceneconnection.cpp

Classes

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ QgsTiledSceneProviderConnection() [1/2]

◆ QgsTiledSceneProviderConnection() [2/2]

Member Function Documentation

◆ addConnection()

◆ connection()

◆ connectionList()

◆ decodedUri()

◆ encodedLayerUri()

◆ encodedUri()

◆ providerKey()

◆ remove()

◆ selectedConnection()

◆ setSelectedConnection()

◆ store()