QGIS API Documentation 3.29.0-Master (8c80f25a4f)
Public Member Functions | List of all members
QgsLayerMetadataProviderRegistry Class Reference

Registry of layer metadata provider backends. More...

#include <qgslayermetadataproviderregistry.h>

Inheritance diagram for QgsLayerMetadataProviderRegistry:
Inheritance graph
[legend]

Public Member Functions

 QgsLayerMetadataProviderRegistry (QObject *parent=nullptr)
 Creates the layer metadata provider registry, with an optional parent. More...
 
QgsAbstractLayerMetadataProviderlayerMetadataProviderFromId (const QString &id)
 Returns metadata provider implementation if the id matches one. Returns nullptr otherwise. More...
 
QList< QgsAbstractLayerMetadataProvider * > layerMetadataProviders () const
 Returns the list of all registered layer metadata providers. More...
 
void registerLayerMetadataProvider (QgsAbstractLayerMetadataProvider *metadataProvider)
 Registers a layer metadata provider metadataProvider and takes ownership of it. More...
 
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. More...
 
void unregisterLayerMetadataProvider (QgsAbstractLayerMetadataProvider *metadataProvider)
 Unregisters a layer metadata provider metadataProvider and destroys its instance. More...
 

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 20 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 41 of file qgslayermetadataproviderregistry.cpp.

◆ layerMetadataProviders()

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

Returns the list of all registered layer metadata providers.

Definition at line 36 of file qgslayermetadataproviderregistry.cpp.

◆ registerLayerMetadataProvider()

void QgsLayerMetadataProviderRegistry::registerLayerMetadataProvider ( QgsAbstractLayerMetadataProvider metadataProvider)

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

Definition at line 26 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 46 of file qgslayermetadataproviderregistry.cpp.

◆ unregisterLayerMetadataProvider()

void QgsLayerMetadataProviderRegistry::unregisterLayerMetadataProvider ( QgsAbstractLayerMetadataProvider metadataProvider)

Unregisters a layer metadata provider metadataProvider and destroys its instance.

Definition at line 31 of file qgslayermetadataproviderregistry.cpp.


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