QGIS API Documentation  2.99.0-Master (7d4f81d)
Classes | Public Slots | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
QgsOWSSourceSelect Class Reference

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

#include <qgsowssourceselect.h>

Inheritance diagram for QgsOWSSourceSelect:
Inheritance graph
[legend]

Classes

struct  SupportedFormat
 Formats supported by provider. More...
 

Public Slots

void on_mAddDefaultButton_clicked ()
 Add some default wms servers to the list. More...
 
void on_mChangeCRSButton_clicked ()
 Opens the Spatial Reference System dialog. More...
 
void on_mConnectButton_clicked ()
 Connects to the database using the stored connection parameters. More...
 
void on_mConnectionsComboBox_activated (int)
 Stores the selected datasource whenerver it is changed. More...
 
void on_mDeleteButton_clicked ()
 Deletes the selected connection. More...
 
void on_mEditButton_clicked ()
 Opens a dialog to edit an existing connection. More...
 
virtual void on_mLayersTreeWidget_itemSelectionChanged ()
 Signaled when a layer selection is changed. More...
 
void on_mLoadButton_clicked ()
 Loads connections from the file. More...
 
void on_mNewButton_clicked ()
 Opens the create connection dialog to build a new connection. More...
 
void on_mSaveButton_clicked ()
 Saves connections to the file. More...
 
void refresh () override
 Triggered when the provider's connections need to be refreshed. More...
 
void searchFinished ()
 
void showError (const QString &title, const QString &format, const QString &error)
 show whatever error is exposed. More...
 
void showStatusMessage (const QString &message)
 Set status message to theMessage. More...
 
- 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 okButtonClicked ()
 Triggered when the dialog is accepted, call addButtonClicked() and emit the accepted() signal. More...
 
virtual void refresh ()
 Triggered when the provider's connections need to be refreshed The default implementation does nothing. More...
 

Public Member Functions

 QgsOWSSourceSelect (const QString &service, QWidget *parent=nullptr, Qt::WindowFlags fl=QgsGuiUtils::ModalDialogFlags, QgsProviderRegistry::WidgetMode widgetMode=QgsProviderRegistry::WidgetMode::None)
 Constructor. More...
 
 ~QgsOWSSourceSelect ()
 
- Public Member Functions inherited from QgsAbstractDataSourceWidget
 ~QgsAbstractDataSourceWidget ()=default
 Destructor. More...
 
void setMapCanvas (const QgsMapCanvas *mapCanvas)
 Store a pointer to the map canvas to retrieve extent and CRS Used to select an appropriate CRS and possibly to retrieve data only in the current extent. More...
 

Protected Member Functions

void addDefaultServers ()
 Add a few example servers to the list. More...
 
void addWmsListItem (const QDomElement &el, int row, int column)
 
void addWmsListRow (const QDomElement &item, int row)
 
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...
 
