Class: QgsProviderGuiMetadata

Holds data for the GUI part of the data providers.

Added in version 3.10.

class qgis.gui.QgsProviderGuiMetadata

Bases: object

__init__(key: str | None)

Constructor for provider gui metadata

Parameters:

key (Optional[str])

__init__(a0: QgsProviderGuiMetadata)

Parameters:

a0 (QgsProviderGuiMetadata)

virtual 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

virtual mapLayerConfigWidgetFactories(self) → List[QgsMapLayerConfigWidgetFactory]

Returns map layer config widget factories associated with the provider.

Note

Ownership of factories remains with the provider.

Added in version 3.20.

Return type:

List[QgsMapLayerConfigWidgetFactory]

virtual 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]

virtual registerGui(self, widget: QMainWindow | None)

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 (Optional[QMainWindow])

virtual sourceSelectProviders(self) → List[QgsSourceSelectProvider]

Returns source select providers

Note

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

Return type:

List[QgsSourceSelectProvider]

virtual sourceWidgetProviders(self) → List[QgsProviderSourceWidgetProvider]

Returns source widget providers

Note

Ownership of created providers is passed to the caller.

Added in version 3.18.

Return type:

List[QgsProviderSourceWidgetProvider]

virtual subsetStringEditorProviders(self) → List[QgsSubsetStringEditorProvider]

Returns subset string editor providers

Note

Ownership of created providers is passed to the caller.

Added in version 3.18.

Return type:

List[QgsSubsetStringEditorProvider]