QGIS API Documentation  3.27.0-Master (e113457133)
Signals | Public Member Functions | List of all members
QgsProviderSourceWidget Class Referenceabstract

Base class for widgets which allow customization of a provider's source URI. More...

#include <qgsprovidersourcewidget.h>

Inheritance diagram for QgsProviderSourceWidget:
Inheritance graph
[legend]

Signals

void validChanged (bool isValid)
 Emitted whenever the validation status of the widget changes. More...
 

Public Member Functions

 QgsProviderSourceWidget (QWidget *parent=nullptr)
 Constructor for QgsProviderSourceWidget with the specified parent widget. More...
 
virtual QgsMapCanvasmapCanvas ()
 Returns the map canvas associated with the widget. More...
 
virtual void setMapCanvas (QgsMapCanvas *mapCanvas)
 Sets a map canvas associated with the widget. More...
 
virtual void setSourceUri (const QString &uri)=0
 Sets the source uri to show in the widget. More...
 
virtual QString sourceUri () const =0
 Returns the source URI as currently defined by the widget. More...
 

Detailed Description

Base class for widgets which allow customization of a provider's source URI.

Since
QGIS 3.18

Definition at line 32 of file qgsprovidersourcewidget.h.

Constructor & Destructor Documentation

◆ QgsProviderSourceWidget()

QgsProviderSourceWidget::QgsProviderSourceWidget ( QWidget *  parent = nullptr)

Constructor for QgsProviderSourceWidget with the specified parent widget.

Definition at line 21 of file qgsprovidersourcewidget.cpp.

Member Function Documentation

◆ mapCanvas()

virtual QgsMapCanvas* QgsProviderSourceWidget::mapCanvas ( )
inlinevirtual

Returns the map canvas associated with the widget.

Since
QGIS 3.26

Definition at line 69 of file qgsprovidersourcewidget.h.

◆ setMapCanvas()

virtual void QgsProviderSourceWidget::setMapCanvas ( QgsMapCanvas mapCanvas)
inlinevirtual

Sets a map canvas associated with the widget.

Since
QGIS 3.26

Reimplemented in QgsOWSSourceWidget.

Definition at line 62 of file qgsprovidersourcewidget.h.

◆ setSourceUri()

virtual void QgsProviderSourceWidget::setSourceUri ( const QString &  uri)
pure virtual

Sets the source uri to show in the widget.

See also
sourceUri()

Implemented in QgsOWSSourceWidget.

◆ sourceUri()

virtual QString QgsProviderSourceWidget::sourceUri ( ) const
pure virtual

Returns the source URI as currently defined by the widget.

See also
setSourceUri()

Implemented in QgsOWSSourceWidget.

◆ validChanged

void QgsProviderSourceWidget::validChanged ( bool  isValid)
signal

Emitted whenever the validation status of the widget changes.

If isValid is false then the widget is not valid, and any dialog using the widget should be prevented from being accepted.


The documentation for this class was generated from the following files: