QGIS API Documentation 3.40.0-Bratislava (b56115d8743)
|
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, Qgis::LayerType layerType=Qgis::LayerType::Vector, QWidget *parent=nullptr) | |
Constructs a QgsDataSourceSelectDialog, optionally filtering by layer type. | |
void | expandPath (const QString &path, bool selectPath=false) |
Expands out a file path in the view. | |
void | setCaseSensitive (bool caseSensitive) |
Sets filter case sensitivity. | |
void | setDescription (const QString &description) |
Sets a description label. | |
void | setFilter () |
Apply filter to the model. | |
void | setFilterSyntax (QAction *) |
Sets filter syntax. | |
void | setLayerTypeFilter (Qgis::LayerType layerType) |
Sets layer type filter to layerType and activates the filtering. | |
void | showFilterWidget (bool visible) |
Show/hide filter widget. | |
QgsMimeDataUtils::Uri | uri () const |
Returns the (possibly invalid) uri of the selected data source. | |
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 169 of file qgsdatasourceselectdialog.h.
QgsDataSourceSelectDialog::QgsDataSourceSelectDialog | ( | QgsBrowserGuiModel * | browserModel = nullptr , |
bool | setFilterByLayerType = false , |
||
Qgis::LayerType | layerType = Qgis::LayerType::Vector , |
||
QWidget * | parent = nullptr |
||
) |
Constructs a QgsDataSourceSelectDialog, optionally filtering by layer type.
browserModel | an existing browser model (typically from app), if nullptr an 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 374 of file qgsdatasourceselectdialog.cpp.
void QgsDataSourceSelectDialog::expandPath | ( | const QString & | path, |
bool | selectPath = false |
||
) |
Expands out a file path in the view.
The path must correspond to a valid directory existing on the file system.
Since QGIS 3.38 the selectPath argument can be used to automatically select the path too.
Definition at line 410 of file qgsdatasourceselectdialog.cpp.
void QgsDataSourceSelectDialog::setCaseSensitive | ( | bool | caseSensitive | ) |
Sets filter case sensitivity.
Definition at line 430 of file qgsdatasourceselectdialog.cpp.
void QgsDataSourceSelectDialog::setDescription | ( | const QString & | description | ) |
Sets a description label.
description | a description string |
Definition at line 405 of file qgsdatasourceselectdialog.cpp.
void QgsDataSourceSelectDialog::setFilter | ( | ) |
Apply filter to the model.
Definition at line 435 of file qgsdatasourceselectdialog.cpp.
void QgsDataSourceSelectDialog::setFilterSyntax | ( | QAction * | syntax | ) |
Sets filter syntax.
Definition at line 425 of file qgsdatasourceselectdialog.cpp.
void QgsDataSourceSelectDialog::setLayerTypeFilter | ( | Qgis::LayerType | layerType | ) |
Sets layer type filter to layerType and activates the filtering.
Definition at line 400 of file qgsdatasourceselectdialog.cpp.
void QgsDataSourceSelectDialog::showFilterWidget | ( | bool | visible | ) |
Show/hide filter widget.
Definition at line 420 of file qgsdatasourceselectdialog.cpp.
QgsMimeDataUtils::Uri QgsDataSourceSelectDialog::uri | ( | ) | const |
Returns the (possibly invalid) uri of the selected data source.
Definition at line 415 of file qgsdatasourceselectdialog.cpp.