QGIS API Documentation  3.2.0-Bonn (bc43194)
Public Member Functions | List of all members
QgsSourceSelectProviderRegistry Class Reference

This class keeps a list of source select providers that may add items to the QgsDataSourceManagerDialog When created, it automatically adds providers from data provider plugins (e.g. More...

#include <qgssourceselectproviderregistry.h>

Public Member Functions

 QgsSourceSelectProviderRegistry ()=default
 Constructor for QgsSourceSelectProviderRegistry. More...
 
 QgsSourceSelectProviderRegistry (const QgsSourceSelectProviderRegistry &rh)=delete
 QgsDataItemProviderRegistry cannot be copied. More...
 
 ~QgsSourceSelectProviderRegistry ()
 
void addProvider (QgsSourceSelectProvider *provider)
 Add a provider implementation. Takes ownership of the object. More...
 
QgsSourceSelectProviderRegistryoperator= (const QgsSourceSelectProviderRegistry &rh)=delete
 QgsDataItemProviderRegistry cannot be copied. More...
 
QgsSourceSelectProviderproviderByName (const QString &name)
 Returns a provider by name or nullptr if not found. More...
 
QList< QgsSourceSelectProvider * > providers ()
 Gets list of available providers. More...
 
QList< QgsSourceSelectProvider * > providersByKey (const QString &providerKey)
 Returns a (possibly empty) list of providers by data providerkey. More...
 
bool removeProvider (QgsSourceSelectProvider *provider)
 Remove provider implementation from the list (provider object is deleted) More...
 

Detailed Description

This class keeps a list of source select providers that may add items to the QgsDataSourceManagerDialog When created, it automatically adds providers from data provider plugins (e.g.

PostGIS, WMS, ...)

QgsSourceSelectProviderRegistry is not usually directly created, but rather accessed through QgsGui::sourceSelectProviderRegistry().

Note
This class access to QgsProviderRegistry instance to initialize, but QgsProviderRegistry is typically initialized after QgsGui is constructed, for this reason a delayed initialization has been implemented in the class.
Since
QGIS 3.0

Definition at line 38 of file qgssourceselectproviderregistry.h.

Constructor & Destructor Documentation

◆ QgsSourceSelectProviderRegistry() [1/2]

QgsSourceSelectProviderRegistry::QgsSourceSelectProviderRegistry ( )
default

◆ ~QgsSourceSelectProviderRegistry()

QgsSourceSelectProviderRegistry::~QgsSourceSelectProviderRegistry ( )

Definition at line 24 of file qgssourceselectproviderregistry.cpp.

◆ QgsSourceSelectProviderRegistry() [2/2]

QgsSourceSelectProviderRegistry::QgsSourceSelectProviderRegistry ( const QgsSourceSelectProviderRegistry rh)
delete

QgsDataItemProviderRegistry cannot be copied.

Member Function Documentation

◆ addProvider()

void QgsSourceSelectProviderRegistry::addProvider ( QgsSourceSelectProvider provider)

Add a provider implementation. Takes ownership of the object.

Definition at line 35 of file qgssourceselectproviderregistry.cpp.

◆ operator=()

QgsSourceSelectProviderRegistry& QgsSourceSelectProviderRegistry::operator= ( const QgsSourceSelectProviderRegistry rh)
delete

QgsDataItemProviderRegistry cannot be copied.

◆ providerByName()

QgsSourceSelectProvider * QgsSourceSelectProviderRegistry::providerByName ( const QString &  name)

Returns a provider by name or nullptr if not found.

Definition at line 55 of file qgssourceselectproviderregistry.cpp.

◆ providers()

QList< QgsSourceSelectProvider * > QgsSourceSelectProviderRegistry::providers ( )

Gets list of available providers.

Definition at line 29 of file qgssourceselectproviderregistry.cpp.

◆ providersByKey()

QList< QgsSourceSelectProvider * > QgsSourceSelectProviderRegistry::providersByKey ( const QString &  providerKey)

Returns a (possibly empty) list of providers by data providerkey.

Definition at line 68 of file qgssourceselectproviderregistry.cpp.

◆ removeProvider()

bool QgsSourceSelectProviderRegistry::removeProvider ( QgsSourceSelectProvider provider)

Remove provider implementation from the list (provider object is deleted)

Returns
true if the provider was actually removed and deleted

Definition at line 44 of file qgssourceselectproviderregistry.cpp.


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