qgslayermetadataproviderregistry.h

Go to the documentation of this file.

/***************************************************************************
  qgslayermetadataproviderregistry.h - QgsLayerMetadataProviderRegistry
 
 ---------------------
 begin                : 17.8.2022
 copyright            : (C) 2022 by Alessandro Pasotti
 email                : elpaso at itopen dot it
 ***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
#ifndef QGSLAYERMETADATAPROVIDERREGISTRY_H
#define QGSLAYERMETADATAPROVIDERREGISTRY_H
 
#include "qgis.h"
#include "qgis_core.h"
#include "qgsabstractlayermetadataprovider.h"
#include "qgslayermetadata.h"
 
#include <QObject>
 
class QgsFeedback;
 
#ifdef SIP_RUN
// clang-format off
% ModuleHeaderCode
#include "qgsabstractlayermetadataprovider.h"
% End
// clang-format on
#endif

  class CORE_EXPORT QgsLayerMetadataProviderRegistry : public QObject
{
    Q_OBJECT
  public:
    explicit QgsLayerMetadataProviderRegistry( QObject *parent = nullptr );

    void registerLayerMetadataProvider( QgsAbstractLayerMetadataProvider *metadataProvider SIP_TRANSFER );

    void unregisterLayerMetadataProvider( QgsAbstractLayerMetadataProvider *metadataProvider );

    QList<QgsAbstractLayerMetadataProvider *> layerMetadataProviders() const;

    QgsAbstractLayerMetadataProvider *layerMetadataProviderFromId( const QString &id );

    const QgsLayerMetadataSearchResults search(
      const QgsMetadataSearchContext &searchContext, const QString &searchString = QString(), const QgsRectangle &geographicExtent = QgsRectangle(), QgsFeedback *feedback = nullptr
    );
 
  private:
    QHash<QString, QgsAbstractLayerMetadataProvider *> mMetadataProviders;
};
 
#endif // QGSLAYERMETADATAPROVIDERREGISTRY_H