qgssourceselectprovider.h

Go to the documentation of this file.

/***************************************************************************
  qgssourceselectprovider.h - QgsSourceSelectProvider
 
 ---------------------
 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 QGSSOURCESELECTPROVIDER_H
#define QGSSOURCESELECTPROVIDER_H
 
 
#include "qgis_gui.h"
#include "qgis_sip.h"
#include "qgsguiutils.h"
#include "qgsproviderregistry.h"
#include "qgsabstractdatasourcewidget.h"
 
class QString;
class QWidget;
 
class GUI_EXPORT QgsSourceSelectProvider
{
    Q_GADGET
 
  public:
 
    enum Ordering
    {
      OrderLocalProvider = 0, 
      OrderDatabaseProvider = 1000, 
      OrderRemoteProvider = 2000, 
      OrderSearchProvider = 4000, 
      OrderOtherProvider = 5000, 
    };
 
    enum class Capability : int SIP_ENUM_BASETYPE( IntFlag )
    {
      NoCapabilities  = 0, 
      ConfigureFromUri = 1  
    };
    Q_ENUM( Capability )
    Q_DECLARE_FLAGS( Capabilities, Capability )
    Q_FLAG( Capabilities )
 
    virtual ~QgsSourceSelectProvider() = default;
 
    virtual QString providerKey() const = 0;
 
    virtual QString name() const { return providerKey(); }
 
    virtual QString text() const = 0;
 
    virtual QString toolTip() const { return QString(); }
 
    virtual QIcon icon() const = 0;
 
    virtual int ordering( ) const { return OrderOtherProvider; }
 
    virtual QgsAbstractDataSourceWidget *createDataSourceWidget( QWidget *parent = nullptr, Qt::WindowFlags fl = Qt::Widget, QgsProviderRegistry::WidgetMode widgetMode = QgsProviderRegistry::WidgetMode::Embedded ) const = 0 SIP_FACTORY;
 
    virtual Capabilities capabilities()
    {
      return Capability::NoCapabilities;
    }
 
};
 
Q_DECLARE_OPERATORS_FOR_FLAGS( QgsSourceSelectProvider::Capabilities )
 
#endif // QGSSOURCESELECTPROVIDER_H