Registry of layer metadata provider backends. More...

#include <qgslayermetadataproviderregistry.h>

Inheritance diagram for QgsLayerMetadataProviderRegistry:

Public Member Functions
	QgsLayerMetadataProviderRegistry (QObject *parent=nullptr)
	Creates the layer metadata provider registry, with an optional parent.

QgsAbstractLayerMetadataProvider *	layerMetadataProviderFromId (const QString &id)
	Returns metadata provider implementation if the id matches one. Returns `nullptr` otherwise.

QList< QgsAbstractLayerMetadataProvider * >	layerMetadataProviders () const
	Returns the list of all registered layer metadata providers.

void	registerLayerMetadataProvider (QgsAbstractLayerMetadataProvider *metadataProvider)
	Registers a layer metadata provider metadataProvider and takes ownership of it.

const QgsLayerMetadataSearchResults	search (const QgsMetadataSearchContext &searchContext, const QString &searchString=QString(), const QgsRectangle &geographicExtent=QgsRectangle(), QgsFeedback *feedback=nullptr)
	Search for layers in all the registered layer metadata providers, optionally filtering by searchString and geographicExtent, an optional feedback can be used to monitor and control the search process.

void	unregisterLayerMetadataProvider (QgsAbstractLayerMetadataProvider *metadataProvider)
	Unregisters a layer metadata provider metadataProvider and destroys its instance.

Detailed Description

Registry of layer metadata provider backends.

This is a singleton that should be accessed through QgsApplication::layerMetadataProviderRegistry().

See also: QgsAbstractLayerMetadataProvider

Since: QGIS 3.28

Definition at line 44 of file qgslayermetadataproviderregistry.h.

Constructor & Destructor Documentation

◆ QgsLayerMetadataProviderRegistry()

QgsLayerMetadataProviderRegistry::QgsLayerMetadataProviderRegistry ( QObject * parent = nullptr )

explicit

Creates the layer metadata provider registry, with an optional parent.

Definition at line 21 of file qgslayermetadataproviderregistry.cpp.

Member Function Documentation

◆ layerMetadataProviderFromId()

QgsAbstractLayerMetadataProvider * QgsLayerMetadataProviderRegistry::layerMetadataProviderFromId ( const QString & id )

Returns metadata provider implementation if the id matches one. Returns nullptr otherwise.

Definition at line 42 of file qgslayermetadataproviderregistry.cpp.

◆ layerMetadataProviders()

QList< QgsAbstractLayerMetadataProvider * > QgsLayerMetadataProviderRegistry::layerMetadataProviders ( ) const

Returns the list of all registered layer metadata providers.

Definition at line 37 of file qgslayermetadataproviderregistry.cpp.

◆ registerLayerMetadataProvider()

void QgsLayerMetadataProviderRegistry::registerLayerMetadataProvider ( QgsAbstractLayerMetadataProvider * metadataProvider )

Registers a layer metadata provider metadataProvider and takes ownership of it.

Definition at line 27 of file qgslayermetadataproviderregistry.cpp.

◆ search()

const QgsLayerMetadataSearchResults QgsLayerMetadataProviderRegistry::search	(	const QgsMetadataSearchContext &	searchContext,
		const QString &	searchString = `QString()`,
		const QgsRectangle &	geographicExtent = `QgsRectangle()`,
		QgsFeedback *	feedback = `nullptr`
	)

Search for layers in all the registered layer metadata providers, optionally filtering by searchString and geographicExtent, an optional feedback can be used to monitor and control the search process.

Definition at line 47 of file qgslayermetadataproviderregistry.cpp.

◆ unregisterLayerMetadataProvider()

void QgsLayerMetadataProviderRegistry::unregisterLayerMetadataProvider ( QgsAbstractLayerMetadataProvider * metadataProvider )

Unregisters a layer metadata provider metadataProvider and destroys its instance.

Definition at line 32 of file qgslayermetadataproviderregistry.cpp.

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

/build/qgis-3.41.0+git20241110+fda2aa46e9a+99sid/src/core/metadata/qgslayermetadataproviderregistry.h
/build/qgis-3.41.0+git20241110+fda2aa46e9a+99sid/src/core/metadata/qgslayermetadataproviderregistry.cpp

Public Member Functions