A registry for data item providers that may add items to the browser tree. More...
#include <qgsdataitemproviderregistry.h>
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 () override | |
| 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
A registry for 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 38 of file qgsdataitemproviderregistry.h.
Constructor & Destructor Documentation
◆ QgsDataItemProviderRegistry() [1/2]
| QgsDataItemProviderRegistry::QgsDataItemProviderRegistry | ( | ) |
Definition at line 27 of file qgsdataitemproviderregistry.cpp.
◆ ~QgsDataItemProviderRegistry()
|
override |
Definition at line 48 of file qgsdataitemproviderregistry.cpp.
◆ QgsDataItemProviderRegistry() [2/2]
|
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 67 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 87 of file qgsdataitemproviderregistry.cpp.
◆ operator=()
|
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 55 of file qgsdataitemproviderregistry.cpp.
◆ providerAdded
|
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 53 of file qgsdataitemproviderregistry.cpp.
◆ providerWillBeRemoved
|
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 77 of file qgsdataitemproviderregistry.cpp.
The documentation for this class was generated from the following files:
- /build/qgis-3.99.0+git20251214+752b475928d+99sid/src/core/browser/qgsdataitemproviderregistry.h
- /build/qgis-3.99.0+git20251214+752b475928d+99sid/src/core/browser/qgsdataitemproviderregistry.cpp
Generated on for QGIS API Documentation by
1.15.0