qgssourceselectproviderregistry.h

Go to the documentation of this file.

/***************************************************************************
  qgssourceselectproviderregistry.h - QgsSourceSelectProviderRegistry
 
 ---------------------
 begin                : 1.9.2017
 copyright            : (C) 2017 by Alessandro Pasotti
 email                : apasotti at boundlessgeo dot com
 ***************************************************************************
 *                                                                         *
 *   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 QGSSOURCESELECTPROVIDERREGISTRY_H
#define QGSSOURCESELECTPROVIDERREGISTRY_H
 
#include "qgis_gui.h"
#include "qgis_sip.h"
#include "qgsproviderregistry.h"
 
#include <QList>
#include <QObject>
 
class QgsSourceSelectProvider;
class QgsProviderGuiRegistry;
class QgsAbstractDataSourceWidget;

class GUI_EXPORT QgsSourceSelectProviderRegistry : public QObject
{
    Q_OBJECT
 
  public:
    QgsSourceSelectProviderRegistry();
    ~QgsSourceSelectProviderRegistry() override;
 
    QgsSourceSelectProviderRegistry( const QgsSourceSelectProviderRegistry &rh ) = delete;
    QgsSourceSelectProviderRegistry &operator=( const QgsSourceSelectProviderRegistry &rh ) = delete;

    QList<QgsSourceSelectProvider *> providers();

    void addProvider( QgsSourceSelectProvider *provider SIP_TRANSFER );

    bool removeProvider( QgsSourceSelectProvider *provider SIP_TRANSFER );

    void initializeFromProviderGuiRegistry( QgsProviderGuiRegistry *providerGuiRegistry );

    QgsSourceSelectProvider *providerByName( const QString &name );

    QList<QgsSourceSelectProvider *> providersByKey( const QString &providerKey );

    QgsAbstractDataSourceWidget *createSelectionWidget(
      const QString &name,
      QWidget *parent,
      Qt::WindowFlags fl,
      QgsProviderRegistry::WidgetMode widgetMode
    );
 
  signals:

    void providerAdded( const QString &name );

    void providerRemoved( const QString &name );
 
  private:
#ifdef SIP_RUN
    QgsSourceSelectProviderRegistry( const QgsSourceSelectProviderRegistry &rh );
#endif

    QList<QgsSourceSelectProvider *> mProviders;
};
 
#endif // QGSSOURCESELECTPROVIDERREGISTRY_H