QgsDataSourceManagerDialog class
The QgsDataSourceManagerDialog class embeds the browser panel and all the provider dialogs.
Contents
The dialog does not handle layer addition directly but emits signals that need to be forwarded to the QGIS application to be handled.
Base classes
- class QgsOptionsDialogBase
- A base dialog for options and properties dialogs that offers vertical tabs.
Constructors, destructors, conversion operators
- QgsDataSourceManagerDialog(QgsBrowserModel* browserModel, QWidget* parent = nullptr, QgsMapCanvas* canvas = nullptr, Qt::WindowFlags fl = QgsGuiUtils::ModalDialogFlags) explicit
- QgsDataSourceManagerDialog constructor.
Public functions
- void openPage(const QString& pageName)
- Open a given page in the dialog.
Signals
- void addDatabaseLayers(const QStringList& layerPathList, const QString& providerKey)
- Emitted when a DB layer was selected for addition: for signal forwarding to QgisApp.
- 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.
- void addRasterLayer(const QString& uri, const QString& baseName, const QString& providerKey)
- Emitted when a raster layer was 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 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 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 connectionsChanged()
- Emitted when a connection has changed inside the provider dialogs This signal is normally forwarded to the application to notify other browsers that they need to refresh their connections list.
-
void handleDropUriList(const QgsMimeDataUtils::
UriList&) - Emitted when drop uri list needs to be handled from the browser.
- void openFile(const QString& fileName, const QString& fileTypeHint = QString())
- Emitted when a file needs to be opened.
- void providerDialogsRefreshRequested()
- One or more provider connections have changed and the dialogs should be refreshed.
- 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 showStatusMessage(const QString& message)
- Emitted when a status message needs to be shown: for signal forwarding to QgisApp.
- void updateProjectHome()
- Update project home directory.
Public slots
- void rasterLayerAdded(QString const& uri, QString const& baseName, QString const& providerKey)
- A raster layer was added: for signal forwarding to QgisApp TODO: use this with an internal source select dialog instead of forwarding the whole raster selection to app.
- void refresh()
- Refresh the browser view.
- void setCurrentPage(int index)
- Sync current page with the leftbar list.
- void setPreviousPage()
- Reset current page to previously selected page.
- void vectorLayerAdded(const QString& vectorLayerPath, const QString& baseName, const QString& providerKey)
- A vector layer was added: for signal forwarding to QgisApp.
- void vectorLayersAdded(const QStringList& layerQStringList, const QString& enc, const QString& dataSourceType)
- One or more vector layer were added: for signal forwarding to QgisApp.
Function documentation
QgsDataSourceManagerDialog:: QgsDataSourceManagerDialog(QgsBrowserModel* browserModel,
QWidget* parent = nullptr,
QgsMapCanvas* canvas = nullptr,
Qt::WindowFlags fl = QgsGuiUtils::ModalDialogFlags) explicit
QgsDataSourceManagerDialog constructor.
| Parameters | |
|---|---|
| browserModel | instance of the (shared) browser model |
| parent | the object |
| canvas | a pointer to the map canvas |
| fl | window flags |
void QgsDataSourceManagerDialog:: openPage(const QString& pageName)
Open a given page in the dialog.
| Parameters | |
|---|---|
| pageName | the page name, usually the provider name or "browser" (for the browser panel) or "ogr" (vector layers) or "raster" (raster layers) |
void QgsDataSourceManagerDialog:: addMeshLayer(const QString& uri,
const QString& baseName,
const QString& providerKey) signal
Emitted when a mesh layer was selected for addition: for signal forwarding to QgisApp.