Class: QgsLayerMetadataProviderRegistry

Registry of layer metadata provider backends.

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

See also

QgsAbstractLayerMetadataProvider

Added in version 3.28.

Class Hierarchy

Base classes

QObject

Methods

layerMetadataProviderFromId	Returns metadata provider implementation if the id matches one.
layerMetadataProviders	Returns the list of all registered layer metadata providers.
registerLayerMetadataProvider	Registers a layer metadata provider metadataProvider and takes ownership of it
search	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.
unregisterLayerMetadataProvider	Unregisters a layer metadata provider metadataProvider and destroys its instance

class qgis.core.QgsLayerMetadataProviderRegistry

Bases: QObject

__init__(parent: QObject | None = None)

Creates the layer metadata provider registry, with an optional parent

Parameters:

parent (Optional[QObject] = None)

layerMetadataProviderFromId(self, id: str | None) → QgsAbstractLayerMetadataProvider | None

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

Parameters:

id (Optional[str])

Return type:

Optional[QgsAbstractLayerMetadataProvider]

layerMetadataProviders(self) → List[QgsAbstractLayerMetadataProvider]

Returns the list of all registered layer metadata providers.

Return type:

List[QgsAbstractLayerMetadataProvider]

registerLayerMetadataProvider(self, metadataProvider: QgsAbstractLayerMetadataProvider | None)

Registers a layer metadata provider metadataProvider and takes ownership of it

Parameters:

metadataProvider (Optional[QgsAbstractLayerMetadataProvider])

search(self, searchContext: QgsMetadataSearchContext, searchString: str | None = '', geographicExtent: QgsRectangle = QgsRectangle(), feedback: QgsFeedback | None = None) → QgsLayerMetadataSearchResults

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.

Parameters:

• searchContext (QgsMetadataSearchContext)

• searchString (Optional[str] = '')

• geographicExtent (QgsRectangle = QgsRectangle())

• feedback (Optional[QgsFeedback] = None)

Return type:

QgsLayerMetadataSearchResults

unregisterLayerMetadataProvider(self, metadataProvider: QgsAbstractLayerMetadataProvider | None)

Unregisters a layer metadata provider metadataProvider and destroys its instance

Parameters:

metadataProvider (Optional[QgsAbstractLayerMetadataProvider])