Dialog to create connections and add layers WCS etc. More...

#include <qgsowssourceselect.h>

Inheritance diagram for QgsOWSSourceSelect:

[legend]

Classes
struct	SupportedFormat
	Formats supported by provider. More...

Public Member Functions
	QgsOWSSourceSelect (const QString &service, QWidget *parent=nullptr, Qt::WindowFlags fl=QgsGuiUtils::ModalDialogFlags, QgsProviderRegistry::WidgetMode widgetMode=QgsProviderRegistry::WidgetMode::None)
	Constructor. More...

void	refresh () override
	Triggered when the provider's connections need to be refreshed. More...

void	reset () override
	Called when this source select widget is being shown in a "new and clean" dialog. More...

void	setMapCanvas (QgsMapCanvas *mapCanvas) override
	Sets the dialog map canvas. More...

Public Member Functions inherited from QgsAbstractDataSourceWidget
virtual QgsMapCanvas *	mapCanvas ()
	Returns the dialog map canvas. More...

virtual void	setBrowserModel (QgsBrowserModel *model)
	Sets a browser model to use with the widget. More...

virtual void	setMapCanvas (QgsMapCanvas *mapCanvas)
	Sets the dialog map canvas. More...

Protected Slots
void	showError (const QString &title, const QString &format, const QString &error)
	show whatever error is exposed. More...

void	showStatusMessage (const QString &message)
	Sets status message to theMessage. More...

Protected Member Functions
void	addDefaultServers ()
	Add a few example servers to the list. More...

void	clearCrs ()
	Clear CRSs. More...

void	clearFormats ()
	Clear previously set formats. More...

void	clearTimes ()
	Clear times. More...

QString	connectionInfo ()
	Connection info (uri) More...

QString	connName ()
	Connection name. More...

QgsTreeWidgetItem *	createItem (int id, const QStringList &names, QMap< int, QgsTreeWidgetItem * > &items, int &layerAndStyleCount, const QMap< int, int > &layerParents, const QMap< int, QStringList > &layerParentNames)
	create an item including possible parents More...

QString	descriptionForAuthId (const QString &authId)
	Returns a textual description for the authority id. More...

virtual void	enableLayersForCrs (QTreeWidgetItem *item)

void	populateConnectionList ()
	Populate the connection list combo box. More...

void	populateCrs ()
	Sets supported CRSs. More...

void	populateFormats ()
	Populate supported formats. More...

virtual void	populateLayerList ()
	Populate the layer list. More...

void	populateTimes ()
	Populate times. More...

void	prepareExtent ()
	Prepares the spatial extent box with the general settings including original crs, destination crs and the map canvas if it is available. More...

virtual QList< QgsOWSSourceSelect::SupportedFormat >	providerFormats ()
	List of image formats (encodings) supported by provider. More...

QNetworkRequest::CacheLoadControl	selectedCacheLoadControl ()
	Returns currently selected cache load control. More...

QString	selectedCrs ()
	Returns currently selected Crs. More...

QString	selectedFormat ()
	Returns currently selected format. More...

virtual QStringList	selectedLayersCrses ()
	Server CRS supported for currently selected layer item(s) More...

virtual QStringList	selectedLayersFormats ()
	List of formats supported for currently selected layer item(s) More...

