QGIS API Documentation  3.27.0-Master (bef583a8ef)
Public Member Functions | List of all members
QgsProviderSourceWidgetProvider Class Referenceabstract

An interface for providers of widgets designed to configure a data provider's source. More...

#include <qgsprovidersourcewidgetprovider.h>

Public Member Functions

virtual ~QgsProviderSourceWidgetProvider ()
 
virtual bool canHandleLayer (QgsMapLayer *layer) const =0
 Returns true if the provider can handle the specified layer. More...
 
virtual QgsProviderSourceWidgetcreateWidget (QgsMapLayer *layer, QWidget *parent=nullptr)=0
 Creates a new widget to configure the source of the specified layer. More...
 
virtual QString name () const
 Source widget provider name, this is useful to retrieve a particular source widget provider in case the provider has more than one, it should be unique among all providers. More...
 
virtual QString providerKey () const =0
 Provider key. More...
 

Detailed Description

An interface for providers of widgets designed to configure a data provider's source.

Since
QGIS 3.18

Definition at line 37 of file qgsprovidersourcewidgetprovider.h.

Constructor & Destructor Documentation

◆ ~QgsProviderSourceWidgetProvider()

QgsProviderSourceWidgetProvider::~QgsProviderSourceWidgetProvider ( )
virtualdefault

Member Function Documentation

◆ canHandleLayer()

virtual bool QgsProviderSourceWidgetProvider::canHandleLayer ( QgsMapLayer layer) const
pure virtual

Returns true if the provider can handle the specified layer.

◆ createWidget()

virtual QgsProviderSourceWidget* QgsProviderSourceWidgetProvider::createWidget ( QgsMapLayer layer,
QWidget *  parent = nullptr 
)
pure virtual

Creates a new widget to configure the source of the specified layer.

It may return nullptr if it cannot handle the layer. The returned object must be destroyed by the caller.

◆ name()

virtual QString QgsProviderSourceWidgetProvider::name ( ) const
inlinevirtual

Source widget provider name, this is useful to retrieve a particular source widget provider in case the provider has more than one, it should be unique among all providers.

The default implementation returns the providerKey()

Definition at line 53 of file qgsprovidersourcewidgetprovider.h.

◆ providerKey()

virtual QString QgsProviderSourceWidgetProvider::providerKey ( ) const
pure virtual

Provider key.


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