The QgsLayerMetadataSearchWidget class offers layer metadata search and filtering. More...

#include <qgslayermetadatasearchwidget.h>

Inheritance diagram for QgsLayerMetadataSearchWidget:

[legend]

Public Slots
void	addButtonClicked () override

void	refresh () override

void	reset () override

void	updateExtentFilter (int index)
	Updates the extent filter based on the combo box current item index.

Public Slots inherited from QgsAbstractDataSourceWidget
virtual void	addButtonClicked ()
	Triggered when the add button is clicked, the add layer signal is emitted Concrete classes should implement the right behavior depending on the layer being added.

virtual bool	configureFromUri (const QString &uri)
	Configure the widget from a layer uri by selecting the layer path or connection options.

virtual void	refresh ()
	Triggered when the provider's connections need to be refreshed The default implementation does nothing.

virtual void	reset ()
	Called when this source select widget is being shown in a "new and clean" dialog.

Public Member Functions
	QgsLayerMetadataSearchWidget (QWidget *parent=nullptr, Qt::WindowFlags fl=Qt::WindowFlags(), QgsProviderRegistry::WidgetMode widgetMode=QgsProviderRegistry::WidgetMode::Standalone)
	Creates a new QgsLayerMetadataSearchWidget.

void	setMapCanvas (QgsMapCanvas *mapCanvas) override
	Sets the dialog map canvas.

Public Member Functions inherited from QgsAbstractDataSourceWidget
virtual QgsMapCanvas *	mapCanvas ()
	Returns the dialog map canvas.

virtual void	setBrowserModel (QgsBrowserModel *model)
	Sets a browser model to use with the widget.

Protected Member Functions
void	showEvent (QShowEvent *event) override

Protected Member Functions inherited from QgsAbstractDataSourceWidget
	QgsAbstractDataSourceWidget (QWidget *parent=nullptr, Qt::WindowFlags fl=QgsGuiUtils::ModalDialogFlags, QgsProviderRegistry::WidgetMode widgetMode=QgsProviderRegistry::WidgetMode::Standalone)
	Constructor.

QPushButton *	addButton () const
	Returns the add Button.

QgsBrowserModel *	browserModel ()
	Returns the associated browser model (may be `nullptr`).

void	setupButtons (QDialogButtonBox *buttonBox)
	Connect the ok and apply/add buttons to the slots.

QgsProviderRegistry::WidgetMode	widgetMode () const
	Returns the widget mode.

Additional Inherited Members
Signals inherited from QgsAbstractDataSourceWidget
void	addDatabaseLayers (const QStringList &paths, const QString &providerKey)
	Emitted when a DB layer has been selected for addition.

void	addLayer (Qgis::LayerType type, const QString &url, const QString &baseName, const QString &providerKey)
	Emitted when a layer has been selected for addition.

Q_DECL_DEPRECATED void	addMeshLayer (const QString &url, const QString &baseName, const QString &providerKey)
	Emitted when a mesh layer has been selected for addition.

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	addRasterLayer (const QString &rasterLayerPath, const QString &baseName, const QString &providerKey)
	Emitted when a raster layer has been selected for addition.

void	addRasterLayers (const QStringList &layersList)
	Emitted when one or more GDAL supported layers are 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.

void	addVectorLayers (const QStringList &layerList, const QString &encoding, const QString &dataSourceType)
	Emitted when one or more OGR supported layers are 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.

void	connectionsChanged ()
	Emitted when the provider's connections have changed This signal is normally forwarded the app and used to refresh browser items.

void	enableButtons (bool enable)
	Emitted when the ok/add buttons should be enabled/disabled.

Q_DECL_DEPRECATED void	progress (int, int)
	Emitted when a progress dialog is shown by the provider dialog.

void	progressMessage (QString message)
	Emitted when a progress dialog is shown by the provider dialog.

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 message bar.

void	replaceVectorLayer (const QString &oldId, const QString &source, const QString &name, const QString &provider)
	Emitted when a layer needs to be replaced.

Detailed Description

The QgsLayerMetadataSearchWidget class offers layer metadata search and filtering.

It is designed to be embedded in the data source manager dialog.

Since: QGIS 3.28

Definition at line 36 of file qgslayermetadatasearchwidget.h.

Constructor & Destructor Documentation

◆ QgsLayerMetadataSearchWidget()

QgsLayerMetadataSearchWidget::QgsLayerMetadataSearchWidget	(	QWidget *	parent = `nullptr`,
		Qt::WindowFlags	fl = `Qt::WindowFlags()`,
		QgsProviderRegistry::WidgetMode	widgetMode = `QgsProviderRegistry::WidgetMode::Standalone`
	)

explicit

Creates a new QgsLayerMetadataSearchWidget.

Definition at line 27 of file qgslayermetadatasearchwidget.cpp.

Member Function Documentation

◆ addButtonClicked

void QgsLayerMetadataSearchWidget::addButtonClicked ( )

overrideslot

Definition at line 202 of file qgslayermetadatasearchwidget.cpp.

◆ refresh

void QgsLayerMetadataSearchWidget::refresh ( )

overrideslot

Definition at line 197 of file qgslayermetadatasearchwidget.cpp.

◆ reset

void QgsLayerMetadataSearchWidget::reset ( )

overrideslot

Definition at line 265 of file qgslayermetadatasearchwidget.cpp.

◆ setMapCanvas()

void QgsLayerMetadataSearchWidget::setMapCanvas ( QgsMapCanvas * mapCanvas )

overridevirtual

Sets the dialog map canvas.

See also: mapCanvas()

Reimplemented from QgsAbstractDataSourceWidget.

Definition at line 164 of file qgslayermetadatasearchwidget.cpp.

◆ showEvent()

void QgsLayerMetadataSearchWidget::showEvent ( QShowEvent * event )

overrideprotected

Definition at line 271 of file qgslayermetadatasearchwidget.cpp.

◆ updateExtentFilter

void QgsLayerMetadataSearchWidget::updateExtentFilter ( int index )

slot

Updates the extent filter based on the combo box current item index.

Definition at line 176 of file qgslayermetadatasearchwidget.cpp.

The documentation for this class was generated from the following files:

/build/qgis-3.41.0+git20241122+3440c17df1d+99sid/src/gui/qgslayermetadatasearchwidget.h
/build/qgis-3.41.0+git20241122+3440c17df1d+99sid/src/gui/qgslayermetadatasearchwidget.cpp

Public Slots

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QgsLayerMetadataSearchWidget()

Member Function Documentation

◆ addButtonClicked

◆ refresh

◆ reset

◆ setMapCanvas()

◆ showEvent()

◆ updateExtentFilter