Class: QgsSettingsStringComboBoxWrapper

A factory for editors of string settings with a combo box.

Added in version 3.40.

Note

This is an abstract class, with methods which must be implemented by a subclass.

The following methods must be implemented: QgsSettingsEditorWidgetWrapper.configureEditorPrivate(), QgsSettingsEditorWidgetWrapper.createEditorPrivate(), QgsSettingsEditorWidgetWrapper.setWidgetFromSetting(), QgsSettingsEditorWidgetWrapper.setWidgetFromVariant(), QgsSettingsEditorWidgetWrapper.variantValueFromWidget()

Class Hierarchy

Base classes

QgsSettingsEditorWidgetWrapperTemplateQgsSettingsEntryStringQComboBoxQStringBase	Base factory for editors for settings.
QgsSettingsEditorWidgetWrapper	Base class for settings editor wrappers.
QObject

class qgis.gui.QgsSettingsStringComboBoxWrapper

Bases: QgsSettingsEditorWidgetWrapperTemplateQgsSettingsEntryStringQComboBoxQStringBase

__init__(parent: QObject | None = None)

Constructor of the factory

Parameters:

parent (Optional[QObject] = None)

__init__(editor: QWidget | None, setting: QgsSettingsEntryBase | None, dynamicKeyPartList: Iterable[str | None] = [])

Constructor of the wrapper for a given setting and its widget editor

Parameters:

• editor (Optional[QWidget])

• setting (Optional[QgsSettingsEntryBase])

• dynamicKeyPartList (Iterable[Optional[str]] = [])

__init__(editor: QWidget | None, setting: QgsSettingsEntryBase | None, mode: QgsSettingsStringComboBoxWrapper.Mode, dynamicKeyPartList: Iterable[str | None] = [])

Constructor of the wrapper for a given setting and its widget editor

Parameters:

• editor (Optional[QWidget])

• setting (Optional[QgsSettingsEntryBase])

• mode (QgsSettingsStringComboBoxWrapper.Mode)

• dynamicKeyPartList (Iterable[Optional[str]] = [])

__init__(editor: QWidget | None, setting: QgsSettingsEntryBase | None, mode: QgsSettingsStringComboBoxWrapper.Mode, role: int, dynamicKeyPartList: Iterable[str | None] = [])

Constructor of the wrapper for a given setting and its widget editor

Added in version 3.44.3.

Parameters:

• editor (Optional[QWidget])

• setting (Optional[QgsSettingsEntryBase])

• mode (QgsSettingsStringComboBoxWrapper.Mode)

• role (int)

• dynamicKeyPartList (Iterable[Optional[str]] = [])

class Mode(*values)

Bases: IntEnum

Mode to determine if the value is hold in the combo box text or data

• Text: Value is defined as the text entry

• Data: Value is defined as data entry with Qt.UserRole

Data = 1

Text = 0