QGIS API Documentation  3.21.0-Master (5b68dc587e)
Public Types | Public Member Functions | List of all members
QgsProviderGuiRegistry Class Reference

A registry / canonical manager of GUI parts of data providers. More...

#include <qgsproviderguiregistry.h>

Public Types

typedef std::map< QString, QgsProviderGuiMetadata * > GuiProviders
 Type for data provider metadata associative container. More...
 

Public Member Functions

 QgsProviderGuiRegistry (const QString &pluginPath)
 Creates registry and loads static provider plugins. More...
 
virtual ~QgsProviderGuiRegistry ()
 dtor More...
 
virtual const QList< QgsDataItemGuiProvider * > dataItemGuiProviders (const QString &providerKey)
 Returns all data item gui providers registered in provider with providerKey. More...
 
virtual QList< const QgsMapLayerConfigWidgetFactory * > mapLayerConfigWidgetFactories (QgsMapLayer *layer=nullptr)
 Returns all map layer config widget factories associated with the registered providers. More...
 
virtual QList< QgsProjectStorageGuiProvider * > projectStorageGuiProviders (const QString &providerKey)
 Returns all project storage gui providers registered in provider with providerKey. More...
 
QStringList providerList () const
 Returns list of available providers by their keys. More...
 
const QgsProviderGuiMetadataproviderMetadata (const QString &providerKey) const
 Returns metadata of the provider or nullptr if not found. More...
 
void registerGuis (QMainWindow *widget)
 Called during GUI initialization - allows providers to do its internal initialization of GUI components, possibly making use of the passed pointer to the QGIS main window. More...
 
virtual QList< QgsSourceSelectProvider * > sourceSelectProviders (const QString &providerKey)
 Returns all source select providers registered in provider with providerKey. More...
 
virtual QList< QgsProviderSourceWidgetProvider * > sourceWidgetProviders (const QString &providerKey)
 Returns all source widget providers registered in provider with providerKey. More...
 
virtual QList< QgsSubsetStringEditorProvider * > subsetStringEditorProviders (const QString &providerKey)
 Returns all subset string editor providers registered in provider with providerKey. More...
 

Detailed Description

A registry / canonical manager of GUI parts of data providers.

QgsProviderGuiRegistry is not usually directly created, but rather accessed through QgsGui::providerGuiRegistry().

setPluginPath() should be called (once) to load dynamic providers. Static providers are loaded in constructor.

Since
QGIS 3.10

Definition at line 53 of file qgsproviderguiregistry.h.

Member Typedef Documentation

◆ GuiProviders

Type for data provider metadata associative container.

Definition at line 117 of file qgsproviderguiregistry.h.

Constructor & Destructor Documentation

◆ QgsProviderGuiRegistry()

QgsProviderGuiRegistry::QgsProviderGuiRegistry ( const QString &  pluginPath)

Creates registry and loads static provider plugins.

Definition at line 62 of file qgsproviderguiregistry.cpp.

◆ ~QgsProviderGuiRegistry()

QgsProviderGuiRegistry::~QgsProviderGuiRegistry ( )
virtual

dtor

Definition at line 175 of file qgsproviderguiregistry.cpp.

Member Function Documentation

◆ dataItemGuiProviders()

const QList< QgsDataItemGuiProvider * > QgsProviderGuiRegistry::dataItemGuiProviders ( const QString &  providerKey)
virtual

Returns all data item gui providers registered in provider with providerKey.

Note
Ownership of created data item providers is passed to the caller.

Definition at line 196 of file qgsproviderguiregistry.cpp.

◆ mapLayerConfigWidgetFactories()

QList< const QgsMapLayerConfigWidgetFactory * > QgsProviderGuiRegistry::mapLayerConfigWidgetFactories ( QgsMapLayer layer = nullptr)
virtual

Returns all map layer config widget factories associated with the registered providers.

The optional layer argument can be used to only return factories which support the specified layer.

Since
QGIS 3.20

Definition at line 236 of file qgsproviderguiregistry.cpp.

◆ projectStorageGuiProviders()

QList< QgsProjectStorageGuiProvider * > QgsProviderGuiRegistry::projectStorageGuiProviders ( const QString &  providerKey)
virtual

Returns all project storage gui providers registered in provider with providerKey.

Note
Ownership of created project storage gui providers is passed to the caller.

Definition at line 212 of file qgsproviderguiregistry.cpp.

◆ providerList()

QStringList QgsProviderGuiRegistry::providerList ( ) const

Returns list of available providers by their keys.

Definition at line 251 of file qgsproviderguiregistry.cpp.

◆ providerMetadata()

const QgsProviderGuiMetadata * QgsProviderGuiRegistry::providerMetadata ( const QString &  providerKey) const

Returns metadata of the provider or nullptr if not found.

Definition at line 261 of file qgsproviderguiregistry.cpp.

◆ registerGuis()

void QgsProviderGuiRegistry::registerGuis ( QMainWindow *  widget)

Called during GUI initialization - allows providers to do its internal initialization of GUI components, possibly making use of the passed pointer to the QGIS main window.

Definition at line 186 of file qgsproviderguiregistry.cpp.

◆ sourceSelectProviders()

QList< QgsSourceSelectProvider * > QgsProviderGuiRegistry::sourceSelectProviders ( const QString &  providerKey)
virtual

Returns all source select providers registered in provider with providerKey.

Note
Ownership of created source select providers is passed to the caller.

Definition at line 204 of file qgsproviderguiregistry.cpp.

◆ sourceWidgetProviders()

QList< QgsProviderSourceWidgetProvider * > QgsProviderGuiRegistry::sourceWidgetProviders ( const QString &  providerKey)
virtual

Returns all source widget providers registered in provider with providerKey.

Note
Ownership of providers is passed to the caller.
Since
QGIS 3.18

Definition at line 228 of file qgsproviderguiregistry.cpp.

◆ subsetStringEditorProviders()

QList< QgsSubsetStringEditorProvider * > QgsProviderGuiRegistry::subsetStringEditorProviders ( const QString &  providerKey)
virtual

Returns all subset string editor providers registered in provider with providerKey.

Note
Ownership of providers is passed to the caller.
Since
QGIS 3.18

Definition at line 220 of file qgsproviderguiregistry.cpp.


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