| QGIS API Documentation
    3.18.1-Zürich (202f1bf7e5)
    | 
The QgsDataSourceSelectDialog class embeds the browser view to select an existing data source. More...
#include <qgsdatasourceselectdialog.h>

| Public Member Functions | |
| QgsDataSourceSelectDialog (QgsBrowserGuiModel *browserModel=nullptr, bool setFilterByLayerType=false, QgsMapLayerType layerType=QgsMapLayerType::VectorLayer, QWidget *parent=nullptr) | |
| Constructs a QgsDataSourceSelectDialog, optionally filtering by layer type.  More... | |
| void | setCaseSensitive (bool caseSensitive) | 
| Sets filter case sensitivity.  More... | |
| void | setDescription (const QString &description) | 
| Sets a description label.  More... | |
| void | setFilter () | 
| Apply filter to the model.  More... | |
| void | setFilterSyntax (QAction *) | 
| Sets filter syntax.  More... | |
| void | setLayerTypeFilter (QgsMapLayerType layerType) | 
| Sets layer type filter to layerType and activates the filtering.  More... | |
| void | showFilterWidget (bool visible) | 
| Show/hide filter widget.  More... | |
| QgsMimeDataUtils::Uri | uri () const | 
| Returns the (possibly invalid) uri of the selected data source.  More... | |
The QgsDataSourceSelectDialog class embeds the browser view to select an existing data source.
By default any layer type can be chosen, the valid layer type can be restricted by setting a layer type filter with setLayerTypeFilter(layerType) or by activating the filter directly from the constructor.
To retrieve the selected data source, uri() can be called and it will return a (possibly invalid) QgsMimeDataUtils::Uri.
Definition at line 152 of file qgsdatasourceselectdialog.h.
| QgsDataSourceSelectDialog::QgsDataSourceSelectDialog | ( | QgsBrowserGuiModel * | browserModel = nullptr, | 
| bool | setFilterByLayerType = false, | ||
| QgsMapLayerType | layerType = QgsMapLayerType::VectorLayer, | ||
| QWidget * | parent = nullptr | ||
| ) | 
Constructs a QgsDataSourceSelectDialog, optionally filtering by layer type.
| browserModel | an existing browser model (typically from app), if nullptran instance will be created | 
| setFilterByLayerType | activates filtering by layer type | 
| layerType | sets the layer type filter, this is in effect only if filtering by layer type is also active | 
| parent | the object | 
Definition at line 312 of file qgsdatasourceselectdialog.cpp.
| void QgsDataSourceSelectDialog::setCaseSensitive | ( | bool | caseSensitive | ) | 
Sets filter case sensitivity.
Definition at line 363 of file qgsdatasourceselectdialog.cpp.
| void QgsDataSourceSelectDialog::setDescription | ( | const QString & | description | ) | 
Sets a description label.
| description | a description string | 
Definition at line 343 of file qgsdatasourceselectdialog.cpp.
| void QgsDataSourceSelectDialog::setFilter | ( | ) | 
Apply filter to the model.
Definition at line 368 of file qgsdatasourceselectdialog.cpp.
| void QgsDataSourceSelectDialog::setFilterSyntax | ( | QAction * | syntax | ) | 
Sets filter syntax.
Definition at line 358 of file qgsdatasourceselectdialog.cpp.
| void QgsDataSourceSelectDialog::setLayerTypeFilter | ( | QgsMapLayerType | layerType | ) | 
Sets layer type filter to layerType and activates the filtering.
Definition at line 338 of file qgsdatasourceselectdialog.cpp.
| void QgsDataSourceSelectDialog::showFilterWidget | ( | bool | visible | ) | 
Show/hide filter widget.
Definition at line 353 of file qgsdatasourceselectdialog.cpp.
| QgsMimeDataUtils::Uri QgsDataSourceSelectDialog::uri | ( | ) | const | 
Returns the (possibly invalid) uri of the selected data source.
Definition at line 348 of file qgsdatasourceselectdialog.cpp.