QGIS API Documentation 3.29.0-Master (ade4f0cf0f)
qgsprovidersourcewidget.h
Go to the documentation of this file.
1/***************************************************************************
2 qgsprovidersourcewidget.h
3 ---------------
4 begin : December 2020
5 copyright : (C) 2020 by Nyall Dawson
6 email : nyall dot dawson at gmail dot com
7 ***************************************************************************/
8
9/***************************************************************************
10 * *
11 * This program is free software; you can redistribute it and/or modify *
12 * it under the terms of the GNU General Public License as published by *
13 * the Free Software Foundation; either version 2 of the License, or *
14 * (at your option) any later version. *
15 * *
16 ***************************************************************************/
17#ifndef QGSPROVIDERSOURCEWIDGET_H
18#define QGSPROVIDERSOURCEWIDGET_H
19
20#include <QWidget>
21#include "qgis_gui.h"
22#include "qgis_sip.h"
23
24class QgsMapCanvas;
25
32class GUI_EXPORT QgsProviderSourceWidget : public QWidget
33{
34 Q_OBJECT
35
36 public:
37
41 QgsProviderSourceWidget( QWidget *parent SIP_TRANSFERTHIS = nullptr );
42
48 virtual void setSourceUri( const QString &uri ) = 0;
49
55 virtual QString sourceUri() const = 0;
56
62 virtual void setMapCanvas( QgsMapCanvas *mapCanvas ) { mMapCanvas = mapCanvas; }
63
69 virtual QgsMapCanvas *mapCanvas() {return mMapCanvas; }
70
71 signals:
72
79 void validChanged( bool isValid );
80
81 private:
82 QgsMapCanvas *mMapCanvas = nullptr;
83
84};
85#endif //QGSPROVIDERSOURCEWIDGET_H
Map canvas is a class for displaying all GIS data types on a canvas.
Definition: qgsmapcanvas.h:90
Base class for widgets which allow customization of a provider's source URI.
virtual QgsMapCanvas * mapCanvas()
Returns the map canvas associated with the widget.
void validChanged(bool isValid)
Emitted whenever the validation status of the widget changes.
virtual QString sourceUri() const =0
Returns the source URI as currently defined by the widget.
virtual void setMapCanvas(QgsMapCanvas *mapCanvas)
Sets a map canvas associated with the widget.
virtual void setSourceUri(const QString &uri)=0
Sets the source uri to show in the widget.
#define SIP_TRANSFERTHIS
Definition: qgis_sip.h:53