QGIS API Documentation  3.20.0-Odense (decaadbb31)
qgsdatasourcemanagerdialog.cpp
Go to the documentation of this file.
1 /***************************************************************************
2  qgsdatasourcemanagerdialog.cpp - datasource manager dialog
3 
4  ---------------------
5  begin : May 19, 2017
6  copyright : (C) 2017 by Alessandro Pasotti
7  email : apasotti at itopen dot it
8  ***************************************************************************
9  * *
10  * This program is free software; you can redistribute it and/or modify *
11  * it under the terms of the GNU General Public License as published by *
12  * the Free Software Foundation; either version 2 of the License, or *
13  * (at your option) any later version. *
14  * *
15  ***************************************************************************/
16 
17 #include <QListWidgetItem>
18 
20 #include "ui_qgsdatasourcemanagerdialog.h"
21 #include "qgsbrowserdockwidget.h"
22 #include "qgssettings.h"
23 #include "qgsproviderregistry.h"
27 #include "qgsmapcanvas.h"
28 #include "qgsmessagelog.h"
29 #include "qgsmessagebar.h"
30 #include "qgsgui.h"
31 #include "qgsbrowserguimodel.h"
32 
33 QgsDataSourceManagerDialog::QgsDataSourceManagerDialog( QgsBrowserGuiModel *browserModel, QWidget *parent, QgsMapCanvas *canvas, Qt::WindowFlags fl )
34  : QgsOptionsDialogBase( QStringLiteral( "Data Source Manager" ), parent, fl )
35  , ui( new Ui::QgsDataSourceManagerDialog )
36  , mPreviousRow( -1 )
37  , mMapCanvas( canvas )
38  , mBrowserModel( browserModel )
39 {
40  ui->setupUi( this );
41  ui->verticalLayout_2->setSpacing( 6 );
42  ui->verticalLayout_2->setContentsMargins( 0, 0, 0, 0 );
43 
44  mMessageBar = new QgsMessageBar( this );
45  mMessageBar->setSizePolicy( QSizePolicy::MinimumExpanding, QSizePolicy::Fixed );
46  static_cast<QVBoxLayout *>( layout() )->insertWidget( 0, mMessageBar );
47 
48  // QgsOptionsDialogBase handles saving/restoring of geometry, splitter and current tab states,
49  // switching vertical tabs between icon/text to icon-only modes (splitter collapsed to left),
50  // and connecting QDialogButtonBox's accepted/rejected signals to dialog's accept/reject slots
51  initOptionsBase( false );
52 
53  // Bind list index to the stacked dialogs
54  connect( ui->mOptionsListWidget, &QListWidget::currentRowChanged, this, &QgsDataSourceManagerDialog::setCurrentPage );
55 
56  // BROWSER Add the browser widget to the first stacked widget page
57  mBrowserWidget = new QgsBrowserDockWidget( QStringLiteral( "Browser" ), mBrowserModel, this );
58  mBrowserWidget->setFeatures( QDockWidget::NoDockWidgetFeatures );
59  ui->mOptionsStackedWidget->addWidget( mBrowserWidget );
60  mPageNames.append( QStringLiteral( "browser" ) );
61  // Forward all browser signals
63  connect( mBrowserWidget, &QgsBrowserDockWidget::openFile, this, &QgsDataSourceManagerDialog::openFile );
66 
67  // Add provider dialogs
68  const QList<QgsSourceSelectProvider *> sourceSelectProviders = QgsGui::sourceSelectProviderRegistry()->providers( );
69  for ( QgsSourceSelectProvider *provider : sourceSelectProviders )
70  {
71  QgsAbstractDataSourceWidget *dlg = provider->createDataSourceWidget( this );
72  if ( !dlg )
73  {
74  QgsMessageLog::logMessage( tr( "Cannot get %1 select dialog from source select provider %2." ).arg( provider->name(), provider->providerKey() ), QStringLiteral( "DataSourceManager" ), Qgis::MessageLevel::Critical );
75  continue;
76  }
77  addProviderDialog( dlg, provider->providerKey(), provider->text(), provider->icon( ), provider->toolTip( ) );
78  }
79 
80  restoreOptionsBaseUi( QStringLiteral( "Data Source Manager" ) );
81 }
82 
84 {
85  delete ui;
86 }
87 
88 void QgsDataSourceManagerDialog::openPage( const QString &pageName )
89 {
90  int pageIdx = mPageNames.indexOf( pageName );
91  if ( pageIdx != -1 )
92  {
93  QTimer::singleShot( 0, this, [ = ] { setCurrentPage( pageIdx ); } );
94  }
95 }
96 
98 {
99  return mMessageBar;
100 }
101 
103 {
104  mPreviousRow = ui->mOptionsStackedWidget->currentIndex();
105  ui->mOptionsStackedWidget->setCurrentIndex( index );
106  setWindowTitle( tr( "Data Source Manager | %1" ).arg( ui->mOptionsListWidget->currentItem()->text() ) );
107  resizeAlltabs( index );
108 }
109 
111 {
112  int prevPage = mPreviousRow != -1 ? mPreviousRow : 0;
113  setCurrentPage( prevPage );
114 }
115 
117 {
118  mBrowserWidget->refresh();
120 }
121 
123 {
124  int pageCount = ui->mOptionsStackedWidget->count();
125  for ( int i = 0; i < pageCount; ++i )
126  {
127  QWidget *widget = ui->mOptionsStackedWidget->widget( i );
128  QgsAbstractDataSourceWidget *dataSourceWidget = qobject_cast<QgsAbstractDataSourceWidget *>( widget );
129  if ( dataSourceWidget )
130  dataSourceWidget->reset();
131  }
132 }
133 
134 void QgsDataSourceManagerDialog::rasterLayerAdded( const QString &uri, const QString &baseName, const QString &providerKey )
135 {
136  emit addRasterLayer( uri, baseName, providerKey );
137 }
138 
139 void QgsDataSourceManagerDialog::rasterLayersAdded( const QStringList &layersList )
140 {
141  emit addRasterLayers( layersList );
142 }
143 
144 void QgsDataSourceManagerDialog::vectorLayerAdded( const QString &vectorLayerPath, const QString &baseName, const QString &providerKey )
145 {
146  emit addVectorLayer( vectorLayerPath, baseName, providerKey );
147 }
148 
149 void QgsDataSourceManagerDialog::vectorLayersAdded( const QStringList &layerQStringList, const QString &enc, const QString &dataSourceType )
150 {
151  emit addVectorLayers( layerQStringList, enc, dataSourceType );
152 }
153 
154 void QgsDataSourceManagerDialog::addProviderDialog( QgsAbstractDataSourceWidget *dlg, const QString &providerKey, const QString &providerName, const QIcon &icon, const QString &toolTip )
155 {
156  mPageNames.append( providerKey );
157  ui->mOptionsStackedWidget->addWidget( dlg );
158  QListWidgetItem *layerItem = new QListWidgetItem( providerName, ui->mOptionsListWidget );
159  layerItem->setToolTip( toolTip.isEmpty() ? tr( "Add %1 layer" ).arg( providerName ) : toolTip );
160  layerItem->setIcon( icon );
161  // Set crs and extent from canvas
162  if ( mMapCanvas )
163  {
164  dlg->setMapCanvas( mMapCanvas );
165  }
166  dlg->setBrowserModel( mBrowserModel );
167 
168  connect( dlg, &QgsAbstractDataSourceWidget::rejected, this, &QgsDataSourceManagerDialog::reject );
169  connect( dlg, &QgsAbstractDataSourceWidget::accepted, this, &QgsDataSourceManagerDialog::accept );
170  makeConnections( dlg, providerKey );
171 }
172 
173 void QgsDataSourceManagerDialog::makeConnections( QgsAbstractDataSourceWidget *dlg, const QString &providerKey )
174 {
175  // DB
180  // Vector
181  connect( dlg, &QgsAbstractDataSourceWidget::addVectorLayer, this, [ = ]( const QString & vectorLayerPath, const QString & baseName, const QString & specifiedProvider )
182  {
183  QString key = specifiedProvider.isEmpty() ? providerKey : specifiedProvider;
184  this->vectorLayerAdded( vectorLayerPath, baseName, key );
185  }
186  );
190  // Raster
192  this, [ = ]( const QString & uri, const QString & baseName, const QString & providerKey )
193  {
194  addRasterLayer( uri, baseName, providerKey );
195  } );
198  // Mesh
200  // Vector tile
202  // Point Cloud
204  // Virtual
207  // Common
210 
211  // Message
212  connect( dlg, &QgsAbstractDataSourceWidget::pushMessage, this, [ = ]( const QString & title, const QString & message, const Qgis::MessageLevel level )
213  {
214  mMessageBar->pushMessage( title, message, level );
215  } );
216 }
217 
219 {
220  ui->mOptionsStackedWidget->currentWidget()->show();
222  resizeAlltabs( ui->mOptionsStackedWidget->currentIndex() );
223 }
MessageLevel
Level for messages This will be used both for message log and message bar in application.
Definition: qgis.h:105
Abstract base Data Source Widget to create connections and add layers This class provides common func...
void addPointCloudLayer(const QString &url, const QString &baseName, const QString &providerKey)
Emitted when a point cloud layer has been selected for addition.
void setMapCanvas(const QgsMapCanvas *mapCanvas)
Store a pointer to the map canvas to retrieve extent and CRS Used to select an appropriate CRS and po...
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 messag...
void replaceVectorLayer(const QString &oldId, const QString &source, const QString &name, const QString &provider)
Emitted when a layer needs to be replaced.
void connectionsChanged()
Emitted when the provider's connections have changed This signal is normally forwarded the app and us...
void addRasterLayers(const QStringList &layersList)
Emitted when one or more GDAL supported layers are selected for addition.
void addMeshLayer(const QString &url, const QString &baseName, const QString &providerKey)
Emitted when a mesh layer has been selected for addition.
void addRasterLayer(const QString &rasterLayerPath, const QString &baseName, const QString &providerKey)
Emitted when a raster layer has been selected for addition.
virtual void refresh()
Triggered when the provider's connections need to be refreshed The default implementation does nothin...
void setBrowserModel(QgsBrowserModel *model)
Sets a browser model to use with the widget.
void progressMessage(QString message)
Emitted when a progress dialog is shown by the provider dialog.
void addVectorLayers(const QStringList &layerList, const QString &encoding, const QString &dataSourceType)
Emitted when one or more OGR supported layers are selected for addition.
void addVectorLayer(const QString &uri, const QString &layerName, const QString &providerKey=QString())
Emitted when a vector layer has been selected for addition.
void addDatabaseLayers(const QStringList &paths, const QString &providerKey)
Emitted when a DB layer has been selected for addition.
void addVectorTileLayer(const QString &url, const QString &baseName)
Emitted when a vector tile layer has been selected for addition.
virtual void reset()
Called when this source select widget is being shown in a "new and clean" dialog.
The QgsBrowserDockWidget class.
void refresh()
Refresh browser view model (and view)
void connectionsChanged()
Connections changed in the browser.
void handleDropUriList(const QgsMimeDataUtils::UriList &)
Emitted when drop uri list needs to be handled.
void updateProjectHome()
Update project home directory.
void openFile(const QString &fileName, const QString &fileTypeHint=QString())
Emitted when a file needs to be opened.
A model for showing available data sources and other items in a structured tree.
The QgsDataSourceManagerDialog class embeds the browser panel and all the provider dialogs.
void reset()
Resets the interface of the datasource manager after reopening the dialog.
void refresh()
Refresh the browser view.
void addVectorLayers(const QStringList &layerQStringList, const QString &enc, const QString &dataSourceType)
Emitted when a one or more layer were selected for addition: for signal forwarding to QgisApp.
void openFile(const QString &fileName, const QString &fileTypeHint=QString())
Emitted when a file needs to be opened.
void addMeshLayer(const QString &uri, const QString &baseName, const QString &providerKey)
Emitted when a mesh layer was selected for addition: for signal forwarding to QgisApp.
QgsMessageBar * messageBar() const
Returns the dialog's message bar.
void addPointCloudLayer(const QString &pointCloudLayerPath, const QString &baseName, const QString &providerKey)
Emitted when a point cloud layer was selected for addition: for signal forwarding to QgisApp.
QgsDataSourceManagerDialog(QgsBrowserGuiModel *browserModel, QWidget *parent=nullptr, QgsMapCanvas *canvas=nullptr, Qt::WindowFlags fl=QgsGuiUtils::ModalDialogFlags)
QgsDataSourceManagerDialog constructor.
void rasterLayersAdded(const QStringList &layersList)
One or more raster layer were added: for signal forwarding to QgisApp.
void setPreviousPage()
Reset current page to previously selected page.
void addVectorLayer(const QString &vectorLayerPath, const QString &baseName, const QString &providerKey)
Emitted when a vector layer was selected for addition: for signal forwarding to QgisApp.
void showStatusMessage(const QString &message)
Emitted when a status message needs to be shown: for signal forwarding to QgisApp.
void showEvent(QShowEvent *event) override
void replaceSelectedVectorLayer(const QString &oldId, const QString &uri, const QString &layerName, const QString &provider)
Replace the selected layer by a vector layer defined by uri, layer name, data source uri.
void openPage(const QString &pageName)
Open a given page in the dialog.
void connectionsChanged()
Emitted when a connection has changed inside the provider dialogs This signal is normally forwarded t...
void vectorLayersAdded(const QStringList &layerQStringList, const QString &enc, const QString &dataSourceType)
One or more vector layer were added: for signal forwarding to QgisApp.
void addDatabaseLayers(const QStringList &layerPathList, const QString &providerKey)
Emitted when a DB layer was selected for addition: for signal forwarding to QgisApp.
void handleDropUriList(const QgsMimeDataUtils::UriList &)
Emitted when drop uri list needs to be handled from the browser.
void addVectorTileLayer(const QString &uri, const QString &baseName)
Emitted when a vector tile layer was selected for addition: for signal forwarding to QgisApp.
void rasterLayerAdded(QString const &uri, QString const &baseName, QString const &providerKey)
A raster layer was added: for signal forwarding to QgisApp.
void providerDialogsRefreshRequested()
One or more provider connections have changed and the dialogs should be refreshed.
void updateProjectHome()
Update project home directory.
void setCurrentPage(int index)
Sync current page with the leftbar list.
void addRasterLayers(const QStringList &layersList)
Emitted when a one or more layer were selected for addition: for signal forwarding to QgisApp.
void addRasterLayer()
Emitted when the user wants to select a raster layer: for signal forwarding to QgisApp.
void vectorLayerAdded(const QString &vectorLayerPath, const QString &baseName, const QString &providerKey)
A vector layer was added: for signal forwarding to QgisApp.
static QgsSourceSelectProviderRegistry * sourceSelectProviderRegistry()
Returns the global source select provider registry, used for managing all known source select widget ...
Definition: qgsgui.cpp:86
Map canvas is a class for displaying all GIS data types on a canvas.
Definition: qgsmapcanvas.h:86
A bar for displaying non-blocking messages to the user.
Definition: qgsmessagebar.h:61
void pushMessage(const QString &text, Qgis::MessageLevel level=Qgis::MessageLevel::Info, int duration=-1)
A convenience method for pushing a message with the specified text to the bar.
static void logMessage(const QString &message, const QString &tag=QString(), Qgis::MessageLevel level=Qgis::MessageLevel::Warning, bool notifyUser=true)
Adds a message to the log instance (and creates it if necessary).
A base dialog for options and properties dialogs that offers vertical tabs.
void resizeAlltabs(int index)
Resizes all tabs when the dialog is resized.
void restoreOptionsBaseUi(const QString &title=QString())
Restore the base ui.
void initOptionsBase(bool restoreUi=true, const QString &title=QString())
Set up the base ui connections for vertical tabs.
void showEvent(QShowEvent *e) override
QList< QgsSourceSelectProvider * > providers()
Gets list of available providers.
This is the interface for those who want to add entries to the QgsDataSourceManagerDialog.