Class: QgsProviderGuiMetadata

class qgis.gui.QgsProviderGuiMetadata

Bases: sip.wrapper

Holds data for GUI part of the data providers

New in version 3.10.

QgsProviderGuiMetadata(key: str) Constructor for provider gui metadata

QgsProviderGuiMetadata(QgsProviderGuiMetadata)

Methods

dataItemGuiProviders

Returns data item gui providers

key

Returns unique provider key

mapLayerConfigWidgetFactories

Returns map layer config widget factories associated with the provider.

projectStorageGuiProviders

Returns project storage gui providers

registerGui

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.

sourceSelectProviders

Returns source select providers

sourceWidgetProviders

Returns source widget providers

subsetStringEditorProviders

Returns subset string editor providers

dataItemGuiProviders(self)List[QgsDataItemGuiProvider]

Returns data item gui providers

Note

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

Return type

List[QgsDataItemGuiProvider]

key(self)str

Returns unique provider key

Return type

str

mapLayerConfigWidgetFactories(self)List[QgsMapLayerConfigWidgetFactory]

Returns map layer config widget factories associated with the provider.

Note

Ownership of factories remains with the provider.

New in version 3.20.

Return type

List[QgsMapLayerConfigWidgetFactory]

projectStorageGuiProviders(self)List[QgsProjectStorageGuiProvider]

Returns project storage gui providers

Note

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

Return type

List[QgsProjectStorageGuiProvider]

registerGui(self, widget: QMainWindow)

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.

Parameters

widget (QMainWindow) –

sourceSelectProviders(self)List[QgsSourceSelectProvider]

Returns source select providers

Note

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

Return type

List[QgsSourceSelectProvider]

sourceWidgetProviders(self)List[QgsProviderSourceWidgetProvider]

Returns source widget providers

Note

Ownership of created providers is passed to the caller.

New in version 3.18.

Return type

List[QgsProviderSourceWidgetProvider]

subsetStringEditorProviders(self)List[QgsSubsetStringEditorProvider]

Returns subset string editor providers

Note

Ownership of created providers is passed to the caller.

New in version 3.18.

Return type

List[QgsSubsetStringEditorProvider]