QgsTreeWidgetItemcreateItem (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 ()
 Set supported CRSs. More...
 
void populateFormats ()
 Populate supported formats. More...
 
virtual void populateLayerList ()
 Populate the layer list. More...
 
void populateTimes ()
 Populate times. More...
 
virtual QList< QgsOWSSourceSelect::SupportedFormatproviderFormats ()
 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 ()
 Set 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
 Return the add Button. More...
 
const QgsMapCanvasmapCanvas () const
 Return the map canvas (can be null) More...
 
void setupButtons (QDialogButtonBox *buttonBox)
 Connect the ok and apply/add buttons to the slots. More...
 
QgsProviderRegistry::WidgetMode widgetMode () const
 Return 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

- Signals inherited from QgsAbstractDataSourceWidget
void addDatabaseLayers (const QStringList &paths, const QString &providerKey)
 Emitted when a DB 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 addVectorLayer (const QString &uri, const QString &layerName)
 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 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...
 
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...
 

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 57 of file qgsowssourceselect.cpp.

◆ ~QgsOWSSourceSelect()

QgsOWSSourceSelect::~QgsOWSSourceSelect ( )

Definition at line 110 of file qgsowssourceselect.cpp.

Member Function Documentation

◆ addDefaultServers()

void QgsOWSSourceSelect::addDefaultServers ( )
protected

Add a few example servers to the list.

Definition at line 581 of file qgsowssourceselect.cpp.

◆ addWmsListItem()

void QgsOWSSourceSelect::addWmsListItem ( const QDomElement &  el,
int  row,
int  column 
)
protected

Definition at line 621 of file qgsowssourceselect.cpp.

◆ addWmsListRow()

void QgsOWSSourceSelect::addWmsListRow ( const QDomElement &  item,
int  row 
)
protected

Definition at line 611 of file qgsowssourceselect.cpp.

◆ clearCrs()

void QgsOWSSourceSelect::clearCrs ( )
protected

Clear CRSs.

Definition at line 436 of file qgsowssourceselect.cpp.

◆ clearFormats()

void QgsOWSSourceSelect::clearFormats ( )
protected

Clear previously set formats.

Definition at line 122 of file qgsowssourceselect.cpp.

◆ clearTimes()

void QgsOWSSourceSelect::clearTimes ( )
protected

Clear times.

Definition at line 220 of file qgsowssourceselect.cpp.

◆ connectionInfo()

QString QgsOWSSourceSelect::connectionInfo ( )
protected

Connection info (uri)

Definition at line 475 of file qgsowssourceselect.cpp.

◆ connName()

QString QgsOWSSourceSelect::connName ( )
protected

Connection name.

Definition at line 470 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 294 of file qgsowssourceselect.cpp.

◆ descriptionForAuthId()

QString QgsOWSSourceSelect::descriptionForAuthId ( const QString &  authId)
protected

Returns a textual description for the authority id.

Definition at line 571 of file qgsowssourceselect.cpp.

◆ enableLayersForCrs()

void QgsOWSSourceSelect::enableLayersForCrs ( QTreeWidgetItem *  item)
protectedvirtual

Definition at line 353 of file qgsowssourceselect.cpp.

◆ on_mAddDefaultButton_clicked

void QgsOWSSourceSelect::on_mAddDefaultButton_clicked ( )
slot

Add some default wms servers to the list.

Definition at line 566 of file qgsowssourceselect.cpp.

◆ on_mChangeCRSButton_clicked

void QgsOWSSourceSelect::on_mChangeCRSButton_clicked ( )
slot

Opens the Spatial Reference System dialog.

Definition at line 357 of file qgsowssourceselect.cpp.

◆ on_mConnectButton_clicked

void QgsOWSSourceSelect::on_mConnectButton_clicked ( )
slot

Connects to the database using the stored connection parameters.

Once connected, available layers are displayed.

Definition at line 332 of file qgsowssourceselect.cpp.

◆ on_mConnectionsComboBox_activated

void QgsOWSSourceSelect::on_mConnectionsComboBox_activated ( int  )
slot

Stores the selected datasource whenerver it is changed.

Definition at line 560 of file qgsowssourceselect.cpp.

◆ on_mDeleteButton_clicked

void QgsOWSSourceSelect::on_mDeleteButton_clicked ( )
slot

Deletes the selected connection.

Definition at line 259 of file qgsowssourceselect.cpp.

◆ on_mEditButton_clicked

void QgsOWSSourceSelect::on_mEditButton_clicked ( )
slot

Opens a dialog to edit an existing connection.

Definition at line 246 of file qgsowssourceselect.cpp.

◆ on_mLayersTreeWidget_itemSelectionChanged

void QgsOWSSourceSelect::on_mLayersTreeWidget_itemSelectionChanged ( )
virtualslot

Signaled when a layer selection is changed.

Definition at line 393 of file qgsowssourceselect.cpp.

◆ on_mLoadButton_clicked

void QgsOWSSourceSelect::on_mLoadButton_clicked ( )
slot

Loads connections from the file.

Definition at line 279 of file qgsowssourceselect.cpp.

◆ on_mNewButton_clicked

void QgsOWSSourceSelect::on_mNewButton_clicked ( )
slot

Opens the create connection dialog to build a new connection.

Definition at line 233 of file qgsowssourceselect.cpp.

◆ on_mSaveButton_clicked

void QgsOWSSourceSelect::on_mSaveButton_clicked ( )
slot

Saves connections to the file.

Definition at line 273 of file qgsowssourceselect.cpp.

◆ populateConnectionList()

void QgsOWSSourceSelect::populateConnectionList ( )
protected

Populate the connection list combo box.

Definition at line 226 of file qgsowssourceselect.cpp.

◆ populateCrs()

void QgsOWSSourceSelect::populateCrs ( )
protected

Set supported CRSs.

Definition at line 397 of file qgsowssourceselect.cpp.

◆ populateFormats()

void QgsOWSSourceSelect::populateFormats ( )
protected

Populate supported formats.

Definition at line 128 of file qgsowssourceselect.cpp.

◆ populateLayerList()

void QgsOWSSourceSelect::populateLayerList ( )
protectedvirtual

Populate the layer list.

Return values
falseif the layers could not be retrieved or parsed

Definition at line 328 of file qgsowssourceselect.cpp.

◆ populateTimes()

void QgsOWSSourceSelect::populateTimes ( )
protected

Populate times.

Definition at line 213 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 740 of file qgsowssourceselect.cpp.

◆ refresh

void QgsOWSSourceSelect::refresh ( )
overrideslot

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

Definition at line 117 of file qgsowssourceselect.cpp.

◆ searchFinished

void QgsOWSSourceSelect::searchFinished ( )
slot

Definition at line 653 of file qgsowssourceselect.cpp.

◆ selectedCacheLoadControl()

QNetworkRequest::CacheLoadControl QgsOWSSourceSelect::selectedCacheLoadControl ( )
protected

Returns currently selected cache load control.

Definition at line 485 of file qgsowssourceselect.cpp.

◆ selectedCrs()

QString QgsOWSSourceSelect::selectedCrs ( )
protected

Returns currently selected Crs.

Definition at line 491 of file qgsowssourceselect.cpp.

◆ selectedFormat()

QString QgsOWSSourceSelect::selectedFormat ( )
protected

Returns currently selected format.

Definition at line 480 of file qgsowssourceselect.cpp.

◆ selectedLayersCrses()

QStringList QgsOWSSourceSelect::selectedLayersCrses ( )
protectedvirtual

Server CRS supported for currently selected layer item(s)

Definition at line 750 of file qgsowssourceselect.cpp.

◆ selectedLayersFormats()

QStringList QgsOWSSourceSelect::selectedLayersFormats ( )
protectedvirtual

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

Definition at line 745 of file qgsowssourceselect.cpp.

◆ selectedLayersTimes()

QStringList QgsOWSSourceSelect::selectedLayersTimes ( )
protectedvirtual

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

Definition at line 755 of file qgsowssourceselect.cpp.

◆ selectedTime()

QString QgsOWSSourceSelect::selectedTime ( )
protected

Returns currently selected time.

Definition at line 496 of file qgsowssourceselect.cpp.

◆ setConnectionListPosition()

void QgsOWSSourceSelect::setConnectionListPosition ( )
protected

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

Definition at line 501 of file qgsowssourceselect.cpp.

◆ showError

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

show whatever error is exposed.

Definition at line 544 of file qgsowssourceselect.cpp.

◆ showStatusMessage

void QgsOWSSourceSelect::showStatusMessage ( const QString &  message)
slot

Set status message to theMessage.

Definition at line 535 of file qgsowssourceselect.cpp.

Member Data Documentation

◆ mConnectionInfo

QString QgsOWSSourceSelect::mConnectionInfo
protected

Connection info for selected connection.

Definition at line 213 of file qgsowssourceselect.h.

◆ mConnName

QString QgsOWSSourceSelect::mConnName
protected

Name for selected connection.

Definition at line 210 of file qgsowssourceselect.h.

◆ mCrsNames

QMap<QString, QString> QgsOWSSourceSelect::mCrsNames
protected

Definition at line 187 of file qgsowssourceselect.h.

◆ mCurrentSelection

QList<QTreeWidgetItem *> QgsOWSSourceSelect::mCurrentSelection
protected

Definition at line 206 of file qgsowssourceselect.h.

◆ mCurrentTileset

QTableWidgetItem* QgsOWSSourceSelect::mCurrentTileset = nullptr
protected

Definition at line 207 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 185 of file qgsowssourceselect.h.

◆ mService

QString QgsOWSSourceSelect::mService
protected

Service name.

Definition at line 163 of file qgsowssourceselect.h.

◆ mUri

QgsDataSourceUri QgsOWSSourceSelect::mUri
protected

URI for selected connection.

Definition at line 216 of file qgsowssourceselect.h.


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