Class: QgsSettingsEntryStringList

class qgis.core.QgsSettingsEntryStringList

Bases: QgsSettingsEntryByReferenceQStringListBase

A string list settings entry.

New in version 3.20.

QgsSettingsEntryStringList(name: str, parent: QgsSettingsTreeNode, defaultValue: Iterable[str] = [], description: str = ‘’, options: Union[Qgis.SettingsOptions, Qgis.SettingsOption] = Qgis.SettingsOptions()) Constructor for QgsSettingsEntryStringList.

Parameters:

• name – specifies the name of the setting.

• parent – specifies the parent in the tree of settings.

• defaultValue – specifies the default value for the settings entry.

• description – specifies a description for the settings entry.

• options – specifies the options for the settings entry.

QgsSettingsEntryStringList(key: str, pluginName: str, defaultValue: Iterable[str] = [], description: str = ‘’, options: Union[Qgis.SettingsOptions, Qgis.SettingsOption] = Qgis.SettingsOptions()) Constructor for QgsSettingsEntryStringList. This constructor is intended to be used from plugins.

Parameters:

• key – specifies the key of the settings.

• pluginName – is inserted in the key after the section.

• defaultValue – specifies the default value for the settings entry.

• description – specifies a description for the settings entry.

• options – specifies the options for the settings entry.

QgsSettingsEntryStringList(QgsSettingsEntryStringList)

Methods

checkValue	Check if the value is valid
convertFromVariant	Converts the variant value to the value type of the setting
convertToVariant	Converts the value to a variant
setValuePrivate	Sets the settings value with an optional list of dynamic parts
setVariantValuePrivate	Sets the settings value with a variant value.
settingsType	rtype: Qgis.SettingsType

checkValue(self, value: Iterable[str]) → bool

Check if the value is valid

convertFromVariant(self, value: Any) → List[str]

Converts the variant value to the value type of the setting

convertToVariant(self, value: Iterable[str]) → Any

Converts the value to a variant

setValuePrivate(self, value: Iterable[str], dynamicKeyPartList: Iterable[str]) → bool

Sets the settings value with an optional list of dynamic parts

setVariantValuePrivate(self, value: Any, dynamicKeyPartList: Iterable[str] = []) → bool

Sets the settings value with a variant value. This should be called from any implementation as it takes care of actually calling QSettings

New in version 3.26.

settingsType(self) → Qgis.SettingsType

Return type:

Qgis.SettingsType