Class: QgsSettingsEditorWidgetRegistry¶
A registry that manages editor widgets for settings.
Added in version 3.32.
- class qgis.gui.QgsSettingsEditorWidgetRegistry[source]¶
Bases:
object- __init__()
Constructor
- __init__(a0: QgsSettingsEditorWidgetRegistry)
- Parameters:
- addWrapper(self, wrapper: QgsSettingsEditorWidgetWrapper | None) bool[source]¶
Adds an editor widget
wrapperto the registry If an editor widget with same id already exists, the wrapper is deleted andFalseis returned.- Parameters:
wrapper (Optional[QgsSettingsEditorWidgetWrapper])
- Return type:
bool
- addWrapperForSetting(self, wrapper: QgsSettingsEditorWidgetWrapper | None, setting: QgsSettingsEntryBase | None)[source]¶
Adds an editor widget
wrapperfor a specific setting to the registryAdded in version 3.40.
- Parameters:
wrapper (Optional[QgsSettingsEditorWidgetWrapper])
setting (Optional[QgsSettingsEntryBase])
- createEditor(self, setting: QgsSettingsEntryBase | None, dynamicKeyPartList: Iterable[str | None], parent: QWidget | None = None) QWidget | None[source]¶
Creates an editor widget for the given
settingusing 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]