QgsDataItemProviderRegistry Class Reference

#include <qgsdataitemproviderregistry.h>

Inheritance diagram for QgsDataItemProviderRegistry:

Signals
void	providerAdded (QgsDataItemProvider *provider)
	Emitted when a new data item provider has been added. More...
void	providerWillBeRemoved (QgsDataItemProvider *provider)
	Emitted when a data item provider is about to be removed. More...

Public Member Functions
	QgsDataItemProviderRegistry ()
	QgsDataItemProviderRegistry (const QgsDataItemProviderRegistry &rh)=delete
	QgsDataItemProviderRegistry cannot be copied. More...
	~QgsDataItemProviderRegistry ()
void	addProvider (QgsDataItemProvider *provider)
	Adds a provider implementation to the registry. More...
QString	dataProviderKey (const QString &dataItemProviderName)
	Returns the (possibly blank) data provider key for a given data item provider name. More...
QgsDataItemProviderRegistry &	operator= (const QgsDataItemProviderRegistry &rh)=delete
	QgsDataItemProviderRegistry cannot be copied. More...
QgsDataItemProvider *	provider (const QString &providerName) const
	Returns the (possibly NULL) data item provider named providerName. More...
QList< QgsDataItemProvider * >	providers () const
	Returns the list of available providers. More...
void	removeProvider (QgsDataItemProvider *provider)
	Removes a provider implementation from the registry. More...

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().

Since

QGIS 2.10

Definition at line 39 of file qgsdataitemproviderregistry.h.

Constructor & Destructor Documentation

QgsDataItemProviderRegistry() [1/2]

QgsDataItemProviderRegistry::QgsDataItemProviderRegistry

(

)

Definition at line 24 of file qgsdataitemproviderregistry.cpp.

~QgsDataItemProviderRegistry()

QgsDataItemProviderRegistry::~QgsDataItemProviderRegistry

(

)

Definition at line 43 of file qgsdataitemproviderregistry.cpp.

QgsDataItemProviderRegistry() [2/2]

QgsDataItemProviderRegistry::QgsDataItemProviderRegistry ( const QgsDataItemProviderRegistry &  rh )

delete

QgsDataItemProviderRegistry cannot be copied.

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 62 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 82 of file qgsdataitemproviderregistry.cpp.

operator=()

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

delete

QgsDataItemProviderRegistry cannot be copied.

provider()

QgsDataItemProvider * QgsDataItemProviderRegistry::provider

(

const QString &

providerName

)

const

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

Since

QGIS 3.14

Definition at line 50 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 48 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 72 of file qgsdataitemproviderregistry.cpp.

---

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

• /build/qgis-3.14.0+99unstable/src/core/qgsdataitemproviderregistry.h
• /build/qgis-3.14.0+99unstable/src/core/qgsdataitemproviderregistry.cpp