virtual QStringList	selectedLayersTimes ()
	List of times (temporalDomain timePosition/timePeriod for currently selected layer item(s) More...

QString	selectedTime ()
	Returns currently selected time. More...

void	setConnectionListPosition ()
	Sets the server connection combo box to that stored in the config file. More...

Protected Member Functions inherited from QgsAbstractDataSourceWidget
	QgsAbstractDataSourceWidget (QWidget *parent=nullptr, Qt::WindowFlags fl=QgsGuiUtils::ModalDialogFlags, QgsProviderRegistry::WidgetMode widgetMode=QgsProviderRegistry::WidgetMode::None)
	Constructor. More...

QPushButton *	addButton () const
	Returns the add Button. More...

QgsBrowserModel *	browserModel ()
	Returns the associated browser model (may be `nullptr`). More...

void	setupButtons (QDialogButtonBox *buttonBox)
	Connect the ok and apply/add buttons to the slots. More...

QgsProviderRegistry::WidgetMode	widgetMode () const
	Returns the widget mode. More...

Protected Attributes
QString	mConnectionInfo
	Connection info for selected connection. More...

QString	mConnName
	Name for selected connection. More...

QMap< QString, QString >	mCrsNames

QList< QTreeWidgetItem * >	mCurrentSelection

QTableWidgetItem *	mCurrentTileset = nullptr

QString	mLastLayerName
	layer name derived from latest layer selection (updated as long it's not edited manually) More...

QString	mService
	Service name. More...

QgsDataSourceUri	mUri
	URI for selected connection. More...

Additional Inherited Members
Public Slots inherited from QgsAbstractDataSourceWidget
virtual void	addButtonClicked ()
	Triggered when the add button is clicked, the add layer signal is emitted Concrete classes should implement the right behavior depending on the layer being added. More...

virtual void	refresh ()
	Triggered when the provider's connections need to be refreshed The default implementation does nothing. More...

virtual void	reset ()
	Called when this source select widget is being shown in a "new and clean" dialog. More...

Signals inherited from QgsAbstractDataSourceWidget
void	addDatabaseLayers (const QStringList &paths, const QString &providerKey)
	Emitted when a DB layer has been selected for addition. More...

void	addMeshLayer (const QString &url, const QString &baseName, const QString &providerKey)
	Emitted when a mesh layer has been selected for addition. More...

void	addPointCloudLayer (const QString &url, const QString &baseName, const QString &providerKey)
	Emitted when a point cloud layer has been selected for addition. More...

void	addRasterLayer (const QString &rasterLayerPath, const QString &baseName, const QString &providerKey)
	Emitted when a raster layer has been selected for addition. More...

void	addRasterLayers (const QStringList &layersList)
	Emitted when one or more GDAL supported layers are selected for addition. More...

void	addVectorLayer (const QString &uri, const QString &layerName, const QString &providerKey=QString())
	Emitted when a vector layer has been selected for addition. More...

void	addVectorLayers (const QStringList &layerList, const QString &encoding, const QString &dataSourceType)
	Emitted when one or more OGR supported layers are selected for addition. More...

void	addVectorTileLayer (const QString &url, const QString &baseName)
	Emitted when a vector tile layer has been selected for addition. More...

void	connectionsChanged ()
	Emitted when the provider's connections have changed This signal is normally forwarded the app and used to refresh browser items. More...

void	enableButtons (bool enable)
	Emitted when the ok/add buttons should be enabled/disabled. More...

Q_DECL_DEPRECATED void	progress (int, int)
	Emitted when a progress dialog is shown by the provider dialog. More...

void	progressMessage (QString message)
	Emitted when a progress dialog is shown by the provider dialog. More...

void	pushMessage (const QString &title, const QString &message, const Qgis::MessageLevel level=Qgis::MessageLevel::Info)
	Emitted when a message with title and level must be shown to the user using the parent visible message bar. More...

void	replaceVectorLayer (const QString &oldId, const QString &source, const QString &name, const QString &provider)
	Emitted when a layer needs to be replaced. More...

Detailed Description

Dialog to create connections and add layers WCS etc.

This dialog allows the user to define and save connection information for WMS servers, etc.

The user can then connect and add layers from the WCS server to the map canvas.

Definition at line 52 of file qgsowssourceselect.h.

Constructor & Destructor Documentation

◆ QgsOWSSourceSelect()

QgsOWSSourceSelect::QgsOWSSourceSelect	(	const QString &	service,
		QWidget *	parent = `nullptr`,
		Qt::WindowFlags	fl = `QgsGuiUtils::ModalDialogFlags`,
		QgsProviderRegistry::WidgetMode	widgetMode = `QgsProviderRegistry::WidgetMode::None`
	)

Constructor.

Definition at line 56 of file qgsowssourceselect.cpp.

Member Function Documentation

◆ addDefaultServers()

void QgsOWSSourceSelect::addDefaultServers ( )

protected

Add a few example servers to the list.

Definition at line 634 of file qgsowssourceselect.cpp.

◆ clearCrs()

void QgsOWSSourceSelect::clearCrs ( )

protected

Clear CRSs.

Definition at line 489 of file qgsowssourceselect.cpp.

◆ clearFormats()

void QgsOWSSourceSelect::clearFormats ( )

protected

Clear previously set formats.

Definition at line 149 of file qgsowssourceselect.cpp.

◆ clearTimes()

void QgsOWSSourceSelect::clearTimes ( )

protected

Clear times.

Definition at line 247 of file qgsowssourceselect.cpp.

◆ connectionInfo()

QString QgsOWSSourceSelect::connectionInfo ( )

protected

Connection info (uri)

Definition at line 528 of file qgsowssourceselect.cpp.

◆ connName()

QString QgsOWSSourceSelect::connName ( )

protected

Connection name.

Definition at line 523 of file qgsowssourceselect.cpp.

◆ createItem()

QgsTreeWidgetItem * QgsOWSSourceSelect::createItem	(	int	id,
		const QStringList &	names,
		QMap< int, QgsTreeWidgetItem * > &	items,
		int &	layerAndStyleCount,
		const QMap< int, int > &	layerParents,
		const QMap< int, QStringList > &	layerParentNames
	)

protected

create an item including possible parents

Note: not available in Python bindings

Definition at line 336 of file qgsowssourceselect.cpp.

◆ descriptionForAuthId()

QString QgsOWSSourceSelect::descriptionForAuthId ( const QString & authId )

protected

Returns a textual description for the authority id.

Definition at line 624 of file qgsowssourceselect.cpp.

◆ enableLayersForCrs()

void QgsOWSSourceSelect::enableLayersForCrs ( QTreeWidgetItem * item )

protectedvirtual

Definition at line 395 of file qgsowssourceselect.cpp.

◆ populateConnectionList()

void QgsOWSSourceSelect::populateConnectionList ( )

protected

Populate the connection list combo box.

Definition at line 253 of file qgsowssourceselect.cpp.

◆ populateCrs()

void QgsOWSSourceSelect::populateCrs ( )

protected

Sets supported CRSs.

Definition at line 443 of file qgsowssourceselect.cpp.

◆ populateFormats()

void QgsOWSSourceSelect::populateFormats ( )

protected

Populate supported formats.

Definition at line 155 of file qgsowssourceselect.cpp.

◆ populateLayerList()

void QgsOWSSourceSelect::populateLayerList ( )

protectedvirtual

Populate the layer list.

Returns: false if the layers could not be retrieved or parsed

Definition at line 370 of file qgsowssourceselect.cpp.

◆ populateTimes()

void QgsOWSSourceSelect::populateTimes ( )

protected

Populate times.

Definition at line 240 of file qgsowssourceselect.cpp.

◆ prepareExtent()

void QgsOWSSourceSelect::prepareExtent ( )

protected

Prepares the spatial extent box with the general settings including original crs, destination crs and the map canvas if it is available.

Since: QGIS 3.26

Definition at line 126 of file qgsowssourceselect.cpp.

◆ providerFormats()

QList< QgsOWSSourceSelect::SupportedFormat > QgsOWSSourceSelect::providerFormats ( )

protectedvirtual

List of image formats (encodings) supported by provider.

Returns: list of format/label pairs

Definition at line 702 of file qgsowssourceselect.cpp.

◆ refresh()

void QgsOWSSourceSelect::refresh ( )

overridevirtual

Triggered when the provider's connections need to be refreshed.

Reimplemented from QgsAbstractDataSourceWidget.

Definition at line 139 of file qgsowssourceselect.cpp.

◆ reset()

void QgsOWSSourceSelect::reset ( )

overridevirtual

Called when this source select widget is being shown in a "new and clean" dialog.

The data source manager recycles existing source select widgets but will call this method on every reopening. This should clear any selection that has previously been done.

Since: QGIS 3.10

Reimplemented from QgsAbstractDataSourceWidget.

Definition at line 144 of file qgsowssourceselect.cpp.

◆ selectedCacheLoadControl()

QNetworkRequest::CacheLoadControl QgsOWSSourceSelect::selectedCacheLoadControl ( )

protected

Returns currently selected cache load control.

Definition at line 538 of file qgsowssourceselect.cpp.

◆ selectedCrs()

QString QgsOWSSourceSelect::selectedCrs ( )

protected

Returns currently selected Crs.

Definition at line 544 of file qgsowssourceselect.cpp.

◆ selectedFormat()

QString QgsOWSSourceSelect::selectedFormat ( )

protected

Returns currently selected format.

Definition at line 533 of file qgsowssourceselect.cpp.

◆ selectedLayersCrses()

QStringList QgsOWSSourceSelect::selectedLayersCrses ( )

protectedvirtual

Server CRS supported for currently selected layer item(s)

Definition at line 712 of file qgsowssourceselect.cpp.

◆ selectedLayersFormats()

QStringList QgsOWSSourceSelect::selectedLayersFormats ( )

protectedvirtual

List of formats supported for currently selected layer item(s)

Definition at line 707 of file qgsowssourceselect.cpp.

◆ selectedLayersTimes()

QStringList QgsOWSSourceSelect::selectedLayersTimes ( )

protectedvirtual

List of times (temporalDomain timePosition/timePeriod for currently selected layer item(s)

Definition at line 717 of file qgsowssourceselect.cpp.

◆ selectedTime()

QString QgsOWSSourceSelect::selectedTime ( )

protected

Returns currently selected time.

Definition at line 549 of file qgsowssourceselect.cpp.

◆ setConnectionListPosition()

void QgsOWSSourceSelect::setConnectionListPosition ( )

protected

Sets the server connection combo box to that stored in the config file.

Definition at line 554 of file qgsowssourceselect.cpp.

◆ setMapCanvas()

void QgsOWSSourceSelect::setMapCanvas ( QgsMapCanvas * mapCanvas )

overridevirtual

Sets the dialog map canvas.

See also: mapCanvas()

Reimplemented from QgsAbstractDataSourceWidget.

Definition at line 120 of file qgsowssourceselect.cpp.

◆ showError

void QgsOWSSourceSelect::showError	(	const QString &	title,
		const QString &	format,
		const QString &	error
	)

protectedslot

show whatever error is exposed.

Definition at line 597 of file qgsowssourceselect.cpp.

◆ showStatusMessage

void QgsOWSSourceSelect::showStatusMessage ( const QString & message )

protectedslot

Sets status message to theMessage.

Definition at line 588 of file qgsowssourceselect.cpp.

Member Data Documentation

◆ mConnectionInfo

QString QgsOWSSourceSelect::mConnectionInfo

protected

Connection info for selected connection.

Definition at line 193 of file qgsowssourceselect.h.

◆ mConnName

QString QgsOWSSourceSelect::mConnName

protected

Name for selected connection.

Definition at line 190 of file qgsowssourceselect.h.

◆ mCrsNames

QMap<QString, QString> QgsOWSSourceSelect::mCrsNames

protected

Definition at line 161 of file qgsowssourceselect.h.

◆ mCurrentSelection

QList<QTreeWidgetItem *> QgsOWSSourceSelect::mCurrentSelection

protected

Definition at line 186 of file qgsowssourceselect.h.

◆ mCurrentTileset

QTableWidgetItem* QgsOWSSourceSelect::mCurrentTileset = nullptr

protected

Definition at line 187 of file qgsowssourceselect.h.

◆ mLastLayerName

QString QgsOWSSourceSelect::mLastLayerName

protected

layer name derived from latest layer selection (updated as long it's not edited manually)

Definition at line 159 of file qgsowssourceselect.h.

◆ mService

QString QgsOWSSourceSelect::mService

protected

Service name.

Definition at line 135 of file qgsowssourceselect.h.

◆ mUri

QgsDataSourceUri QgsOWSSourceSelect::mUri

protected

URI for selected connection.

Definition at line 196 of file qgsowssourceselect.h.

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

/build/qgis-3.28.0+99sid/src/gui/qgsowssourceselect.h
/build/qgis-3.28.0+99sid/src/gui/qgsowssourceselect.cpp

Classes

Public Member Functions

Protected Slots

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QgsOWSSourceSelect()

Member Function Documentation

◆ addDefaultServers()

◆ clearCrs()

◆ clearFormats()

◆ clearTimes()

◆ connectionInfo()

◆ connName()

◆ createItem()

◆ descriptionForAuthId()

◆ enableLayersForCrs()

◆ populateConnectionList()

◆ populateCrs()

◆ populateFormats()

◆ populateLayerList()

◆ populateTimes()

◆ prepareExtent()

◆ providerFormats()

◆ refresh()

◆ reset()

◆ selectedCacheLoadControl()

◆ selectedCrs()

◆ selectedFormat()

◆ selectedLayersCrses()

◆ selectedLayersFormats()

◆ selectedLayersTimes()

◆ selectedTime()

◆ setConnectionListPosition()

◆ setMapCanvas()

◆ showError

◆ showStatusMessage

Member Data Documentation

◆ mConnectionInfo

◆ mConnName

◆ mCrsNames

◆ mCurrentSelection

◆ mCurrentTileset

◆ mLastLayerName

◆ mService

◆ mUri