Class: QgsLayerMetadataProviderRegistry

class qgis.core.QgsLayerMetadataProviderRegistry

Bases: PyQt5.QtCore.QObject

Registry of layer metadata provider backends.

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

New in version 3.28.

QgsLayerMetadataProviderRegistry(parent: QObject = None) Creates the layer metadata provider registry, with an optional parent

Methods

childEvent

connectNotify

customEvent

disconnectNotify

isSignalConnected

layerMetadataProviderFromId

Returns metadata provider implementation if the id matches one.

layerMetadataProviders

Returns the list of all registered layer metadata providers.

receivers

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.

sender

senderSignalIndex

timerEvent

unregisterLayerMetadataProvider

Unregisters a layer metadata provider metadataProvider and destroys its instance

childEvent(self, QChildEvent)
connectNotify(self, QMetaMethod)
customEvent(self, QEvent)
disconnectNotify(self, QMetaMethod)
isSignalConnected(self, QMetaMethod) bool
layerMetadataProviderFromId(self, id: str) QgsAbstractLayerMetadataProvider

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

Parameters

id (str) –

Return type

QgsAbstractLayerMetadataProvider

layerMetadataProviders(self) List[QgsAbstractLayerMetadataProvider]

Returns the list of all registered layer metadata providers.

Return type

List[QgsAbstractLayerMetadataProvider]

receivers(self, PYQT_SIGNAL) int
registerLayerMetadataProvider(self, metadataProvider: QgsAbstractLayerMetadataProvider)

Registers a layer metadata provider metadataProvider and takes ownership of it

Parameters

metadataProvider (QgsAbstractLayerMetadataProvider) –

search(self, searchContext: QgsMetadataSearchContext, searchString: str = '', geographicExtent: QgsRectangle = QgsRectangle(), feedback: QgsFeedback = 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
Return type

QgsLayerMetadataSearchResults

sender(self) QObject
senderSignalIndex(self) int
timerEvent(self, QTimerEvent)
unregisterLayerMetadataProvider(self, metadataProvider: QgsAbstractLayerMetadataProvider)

Unregisters a layer metadata provider metadataProvider and destroys its instance

Parameters

metadataProvider (QgsAbstractLayerMetadataProvider) –