QgsProviderSourceWidget Class Reference

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

#include <qgsprovidersourcewidget.h>

Inheritance diagram for QgsProviderSourceWidget:

Signals
void	changed ()
	Emitted whenever the configuration of the widget changes. More...
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 QString	groupTitle () const
	Returns an optional group title for the source settings, for use in layer properties dialogs. More...
virtual QgsMapCanvas *	mapCanvas ()
	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

changed

void QgsProviderSourceWidget::changed ( )

signal

Emitted whenever the configuration of the widget changes.

Since

QGIS 3.30

groupTitle()

virtual QString QgsProviderSourceWidget::groupTitle ( ) const

inlinevirtual

Returns an optional group title for the source settings, for use in layer properties dialogs.

If not specified, a default title will be used.

Since

QGIS 3.36

Definition at line 64 of file qgsprovidersourcewidget.h.

mapCanvas()

virtual QgsMapCanvas * QgsProviderSourceWidget::mapCanvas ( )

inlinevirtual

Returns the map canvas associated with the widget.

Since

QGIS 3.26

Definition at line 78 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 71 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:

• /build/qgis-3.37.0+git20240325+fdefdf9c27f+17bookworm/src/gui/qgsprovidersourcewidget.h
• /build/qgis-3.37.0+git20240325+fdefdf9c27f+17bookworm/src/gui/qgsprovidersourcewidget.cpp