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()
.See also
Added in version 3.28.
QgsLayerMetadataProviderRegistry(parent: Optional[QObject] = None) Creates the layer metadata provider registry, with an optional
parent
Methods
Returns metadata provider implementation if the
id
matches one.Returns the list of all registered layer metadata providers.
Registers a layer metadata provider
metadataProvider
and takes ownership of itSearch for layers in all the registered layer metadata providers, optionally filtering by
searchString
andgeographicExtent
, an optionalfeedback
can be used to monitor and control the search process.Unregisters a layer metadata provider
metadataProvider
and destroys its instance- childEvent(self, a0: QChildEvent | None)¶
- connectNotify(self, signal: QMetaMethod)¶
- customEvent(self, a0: QEvent | None)¶
- disconnectNotify(self, signal: QMetaMethod)¶
- isSignalConnected(self, signal: QMetaMethod) bool ¶
- layerMetadataProviderFromId(self, id: str | None) QgsAbstractLayerMetadataProvider | None ¶
Returns metadata provider implementation if the
id
matches one. ReturnsNone
otherwise.- Parameters:
id (Optional[str])
- Return type:
Optional[QgsAbstractLayerMetadataProvider]
- layerMetadataProviders(self) List[QgsAbstractLayerMetadataProvider] ¶
Returns the list of all registered layer metadata providers.
- Return type:
- receivers(self, signal: PYQT_SIGNAL) int ¶
- 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
andgeographicExtent
, an optionalfeedback
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:
- sender(self) QObject | None ¶
- senderSignalIndex(self) int ¶
- timerEvent(self, a0: QTimerEvent | None)¶
- unregisterLayerMetadataProvider(self, metadataProvider: QgsAbstractLayerMetadataProvider | None)¶
Unregisters a layer metadata provider
metadataProvider
and destroys its instance- Parameters:
metadataProvider (Optional[QgsAbstractLayerMetadataProvider])