QGIS API Documentation  3.37.0-Master (a5b4d9743e8)
Public Member Functions | List of all members
QgsProviderGuiMetadata Class Reference

Holds data for GUI part of the data providers. More...

#include <qgsproviderguimetadata.h>

Public Member Functions

 QgsProviderGuiMetadata (const QString &key)
 Constructor for provider gui metadata. More...
 
virtual ~QgsProviderGuiMetadata ()
 
virtual QList< QgsDataItemGuiProvider * > dataItemGuiProviders ()
 Returns data item gui providers. More...
 
QString key () const
 Returns unique provider key. More...
 
virtual QList< const QgsMapLayerConfigWidgetFactory * > mapLayerConfigWidgetFactories ()
 Returns map layer config widget factories associated with the provider. More...
 
virtual QList< QgsProjectStorageGuiProvider * > projectStorageGuiProviders ()
 Returns project storage gui providers. More...
 
virtual void registerGui (QMainWindow *widget)
 Called during GUI initialization - allows provider 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 ()
 Returns source select providers. More...
 
virtual QList< QgsProviderSourceWidgetProvider * > sourceWidgetProviders ()
 Returns source widget providers. More...
 
virtual QList< QgsSubsetStringEditorProvider * > subsetStringEditorProviders ()
 Returns subset string editor providers. More...
 

Detailed Description

Holds data for GUI part of the data providers.

Since
QGIS 3.10

Definition at line 40 of file qgsproviderguimetadata.h.

Constructor & Destructor Documentation

◆ QgsProviderGuiMetadata()

QgsProviderGuiMetadata::QgsProviderGuiMetadata ( const QString &  key)
explicit

Constructor for provider gui metadata.

Definition at line 23 of file qgsproviderguimetadata.cpp.

◆ ~QgsProviderGuiMetadata()

QgsProviderGuiMetadata::~QgsProviderGuiMetadata ( )
virtualdefault

Member Function Documentation

◆ dataItemGuiProviders()

QList< QgsDataItemGuiProvider * > QgsProviderGuiMetadata::dataItemGuiProviders ( )
virtual

Returns data item gui providers.

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

Definition at line 30 of file qgsproviderguimetadata.cpp.

◆ key()

QString QgsProviderGuiMetadata::key ( ) const

Returns unique provider key.

Definition at line 60 of file qgsproviderguimetadata.cpp.

◆ mapLayerConfigWidgetFactories()

QList< const QgsMapLayerConfigWidgetFactory * > QgsProviderGuiMetadata::mapLayerConfigWidgetFactories ( )
virtual

Returns map layer config widget factories associated with the provider.

Note
Ownership of factories remains with the provider.
Since
QGIS 3.20

Definition at line 55 of file qgsproviderguimetadata.cpp.

◆ projectStorageGuiProviders()

QList< QgsProjectStorageGuiProvider * > QgsProviderGuiMetadata::projectStorageGuiProviders ( )
virtual

Returns project storage gui providers.

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

Definition at line 35 of file qgsproviderguimetadata.cpp.

◆ registerGui()

void QgsProviderGuiMetadata::registerGui ( QMainWindow *  widget)
virtual

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

Definition at line 65 of file qgsproviderguimetadata.cpp.

◆ sourceSelectProviders()

QList< QgsSourceSelectProvider * > QgsProviderGuiMetadata::sourceSelectProviders ( )
virtual

Returns source select providers.

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

Definition at line 40 of file qgsproviderguimetadata.cpp.

◆ sourceWidgetProviders()

QList< QgsProviderSourceWidgetProvider * > QgsProviderGuiMetadata::sourceWidgetProviders ( )
virtual

Returns source widget providers.

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

Definition at line 50 of file qgsproviderguimetadata.cpp.

◆ subsetStringEditorProviders()

QList< QgsSubsetStringEditorProvider * > QgsProviderGuiMetadata::subsetStringEditorProviders ( )
virtual

Returns subset string editor providers.

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

Definition at line 45 of file qgsproviderguimetadata.cpp.


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