The QgsDataSourceSelectDialog class embeds the browser view to select an existing data source. More...

#include <qgsdatasourceselectdialog.h>

Inheritance diagram for QgsDataSourceSelectDialog:

Public Member Functions
	QgsDataSourceSelectDialog (QgsBrowserModel browserModel=nullptr, bool setFilterByLayerType=false, const QgsMapLayer::LayerType &layerType=QgsMapLayer::LayerType::VectorLayer, QWidget parent=nullptr)
	Constructs a QgsDataSourceSelectDialog, optionally filtering by layer type. More...

	~QgsDataSourceSelectDialog () override

void	setCaseSensitive (bool caseSensitive)
	Sets filter case sensitivity. More...

void	setFilter ()
	Apply filter to the model. More...

void	setFilterSyntax (QAction *)
	Sets filter syntax. More...

void	setLayerTypeFilter (QgsMapLayer::LayerType layerType)
	Sets layer type filter to layerType and activates the filtering. More...

void	showEvent (QShowEvent *e) override
	Scroll to last selected index and expand it's children. 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...

Detailed Description

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.

Since: QGIS 3.6

Definition at line 44 of file qgsdatasourceselectdialog.h.

Constructor & Destructor Documentation

◆ QgsDataSourceSelectDialog()

QgsDataSourceSelectDialog::QgsDataSourceSelectDialog	(	QgsBrowserModel *	browserModel = `nullptr`,
		bool	setFilterByLayerType = `false`,
		const QgsMapLayer::LayerType &	layerType = `QgsMapLayer::LayerType::VectorLayer`,
		QWidget *	parent = `nullptr`
	)

Constructs a QgsDataSourceSelectDialog, optionally filtering by layer type.

Parameters

browserModel	an existing browser model (typically from app), if null 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 27 of file qgsdatasourceselectdialog.cpp.