QGIS API Documentation
3.41.0-Master (45a0abf3bec)
Loading...
Searching...
No Matches
src
gui
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
24
class
QgsMapCanvas
;
25
32
class
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
64
virtual
QString
groupTitle
()
const
{
return
QString(); }
65
71
virtual
void
setMapCanvas
(
QgsMapCanvas
*mapCanvas ) { mMapCanvas = mapCanvas; }
72
78
virtual
QgsMapCanvas
*
mapCanvas
() {
return
mMapCanvas; }
79
80
signals:
81
88
void
validChanged
(
bool
isValid );
89
95
void
changed
();
96
97
private
:
98
QgsMapCanvas
*mMapCanvas =
nullptr
;
99
100
};
101
#endif
//QGSPROVIDERSOURCEWIDGET_H
QgsMapCanvas
Map canvas is a class for displaying all GIS data types on a canvas.
Definition
qgsmapcanvas.h:93
QgsProviderSourceWidget
Base class for widgets which allow customization of a provider's source URI.
Definition
qgsprovidersourcewidget.h:33
QgsProviderSourceWidget::mapCanvas
virtual QgsMapCanvas * mapCanvas()
Returns the map canvas associated with the widget.
Definition
qgsprovidersourcewidget.h:78
QgsProviderSourceWidget::groupTitle
virtual QString groupTitle() const
Returns an optional group title for the source settings, for use in layer properties dialogs.
Definition
qgsprovidersourcewidget.h:64
QgsProviderSourceWidget::validChanged
void validChanged(bool isValid)
Emitted whenever the validation status of the widget changes.
QgsProviderSourceWidget::sourceUri
virtual QString sourceUri() const =0
Returns the source URI as currently defined by the widget.
QgsProviderSourceWidget::changed
void changed()
Emitted whenever the configuration of the widget changes.
QgsProviderSourceWidget::setMapCanvas
virtual void setMapCanvas(QgsMapCanvas *mapCanvas)
Sets a map canvas associated with the widget.
Definition
qgsprovidersourcewidget.h:71
QgsProviderSourceWidget::setSourceUri
virtual void setSourceUri(const QString &uri)=0
Sets the source uri to show in the widget.
qgis_sip.h
SIP_TRANSFERTHIS
#define SIP_TRANSFERTHIS
Definition
qgis_sip.h:53
Generated on Tue Nov 19 2024 18:20:01 for QGIS API Documentation by
1.9.8