QGIS API Documentation  3.9.0-Master (224899f119)
Public Member Functions | List of all members
QgsDataItemGuiProviderRegistry Class Reference

This class keeps a list of 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 cannot be copied. More...
 
 ~QgsDataItemGuiProviderRegistry ()
 
void addProvider (QgsDataItemGuiProvider *provider)
 Adds a provider implementation to the registry. More...
 
void initializeFromProviderGuiRegistry (QgsProviderGuiRegistry *providerGuiRegistry)
 Initializes the registry. More...
 
QgsDataItemGuiProviderRegistryoperator= (const QgsDataItemGuiProviderRegistry &rh)=delete
 QgsDataItemGuiProviderRegistry cannot be copied. More...
 
QList< QgsDataItemGuiProvider * > providers () const
 Returns the list of available providers. More...
 
void removeProvider (QgsDataItemGuiProvider *provider)
 Removes a provider implementation from the registry. More...
 

Detailed Description

This class keeps a list of 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 37 of file qgsdataitemguiproviderregistry.h.

Constructor & Destructor Documentation

◆ QgsDataItemGuiProviderRegistry() [1/2]

QgsDataItemGuiProviderRegistry::QgsDataItemGuiProviderRegistry ( )
default

◆ ~QgsDataItemGuiProviderRegistry()

QgsDataItemGuiProviderRegistry::~QgsDataItemGuiProviderRegistry ( )

Definition at line 24 of file qgsdataitemguiproviderregistry.cpp.

◆ QgsDataItemGuiProviderRegistry() [2/2]

QgsDataItemGuiProviderRegistry::QgsDataItemGuiProviderRegistry ( const QgsDataItemGuiProviderRegistry rh)
delete

QgsDataItemGuiProviderRegistry cannot be copied.

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 29 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 41 of file qgsdataitemguiproviderregistry.cpp.

◆ operator=()

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

QgsDataItemGuiProviderRegistry cannot be copied.

◆ providers()

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

Returns the list of available providers.

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


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