QGIS API Documentation 3.34.0-Prizren (ffbdd678812)
Loading...
Searching...
No Matches
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"
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#include "qgsbrowserwidget.h"
33
34QgsDataSourceManagerDialog::QgsDataSourceManagerDialog( QgsBrowserGuiModel *browserModel, QWidget *parent, QgsMapCanvas *canvas, Qt::WindowFlags fl )
35 : QgsOptionsDialogBase( tr( "Data Source Manager" ), parent, fl )
36 , ui( new Ui::QgsDataSourceManagerDialog )
37 , mPreviousRow( -1 )
38 , mMapCanvas( canvas )
39 , mBrowserModel( browserModel )
40{
41 ui->setupUi( this );
42 ui->verticalLayout_2->setSpacing( 6 );
43 ui->verticalLayout_2->setContentsMargins( 0, 0, 0, 0 );
44
45 mMessageBar = new QgsMessageBar( this );
46 mMessageBar->setSizePolicy( QSizePolicy::MinimumExpanding, QSizePolicy::Fixed );
47 static_cast<QVBoxLayout *>( layout() )->insertWidget( 0, mMessageBar );
48
49 // QgsOptionsDialogBase handles saving/restoring of geometry, splitter and current tab states,
50 // switching vertical tabs between icon/text to icon-only modes (splitter collapsed to left),
51 // and connecting QDialogButtonBox's accepted/rejected signals to dialog's accept/reject slots
52 initOptionsBase( false );
53
54 // Bind list index to the stacked dialogs
55 connect( ui->mOptionsListWidget, &QListWidget::currentRowChanged, this, &QgsDataSourceManagerDialog::setCurrentPage );
56
57 // BROWSER Add the browser widget to the first stacked widget page
58 mBrowserWidget = new QgsBrowserDockWidget( QStringLiteral( "Browser" ), mBrowserModel, this );
59 mBrowserWidget->setFeatures( QDockWidget::NoDockWidgetFeatures );
60 mBrowserWidget->setTitleBarWidget( new QWidget( mBrowserWidget ) );
61
62 QWidget *browserWidgetWrapper = new QWidget( this );
63 browserWidgetWrapper->setLayout( new QVBoxLayout( browserWidgetWrapper ) );
64 browserWidgetWrapper->layout()->addWidget( mBrowserWidget );
65 QDialogButtonBox *browserButtonBox = new QDialogButtonBox( QDialogButtonBox::StandardButton::Close | QDialogButtonBox::StandardButton::Help, browserWidgetWrapper );
66 browserWidgetWrapper->layout()->addWidget( browserButtonBox );
67
68 connect( browserButtonBox, &QDialogButtonBox::helpRequested, this, [ = ]
69 {
70 QgsHelp::openHelp( QStringLiteral( "managing_data_source/opening_data.html#the-browser-panel" ) );
71 } );
72 connect( browserButtonBox, &QDialogButtonBox::rejected, this, &QgsDataSourceManagerDialog::reject );
73
74 ui->mOptionsStackedWidget->addWidget( browserWidgetWrapper );
75 mPageProviderKeys.append( QStringLiteral( "browser" ) );
76 mPageProviderNames.append( QStringLiteral( "browser" ) );
77
78 // Forward all browser signals
83
84 // Add registered source select dialogs
85 const QList<QgsSourceSelectProvider *> sourceSelectProviders = QgsGui::sourceSelectProviderRegistry()->providers( );
86 for ( QgsSourceSelectProvider *provider : sourceSelectProviders )
87 {
88 QgsAbstractDataSourceWidget *dlg = provider->createDataSourceWidget( this );
89 if ( !dlg )
90 {
91 QgsMessageLog::logMessage( tr( "Cannot get %1 select dialog from source select provider %2." ).arg( provider->name(), provider->providerKey() ), QStringLiteral( "DataSourceManager" ), Qgis::MessageLevel::Critical );
92 continue;
93 }
94 addProviderDialog( dlg, provider->providerKey(), provider->name(), provider->text(), provider->icon( ), provider->toolTip( ) );
95 }
96
97 connect( QgsGui::sourceSelectProviderRegistry(), &QgsSourceSelectProviderRegistry::providerAdded, this, [ = ]( const QString & name )
98 {
99 if ( QgsSourceSelectProvider *provider = QgsGui::sourceSelectProviderRegistry()->providerByName( name ) )
100 {
101 QgsAbstractDataSourceWidget *dlg = provider->createDataSourceWidget( this );
102 if ( !dlg )
103 {
104 QgsMessageLog::logMessage( tr( "Cannot get %1 select dialog from source select provider %2." ).arg( provider->name(), provider->providerKey() ), QStringLiteral( "DataSourceManager" ), Qgis::MessageLevel::Critical );
105 return;
106 }
107 addProviderDialog( dlg, provider->providerKey(), provider->name(), provider->text(), provider->icon( ), provider->toolTip( ) );
108 }
109 } );
110
111 connect( QgsGui::sourceSelectProviderRegistry(), &QgsSourceSelectProviderRegistry::providerRemoved, this, [ = ]( const QString & name )
112 {
113 removeProviderDialog( name );
114 } );
115
116 restoreOptionsBaseUi( tr( "Data Source Manager" ) );
117}
118
123
124void QgsDataSourceManagerDialog::openPage( const QString &pageName )
125{
126 // TODO -- this is actually using provider keys, not provider names!
127 const int pageIdx = mPageProviderKeys.indexOf( pageName );
128 if ( pageIdx != -1 )
129 {
130 QTimer::singleShot( 0, this, [ = ] { setCurrentPage( pageIdx ); } );
131 }
132}
133
135{
136 return mMessageBar;
137}
138
140{
141 raise();
142 setWindowState( windowState() & ~Qt::WindowMinimized );
143 activateWindow();
144}
145
147{
148 mPreviousRow = ui->mOptionsStackedWidget->currentIndex();
149 ui->mOptionsStackedWidget->setCurrentIndex( index );
150 setWindowTitle( tr( "Data Source Manager | %1" ).arg( ui->mOptionsListWidget->currentItem()->text() ) );
151 resizeAlltabs( index );
152}
153
155{
156 const int prevPage = mPreviousRow != -1 ? mPreviousRow : 0;
157 setCurrentPage( prevPage );
158}
159
165
167{
168 const int pageCount = ui->mOptionsStackedWidget->count();
169 for ( int i = 0; i < pageCount; ++i )
170 {
171 QWidget *widget = ui->mOptionsStackedWidget->widget( i );
172 QgsAbstractDataSourceWidget *dataSourceWidget = qobject_cast<QgsAbstractDataSourceWidget *>( widget );
173 if ( dataSourceWidget )
174 dataSourceWidget->reset();
175 }
176}
177
178void QgsDataSourceManagerDialog::rasterLayersAdded( const QStringList &layersList )
179{
180 emit addRasterLayers( layersList );
181}
182
183void QgsDataSourceManagerDialog::vectorLayersAdded( const QStringList &layerQStringList, const QString &enc, const QString &dataSourceType )
184{
185 emit addVectorLayers( layerQStringList, enc, dataSourceType );
186}
187
188void QgsDataSourceManagerDialog::addProviderDialog( QgsAbstractDataSourceWidget *dlg, const QString &providerKey, const QString &providerName, const QString &text, const QIcon &icon, const QString &toolTip )
189{
190 mPageProviderKeys.append( providerKey );
191 mPageProviderNames.append( providerName );
192 ui->mOptionsStackedWidget->addWidget( dlg );
193 QListWidgetItem *layerItem = new QListWidgetItem( text, ui->mOptionsListWidget );
194 layerItem->setData( Qt::UserRole, providerName );
195 layerItem->setToolTip( toolTip.isEmpty() ? tr( "Add %1 layer" ).arg( text ) : toolTip );
196 layerItem->setIcon( icon );
197 // Set crs and extent from canvas
198 if ( mMapCanvas )
199 {
200 dlg->setMapCanvas( mMapCanvas );
201 }
202 dlg->setBrowserModel( mBrowserModel );
203
204 connect( dlg, &QgsAbstractDataSourceWidget::rejected, this, &QgsDataSourceManagerDialog::reject );
205 connect( dlg, &QgsAbstractDataSourceWidget::accepted, this, &QgsDataSourceManagerDialog::accept );
206 makeConnections( dlg, providerKey );
207}
208
209void QgsDataSourceManagerDialog::removeProviderDialog( const QString &providerName )
210{
211 const int pageIdx = mPageProviderNames.indexOf( providerName );
212 if ( pageIdx != -1 )
213 {
214 ui->mOptionsStackedWidget->removeWidget( ui->mOptionsStackedWidget->widget( pageIdx ) );
215 mPageProviderKeys.removeAt( pageIdx );
216 mPageProviderNames.removeAt( pageIdx );
217 ui->mOptionsListWidget->removeItemWidget( ui->mOptionsListWidget->item( pageIdx ) );
218 }
219}
220
221void QgsDataSourceManagerDialog::makeConnections( QgsAbstractDataSourceWidget *dlg, const QString &providerKey )
222{
223 // DB
228
229 connect( dlg, &QgsAbstractDataSourceWidget::addLayer, this, [ = ]( Qgis::LayerType type, const QString & url, const QString & baseName, const QString & providerKey )
230 {
231 Q_UNUSED( url )
232 Q_UNUSED( baseName )
233 Q_UNUSED( providerKey )
234
235 switch ( type )
236 {
245 // for compatibility with older API, we ignore these signals and rely on the older granular signals (eg "addVectorLayer").
246 // otherwise we will be emitting double signals for the old/new signal for these layer types
247 break;
248
250 emit addLayer( type, url, baseName, providerKey );
251 break;
252 }
253 } );
254
255 // Vector
257 connect( dlg, &QgsAbstractDataSourceWidget::addVectorLayer, this, [ = ]( const QString & vectorLayerPath, const QString & baseName, const QString & specifiedProvider )
258 {
259 const QString key = specifiedProvider.isEmpty() ? providerKey : specifiedProvider;
260 emit addLayer( Qgis::LayerType::Vector, vectorLayerPath, baseName, key );
261 }
262 );
267
268 // Raster
270 connect( dlg, &QgsAbstractDataSourceWidget::addRasterLayer, this, [ = ]( const QString & rasterLayerPath, const QString & baseName, const QString & providerKey )
271 {
272 emit addLayer( Qgis::LayerType::Raster, rasterLayerPath, baseName, providerKey );
273 } );
277
278 // Mesh
280 connect( dlg, &QgsAbstractDataSourceWidget::addMeshLayer, this, [ = ]( const QString & url, const QString & baseName, const QString & providerKey )
281 {
282 emit addLayer( Qgis::LayerType::Mesh, url, baseName, providerKey );
283 } );
285 // Vector tile
287 connect( dlg, &QgsAbstractDataSourceWidget::addVectorTileLayer, this, [ = ]( const QString & url, const QString & baseName )
288 {
289 emit addLayer( Qgis::LayerType::VectorTile, url, baseName, QString() );
290 } );
292 // Point Cloud
294 connect( dlg, &QgsAbstractDataSourceWidget::addPointCloudLayer, this, [ = ]( const QString & url, const QString & baseName, const QString & providerKey )
295 {
296 emit addLayer( Qgis::LayerType::PointCloud, url, baseName, providerKey );
297 } );
299 // Virtual
302 // Common
305
306 // Message
307 connect( dlg, &QgsAbstractDataSourceWidget::pushMessage, this, [ = ]( const QString & title, const QString & message, const Qgis::MessageLevel level )
308 {
309 mMessageBar->pushMessage( title, message, level );
310 } );
311}
312
314{
315 ui->mOptionsStackedWidget->currentWidget()->show();
317 resizeAlltabs( ui->mOptionsStackedWidget->currentIndex() );
318}
MessageLevel
Level for messages This will be used both for message log and message bar in application.
Definition qgis.h:99
@ Critical
Critical/error message.
Definition qgis.h:102
LayerType
Types of layers that can be added to a map.
Definition qgis.h:114
@ Group
Composite group layer. Added in QGIS 3.24.
@ Plugin
Plugin based layer.
@ TiledScene
Tiled scene layer. Added in QGIS 3.34.
@ Annotation
Contains freeform, georeferenced annotations. Added in QGIS 3.16.
@ Vector
Vector layer.
@ VectorTile
Vector tile layer. Added in QGIS 3.14.
@ Mesh
Mesh layer. Added in QGIS 3.2.
@ Raster
Raster layer.
@ PointCloud
Point cloud layer. Added in QGIS 3.18.
Abstract base Data Source Widget to create connections and add layers This class provides common func...
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...
Q_DECL_DEPRECATED void addPointCloudLayer(const QString &url, const QString &baseName, const QString &providerKey)
Emitted when a point cloud layer has been selected for addition.
Q_DECL_DEPRECATED void addVectorTileLayer(const QString &url, const QString &baseName)
Emitted when a vector tile layer has been selected for addition.
Q_DECL_DEPRECATED void addRasterLayer(const QString &rasterLayerPath, const QString &baseName, const QString &providerKey)
Emitted when a raster layer has been selected for addition.
virtual void setMapCanvas(QgsMapCanvas *mapCanvas)
Sets the dialog map canvas.
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.
virtual void refresh()
Triggered when the provider's connections need to be refreshed The default implementation does nothin...
virtual void setBrowserModel(QgsBrowserModel *model)
Sets a browser model to use with the widget.
Q_DECL_DEPRECATED void addMeshLayer(const QString &url, const QString &baseName, const QString &providerKey)
Emitted when a mesh layer has been selected for addition.
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 addDatabaseLayers(const QStringList &paths, const QString &providerKey)
Emitted when a DB layer has been selected for addition.
Q_DECL_DEPRECATED void addVectorLayer(const QString &uri, const QString &layerName, const QString &providerKey=QString())
Emitted when a vector layer has been selected for addition.
virtual void reset()
Called when this source select widget is being shown in a "new and clean" dialog.
void addLayer(Qgis::LayerType type, const QString &url, const QString &baseName, const QString &providerKey)
Emitted when a layer has been selected for addition.
A dock widget containing a QgsBrowserWidget for navigating and managing data sources.
void connectionsChanged()
Connections changed in the browser.
QgsBrowserWidget * browserWidget()
Returns a pointer to the QgsBrowserWidget used by the dock widget.
void handleDropUriList(const QgsMimeDataUtils::UriList &)
Emitted when drop uri list needs to be handled.
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.
void updateProjectHome()
Update project home directory.
void refresh()
Refreshes the browser model and view.
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.
QgsMessageBar * messageBar() const
Returns the dialog's message bar.
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.
QgsDataSourceManagerDialog(QgsBrowserGuiModel *browserModel, QWidget *parent=nullptr, QgsMapCanvas *canvas=nullptr, Qt::WindowFlags fl=Qt::Window)
QgsDataSourceManagerDialog constructor.
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 activate()
Raise, unminimize and activate this window.
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 providerDialogsRefreshRequested()
One or more provider connections have changed and the dialogs should be refreshed.
void addLayer(Qgis::LayerType type, const QString &url, const QString &baseName, const QString &providerKey)
Emitted when a layer has been selected for addition.
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.
static QgsSourceSelectProviderRegistry * sourceSelectProviderRegistry()
Returns the global source select provider registry, used for managing all known source select widget ...
Definition qgsgui.cpp:104
static void openHelp(const QString &key)
Opens help topic for the given help key using default system web browser.
Definition qgshelp.cpp:38
Map canvas is a class for displaying all GIS data types on a canvas.
A bar for displaying non-blocking messages to the user.
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
void providerRemoved(const QString &name)
Emitted whenever a provider is removed from the registry.
void providerAdded(const QString &name)
Emitted whenever a provider is added to the registry.
QList< QgsSourceSelectProvider * > providers()
Gets list of available providers.
This is the interface for those who want to add entries to the QgsDataSourceManagerDialog.
#define Q_NOWARN_DEPRECATED_POP
Definition qgis.h:4916
#define Q_NOWARN_DEPRECATED_PUSH
Definition qgis.h:4915