Class: QgsSettingsEntryVariantMap

A string list settings entry.

Added in version 3.30.

Class Hierarchy

Inheritance diagram of qgis.core.QgsSettingsEntryVariantMap

Base classes

QgsSettingsEntryBaseTemplateQVariantMapBase

Base abstract class for settings entries with typed get and set methods.

QgsSettingsEntryBase

Represents a settings entry and provides methods for reading and writing settings values.
class qgis.core.QgsSettingsEntryVariantMap[source]

Bases: QgsSettingsEntryBaseTemplateQVariantMapBase

__init__(name: str | None, parent: QgsSettingsTreeNode | None, defaultValue: Dict[str, Any] = {}, description: str | None = '', options: Qgis.SettingsOptions | Qgis.SettingsOption = Qgis.SettingsOptions())

Constructor for QgsSettingsEntryVariantMap.

Parameters:

  • name (Optional[str]) – specifies the name of the setting.

  • parent (Optional[QgsSettingsTreeNode]) – specifies the parent in the tree of settings.

  • defaultValue (Dict[str, Any] = {}) – specifies the default value for the settings entry.

  • description (Optional[str] = '') – specifies a description for the settings entry.

  • options (Union[Qgis.SettingsOptions, Qgis.SettingsOption] = Qgis.SettingsOptions()) – specifies the options for the settings entry.

__init__(key: str | None, pluginName: str | None, defaultValue: Dict[str, Any] = {}, description: str | None = '', options: Qgis.SettingsOptions | Qgis.SettingsOption = Qgis.SettingsOptions())

Constructor for QgsSettingsEntryStringMap. This constructor is intended to be used from plugins.

Parameters:

  • key (Optional[str]) – specifies the key of the settings.

  • pluginName (Optional[str]) – is inserted in the key after the section.

  • defaultValue (Dict[str, Any] = {}) – specifies the default value for the settings entry.

  • description (Optional[str] = '') – specifies a description for the settings entry.

  • options (Union[Qgis.SettingsOptions, Qgis.SettingsOption] = Qgis.SettingsOptions()) – specifies the options for the settings entry.

__init__(a0: QgsSettingsEntryVariantMap)
Parameters:

a0 (QgsSettingsEntryVariantMap)