QGIS API Documentation 3.99.0-Master (2fe06baccd8)
Loading...
Searching...
No Matches
QgsDataItemGuiProviderRegistry Class Reference

A registry for data item GUI providers that may affect how QgsDataItems behave within the application GUI. More...

#include <qgsdataitemguiproviderregistry.h>

Public Member Functions

 QgsDataItemGuiProviderRegistry ()
 QgsDataItemGuiProviderRegistry (const QgsDataItemGuiProviderRegistry &rh)=delete
 ~QgsDataItemGuiProviderRegistry ()
void addProvider (QgsDataItemGuiProvider *provider)
 Adds a provider implementation to the registry.
void initializeFromProviderGuiRegistry (QgsProviderGuiRegistry *providerGuiRegistry)
 Initializes the registry.
QgsDataItemGuiProviderRegistryoperator= (const QgsDataItemGuiProviderRegistry &rh)=delete
QList< QgsDataItemGuiProvider * > providers () const
 Returns the list of available providers.
void removeProvider (QgsDataItemGuiProvider *provider)
 Removes a provider implementation from the registry.

Detailed Description

A registry for data item GUI providers that may affect how QgsDataItems behave within the application GUI.

QgsDataItemGuiProviderRegistry is not usually directly created, but rather accessed through QgsGui::instance()->dataItemGuiProviderRegistry().

Since
QGIS 3.6

Definition at line 38 of file qgsdataitemguiproviderregistry.h.

Constructor & Destructor Documentation

◆ QgsDataItemGuiProviderRegistry() [1/2]

QgsDataItemGuiProviderRegistry::QgsDataItemGuiProviderRegistry ( )
default

◆ ~QgsDataItemGuiProviderRegistry()

QgsDataItemGuiProviderRegistry::~QgsDataItemGuiProviderRegistry ( )

Definition at line 23 of file qgsdataitemguiproviderregistry.cpp.

◆ QgsDataItemGuiProviderRegistry() [2/2]

QgsDataItemGuiProviderRegistry::QgsDataItemGuiProviderRegistry ( const QgsDataItemGuiProviderRegistry & rh)
delete

Member Function Documentation

◆ addProvider()

void QgsDataItemGuiProviderRegistry::addProvider ( QgsDataItemGuiProvider * provider)

Adds a provider implementation to the registry.

Ownership of the provider is transferred to the registry.

Definition at line 28 of file qgsdataitemguiproviderregistry.cpp.

◆ initializeFromProviderGuiRegistry()

void QgsDataItemGuiProviderRegistry::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 40 of file qgsdataitemguiproviderregistry.cpp.

◆ operator=()

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

◆ providers()

QList< QgsDataItemGuiProvider * > QgsDataItemGuiProviderRegistry::providers ( ) const
inline

Returns the list of available providers.

Definition at line 50 of file qgsdataitemguiproviderregistry.h.

◆ removeProvider()

void QgsDataItemGuiProviderRegistry::removeProvider ( QgsDataItemGuiProvider * provider)

Removes a provider implementation from the registry.

The provider object is automatically deleted.

Definition at line 33 of file qgsdataitemguiproviderregistry.cpp.


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