Class: QgsSettingsEditorWidgetRegistry

A registry that manages editor widgets for settings.

Added in version 3.32.

Methods

addWrapper

Adds an editor widget wrapper to the registry If an editor widget with same id already exists, the wrapper is deleted and False is returned.

addWrapperForSetting

Adds an editor widget wrapper for a specific setting to the registry

createEditor

Creates an editor widget for the given setting using the corresponding registered wrapper

createWrapper

Returns a new instance of the editor widget for the given id
class qgis.gui.QgsSettingsEditorWidgetRegistry[source]

Bases: object

__init__()

Constructor

__init__(a0: QgsSettingsEditorWidgetRegistry)
Parameters:

a0 (QgsSettingsEditorWidgetRegistry)

addWrapper(self, wrapper: QgsSettingsEditorWidgetWrapper | None) → bool[source]

Adds an editor widget wrapper to the registry If an editor widget with same id already exists, the wrapper is deleted and False is returned.

Parameters:

wrapper (Optional[QgsSettingsEditorWidgetWrapper])

Return type:

bool

addWrapperForSetting(self, wrapper: QgsSettingsEditorWidgetWrapper | None, setting: QgsSettingsEntryBase | None)[source]

Adds an editor widget wrapper for a specific setting to the registry

Added in version 3.40.

Parameters:
createEditor(self, setting: QgsSettingsEntryBase | None, dynamicKeyPartList: Iterable[str | None], parent: QWidget | None = None) → QWidget | None[source]

Creates an editor widget for the given setting using the corresponding registered wrapper

Parameters:

  • setting (Optional[QgsSettingsEntryBase])

  • dynamicKeyPartList (Iterable[Optional[str]])

  • parent (Optional[QWidget] = None)

Return type:

Optional[QWidget]

createWrapper(self, id: str | None, parent: QObject | None) → QgsSettingsEditorWidgetWrapper | None[source]

Returns a new instance of the editor widget for the given id

Parameters:

  • id (Optional[str])

  • parent (Optional[QObject])

Return type:

Optional[QgsSettingsEditorWidgetWrapper]