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

Inheritance diagram of qgis.core.QgsLayerMetadataProviderRegistry

Base classes

QObject
class qgis.core.QgsLayerMetadataProviderRegistry[source]

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[source]

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)[source]

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[source]

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:
Return type:

QgsLayerMetadataSearchResults

unregisterLayerMetadataProvider(self, metadataProvider: QgsAbstractLayerMetadataProvider | None)[source]

Unregisters a layer metadata provider metadataProvider and destroys its instance

Parameters:

metadataProvider (Optional[QgsAbstractLayerMetadataProvider])