This class keeps a list of data item providers that may add items to the browser tree. More...

#include <qgsdataitemproviderregistry.h>

Inheritance diagram for QgsDataItemProviderRegistry:

Signals
void	providerAdded (QgsDataItemProvider *provider)
	Emitted when a new data item provider has been added.

void	providerWillBeRemoved (QgsDataItemProvider *provider)
	Emitted when a data item provider is about to be removed.

Public Member Functions
	QgsDataItemProviderRegistry ()

	QgsDataItemProviderRegistry (const QgsDataItemProviderRegistry &rh)=delete

	~QgsDataItemProviderRegistry ()

void	addProvider (QgsDataItemProvider *provider)
	Adds a provider implementation to the registry.

QString	dataProviderKey (const QString &dataItemProviderName)
	Returns the (possibly blank) data provider key for a given data item provider name.

QgsDataItemProviderRegistry &	operator= (const QgsDataItemProviderRegistry &rh)=delete

QgsDataItemProvider *	provider (const QString &providerName) const
	Returns the (possibly `nullptr`) data item provider named providerName.

QList< QgsDataItemProvider * >	providers () const
	Returns the list of available providers.

void	removeProvider (QgsDataItemProvider *provider)
	Removes a provider implementation from the registry.

Detailed Description

This class keeps a list of data item providers that may add items to the browser tree.

When created, it automatically adds providers from provider plugins (e.g. PostGIS, WMS, ...)

QgsDataItemProviderRegistry is not usually directly created, but rather accessed through QgsApplication::dataItemProviderRegistry().

Definition at line 39 of file qgsdataitemproviderregistry.h.

Constructor & Destructor Documentation

◆ QgsDataItemProviderRegistry() [1/2]

QgsDataItemProviderRegistry::QgsDataItemProviderRegistry ( )

Definition at line 26 of file qgsdataitemproviderregistry.cpp.

◆ ~QgsDataItemProviderRegistry()

QgsDataItemProviderRegistry::~QgsDataItemProviderRegistry ( )

Definition at line 47 of file qgsdataitemproviderregistry.cpp.

◆ QgsDataItemProviderRegistry() [2/2]

QgsDataItemProviderRegistry::QgsDataItemProviderRegistry ( const QgsDataItemProviderRegistry & rh )

delete

Member Function Documentation

◆ addProvider()

void QgsDataItemProviderRegistry::addProvider ( QgsDataItemProvider * provider )

Adds a provider implementation to the registry.

Ownership of the provider is transferred to the registry.

Definition at line 66 of file qgsdataitemproviderregistry.cpp.

◆ dataProviderKey()

QString QgsDataItemProviderRegistry::dataProviderKey ( const QString & dataItemProviderName )

Returns the (possibly blank) data provider key for a given data item provider name.

Parameters

dataItemProviderName name of the data item provider

Since: QGIS 3.14

Definition at line 86 of file qgsdataitemproviderregistry.cpp.

◆ operator=()

QgsDataItemProviderRegistry & QgsDataItemProviderRegistry::operator= ( const QgsDataItemProviderRegistry & rh )

delete

◆ provider()

QgsDataItemProvider * QgsDataItemProviderRegistry::provider ( const QString & providerName ) const

Returns the (possibly nullptr) data item provider named providerName.

Since: QGIS 3.14

Definition at line 54 of file qgsdataitemproviderregistry.cpp.

◆ providerAdded

void QgsDataItemProviderRegistry::providerAdded ( QgsDataItemProvider * provider )

signal

Emitted when a new data item provider has been added.

Since: QGIS 3.14

◆ providers()

QList< QgsDataItemProvider * > QgsDataItemProviderRegistry::providers ( ) const

Returns the list of available providers.

Definition at line 52 of file qgsdataitemproviderregistry.cpp.

◆ providerWillBeRemoved

void QgsDataItemProviderRegistry::providerWillBeRemoved ( QgsDataItemProvider * provider )

signal

Emitted when a data item provider is about to be removed.

Since: QGIS 3.14

◆ removeProvider()

void QgsDataItemProviderRegistry::removeProvider ( QgsDataItemProvider * provider )

Removes a provider implementation from the registry.

The provider object is automatically deleted.

Definition at line 76 of file qgsdataitemproviderregistry.cpp.

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

/build/qgis-3.41.0+git20241225+af5edcb665c+99sid/src/core/browser/qgsdataitemproviderregistry.h
/build/qgis-3.41.0+git20241225+af5edcb665c+99sid/src/core/browser/qgsdataitemproviderregistry.cpp

Signals

Public Member Functions