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 ()
	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...
QgsAbstractDataSourceWidget *	createSelectionWidget (const QString &name, QWidget *parent, Qt::WindowFlags fl, QgsProviderRegistry::WidgetMode widgetMode)
	Gets select widget from provider with name. More...
void	initializeFromProviderGuiRegistry (QgsProviderGuiRegistry *providerGuiRegistry)
	Initializes the registry. More...
QgsSourceSelectProviderRegistry &	operator= (const QgsSourceSelectProviderRegistry &rh)=delete
	QgsDataItemProviderRegistry cannot be copied. More...
QgsSourceSelectProvider *	providerByName (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().

Since

QGIS 3.0

Definition at line 41 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 34 of file qgssourceselectproviderregistry.cpp.

createSelectionWidget()

QgsAbstractDataSourceWidget * QgsSourceSelectProviderRegistry::createSelectionWidget	(	const QString &	name,
		QWidget *	parent,
		Qt::WindowFlags	fl,
		QgsProviderRegistry::WidgetMode	widgetMode
	)

Gets select widget from provider with name.

The function is replacement of QgsProviderRegistry::createSelectionWidget() from QGIS 3.8

Since

QGIS 3.10

Definition at line 99 of file qgssourceselectproviderregistry.cpp.

initializeFromProviderGuiRegistry()

void QgsSourceSelectProviderRegistry::initializeFromProviderGuiRegistry

(

QgsProviderGuiRegistry *

providerGuiRegistry

)

Initializes the registry.

The registry needs to be passed explicitly (instead of using singleton) because this gets called from QgsGui constructor.

Since

QGIS 3.10

Definition at line 55 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 72 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 85 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 43 of file qgssourceselectproviderregistry.cpp.

---

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

• /build/qgis-3.20.0+99unstable/src/gui/qgssourceselectproviderregistry.h
• /build/qgis-3.20.0+99unstable/src/gui/qgssourceselectproviderregistry.cpp