qgsabstractdatasourcewidget.h

Go to the documentation of this file.

/***************************************************************************
    qgsabstractdatasourcewidget.h  -  base class for source selector widgets
                             -------------------
    begin                : 10 July 2017
    original             : (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 QGSABSTRACTDATASOURCEWIDGET_H
#define QGSABSTRACTDATASOURCEWIDGET_H
 
#include "qgis_gui.h"
#include "qgis_sip.h"
#include "qgsguiutils.h"
#include "qgsproviderregistry.h"
 
#include <QDialog>
#include <QDialogButtonBox>
 
class QgsMapCanvas;
class QgsBrowserModel;
 

class GUI_EXPORT QgsAbstractDataSourceWidget : public QDialog
{
    Q_OBJECT
 
  public:

    virtual void setBrowserModel( QgsBrowserModel *model );

    virtual QgsMapCanvas *mapCanvas() { return mMapCanvas; }

    virtual void setMapCanvas( QgsMapCanvas *mapCanvas ) { mMapCanvas = mapCanvas; }
 
  public slots:

    virtual void refresh() {}

    virtual void addButtonClicked();

    virtual void reset();

    virtual bool configureFromUri( const QString &uri );
 
  signals:

    void connectionsChanged();

    void addDatabaseLayers( const QStringList &paths, const QString &providerKey );

    Q_DECL_DEPRECATED void addRasterLayer( const QString &rasterLayerPath, const QString &baseName, const QString &providerKey ) SIP_DEPRECATED;

    void addRasterLayers( const QStringList &layersList );

    Q_DECL_DEPRECATED void addVectorLayer( const QString &uri, const QString &layerName, const QString &providerKey = QString() ) SIP_DEPRECATED;

    Q_DECL_DEPRECATED void addMeshLayer( const QString &url, const QString &baseName, const QString &providerKey ) SIP_DEPRECATED;

    Q_DECL_DEPRECATED void addVectorTileLayer( const QString &url, const QString &baseName ) SIP_DEPRECATED;

    Q_DECL_DEPRECATED void addPointCloudLayer( const QString &url, const QString &baseName, const QString &providerKey ) SIP_DEPRECATED;

    void addLayer( Qgis::LayerType type, const QString &url, const QString &baseName, const QString &providerKey );

    void addVectorLayers( const QStringList &layerList, const QString &encoding, const QString &dataSourceType );

    void replaceVectorLayer( const QString &oldId, const QString &source, const QString &name, const QString &provider );

    Q_DECL_DEPRECATED void progress( int, int ) SIP_DEPRECATED;

    void progressMessage( QString message );

    void enableButtons( bool enable );

    void pushMessage( const QString &title, const QString &message, const Qgis::MessageLevel level = Qgis::MessageLevel::Info );
 
  protected:
    QgsAbstractDataSourceWidget( QWidget *parent SIP_TRANSFERTHIS = nullptr, Qt::WindowFlags fl = QgsGuiUtils::ModalDialogFlags, QgsProviderRegistry::WidgetMode widgetMode = QgsProviderRegistry::WidgetMode::Standalone );

    QgsProviderRegistry::WidgetMode widgetMode() const;

    QgsBrowserModel *browserModel();

    void setupButtons( QDialogButtonBox *buttonBox );

    QPushButton *addButton() const { return mAddButton; }
 
  private:
    QPushButton *mAddButton = nullptr;
    QgsProviderRegistry::WidgetMode mWidgetMode;
    QgsBrowserModel *mBrowserModel = nullptr;
    QgsMapCanvas *mMapCanvas = nullptr;
};
 
#endif // QGSABSTRACTDATASOURCEWIDGET_H