QGIS API Documentation  3.13.0-Master (740be229cb)
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 {
39  ui->setupUi( this );
40  ui->verticalLayout_2->setSpacing( 6 );
41  ui->verticalLayout_2->setMargin( 0 );
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" ), browserModel, 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 ( const auto &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::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 
135 void QgsDataSourceManagerDialog::rasterLayerAdded( const QString &uri, const QString &baseName, const QString &providerKey )
136 {
137  emit addRasterLayer( uri, baseName, providerKey );
138 }
139 
140 void QgsDataSourceManagerDialog::vectorLayerAdded( const QString &vectorLayerPath, const QString &baseName, const QString &providerKey )
141 {
142  emit addVectorLayer( vectorLayerPath, baseName, providerKey );
143 }
144 
145 void QgsDataSourceManagerDialog::vectorLayersAdded( const QStringList &layerQStringList, const QString &enc, const QString &dataSourceType )
146 {
147  emit addVectorLayers( layerQStringList, enc, dataSourceType );
148 }
149 
150 
151 void QgsDataSourceManagerDialog::addProviderDialog( QgsAbstractDataSourceWidget *dlg, const QString &providerKey, const QString &providerName, const QIcon &icon, const QString &toolTip )
152 {
153  mPageNames.append( providerKey );
154  ui->mOptionsStackedWidget->addWidget( dlg );
155  QListWidgetItem *layerItem = new QListWidgetItem( providerName, ui->mOptionsListWidget );
156  layerItem->setToolTip( toolTip.isEmpty() ? tr( "Add %1 layer" ).arg( providerName ) : toolTip );
157  layerItem->setIcon( icon );
158  // Set crs and extent from canvas
159  if ( mMapCanvas )
160  {
161  dlg->setMapCanvas( mMapCanvas );
162  }
163  connect( dlg, &QgsAbstractDataSourceWidget::rejected, this, &QgsDataSourceManagerDialog::reject );
164  connect( dlg, &QgsAbstractDataSourceWidget::accepted, this, &QgsDataSourceManagerDialog::accept );
165  makeConnections( dlg, providerKey );
166 }
167 
168 void QgsDataSourceManagerDialog::makeConnections( QgsAbstractDataSourceWidget *dlg, const QString &providerKey )
169 {
170  // DB
171  connect( dlg, SIGNAL( addDatabaseLayers( QStringList const &, QString const & ) ),
172  this, SIGNAL( addDatabaseLayers( QStringList const &, QString const & ) ) );
173  connect( dlg, SIGNAL( progressMessage( QString ) ),
174  this, SIGNAL( showStatusMessage( QString ) ) );
175  // Vector
176  connect( dlg, &QgsAbstractDataSourceWidget::addVectorLayer, this, [ = ]( const QString & vectorLayerPath, const QString & baseName, const QString & specifiedProvider )
177  {
178  QString key = specifiedProvider.isEmpty() ? providerKey : specifiedProvider;
179  this->vectorLayerAdded( vectorLayerPath, baseName, key );
180  }
181  );
184  connect( dlg, SIGNAL( connectionsChanged() ), this, SIGNAL( connectionsChanged() ) );
185  // Raster
186  connect( dlg, SIGNAL( addRasterLayer( QString const &, QString const &, QString const & ) ),
187  this, SIGNAL( addRasterLayer( QString const &, QString const &, QString const & ) ) );
188  // Mesh
190 
191  // Virtual
192  connect( dlg, SIGNAL( replaceVectorLayer( QString, QString, QString, QString ) ),
193  this, SIGNAL( replaceSelectedVectorLayer( QString, QString, QString, QString ) ) );
194  // Common
195  connect( dlg, SIGNAL( connectionsChanged() ), this, SIGNAL( connectionsChanged() ) );
196  connect( this, SIGNAL( providerDialogsRefreshRequested() ), dlg, SLOT( refresh() ) );
197 }
198 
200 {
201  ui->mOptionsStackedWidget->currentWidget()->show();
203  resizeAlltabs( ui->mOptionsStackedWidget->currentIndex() );
204 }
205 
void rasterLayerAdded(QString const &uri, QString const &baseName, QString const &providerKey)
A raster layer was added: for signal forwarding to QgisApp.
void connectionsChanged()
Emitted when a connection has changed inside the provider dialogs This signal is normally forwarded t...
void showEvent(QShowEvent *event) override
Abstract base Data Source Widget to create connections and add layers This class provides common func...
QgsMessageBar * messageBar() const
Returns the dialog&#39;s message bar.
void refresh()
Refresh the browser view.
void initOptionsBase(bool restoreUi=true, const QString &title=QString())
Set up the base ui connections for vertical tabs.
QList< QgsSourceSelectProvider * > providers()
Gets list of available providers.
static QgsSourceSelectProviderRegistry * sourceSelectProviderRegistry()
Returns the global source select provider registry, used for managing all known source select widget ...
Definition: qgsgui.cpp:78
A bar for displaying non-blocking messages to the user.
Definition: qgsmessagebar.h:45
void restoreOptionsBaseUi(const QString &title=QString())
Restore the base ui.
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.
A model for showing available data sources and other items in a structured tree.
void providerDialogsRefreshRequested()
One or more provider connections have changed and the dialogs should be refreshed.
void setPreviousPage()
Reset current page to previously selected page.
void addMeshLayer(const QString &url, const QString &baseName, const QString &providerKey)
Emitted when a mesh layer has been selected for addition.
void handleDropUriList(const QgsMimeDataUtils::UriList &)
Emitted when drop uri list needs to be handled from the browser.
Map canvas is a class for displaying all GIS data types on a canvas.
Definition: qgsmapcanvas.h:78
void resizeAlltabs(int index)
Resizes all tabs when the dialog is resized.
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.
static void logMessage(const QString &message, const QString &tag=QString(), Qgis::MessageLevel level=Qgis::Warning, bool notifyUser=true)
Adds a message to the log instance (and creates it if necessary).
void openPage(const QString &pageName)
Open a given page in the dialog.
void updateProjectHome()
Update project home directory.
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...
A base dialog for options and properties dialogs that offers vertical tabs.
void handleDropUriList(const QgsMimeDataUtils::UriList &)
Emitted when drop uri list needs to be handled.
void showEvent(QShowEvent *e) override
void addVectorLayer(const QString &uri, const QString &layerName, const QString &providerKey=QString())
Emitted when a vector layer has been selected for addition.
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.
The QgsBrowserDockWidget class.
void vectorLayersAdded(const QStringList &layerQStringList, const QString &enc, const QString &dataSourceType)
One or more vector layer were added: for signal forwarding to QgisApp.
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 reset()
Resets the interface of the datasource manager after reopening the dialog.
void updateProjectHome()
Update project home directory.
void showStatusMessage(const QString &message)
Emitted when a status message needs to be shown: for signal forwarding to QgisApp.
void addVectorLayers(const QStringList &layerList, const QString &encoding, const QString &dataSourceType)
Emitted when one or more OGR supported layers are selected for addition.
void openFile(const QString &fileName, const QString &fileTypeHint=QString())
Emitted when a file needs to be opened.
void openFile(const QString &fileName, const QString &fileTypeHint=QString())
Emitted when a file needs to be opened.
virtual void reset()
Called when this source select widget is being shown in a "new and clean" dialog. ...
void connectionsChanged()
Connections changed in the browser.
void refresh()
Refresh browser view model (and view)
void addDatabaseLayers(const QStringList &layerPathList, const QString &providerKey)
Emitted when a DB layer was selected for addition: for signal forwarding to QgisApp.
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...
QgsDataSourceManagerDialog(QgsBrowserGuiModel *browserModel, QWidget *parent=nullptr, QgsMapCanvas *canvas=nullptr, Qt::WindowFlags fl=QgsGuiUtils::ModalDialogFlags)
QgsDataSourceManagerDialog constructor.
void setCurrentPage(int index)
Sync current page with the leftbar list.