Class: QgsSettingsEntryVariantMap

class qgis.core.QgsSettingsEntryVariantMap

Bases: QgsSettingsEntryByReferenceQVariantMapBase

A string list settings entry.

New in version 3.30.

QgsSettingsEntryVariantMap(name: str, parent: QgsSettingsTreeNode, defaultValue: Dict[str, Any] = {}, description: str = ‘’, options: Union[Qgis.SettingsOptions, Qgis.SettingsOption] = Qgis.SettingsOptions()) Constructor for QgsSettingsEntryVariantMap.

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.

QgsSettingsEntryVariantMap(key: str, pluginName: str, defaultValue: Dict[str, Any] = {}, description: str = ‘’, options: Union[Qgis.SettingsOptions, Qgis.SettingsOption] = Qgis.SettingsOptions()) Constructor for QgsSettingsEntryStringMap. 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.

QgsSettingsEntryVariantMap(QgsSettingsEntryVariantMap)

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: Dict[str, Any]) bool

Check if the value is valid

convertFromVariant(self, value: Any) Dict[str, Any]

Converts the variant value to the value type of the setting

convertToVariant(self, value: Dict[str, Any]) Any

Converts the value to a variant

setValuePrivate(self, value: Dict[str, Any], 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