Layer metadata provider backend interface. More...

Public Member Functions
virtual	~QgsAbstractLayerMetadataProvider ()=default

virtual QString	id () const =0
	Returns the id of the layer metadata provider implementation, usually the name of the data provider but it may be another unique identifier. More...

virtual QgsLayerMetadataSearchResults	search (const QgsMetadataSearchContext &searchContext, const QString &searchString=QString(), const QgsRectangle &geographicExtent=QgsRectangle(), QgsFeedback *feedback=nullptr) const =0
	Searches for metadata optionally filtering by search string and geographic extent. More...

Detailed Description

Layer metadata provider backend interface.

Constructor & Destructor Documentation

virtual QgsAbstractLayerMetadataProvider::~QgsAbstractLayerMetadataProvider ( )

virtualdefault

virtual QString QgsAbstractLayerMetadataProvider::id ( ) const

pure virtual

Returns the id of the layer metadata provider implementation, usually the name of the data provider but it may be another unique identifier.

virtual QgsLayerMetadataSearchResults QgsAbstractLayerMetadataProvider::search	(	const QgsMetadataSearchContext &	searchContext,
		const QString &	searchString = `QString()`,
		const QgsRectangle &	geographicExtent = `QgsRectangle()`,
		QgsFeedback *	feedback = `nullptr`
	)		const

pure virtual

Searches for metadata optionally filtering by search string and geographic extent.

Parameters

searchContext	context for the metadata search.
searchString	defines a filter to limit the results to the records where the search string appears in the "identifier", "title" or "abstract" metadata fields, a case-insensitive comparison is used for the match.
geographicExtent	defines a filter where the spatial extent matches the given extent in EPSG:4326
feedback	can be used to monitor and control the search process.

Returns: a QgsLayerMetadataSearchResult object with a list of metadata and errors

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