Class: QgsSettingsEntryStringList¶
A string list settings entry.
Added in version 3.20.
Class Hierarchy¶
Base classes¶
Base abstract class for settings entries with typed get and set methods. |
|
Represents a settings entry and provides methods for reading and writing settings values. |
- class qgis.core.QgsSettingsEntryStringList[source]¶
Bases:
QgsSettingsEntryBaseTemplateQStringListBase- __init__(name: str | None, parent: QgsSettingsTreeNode | None, defaultValue: Iterable[str | None] = [], description: str | None = '', options: Qgis.SettingsOptions | Qgis.SettingsOption = Qgis.SettingsOptions())
Constructor for QgsSettingsEntryStringList.
- Parameters:
name (Optional[str]) – specifies the name of the setting.
parent (Optional[QgsSettingsTreeNode]) – specifies the parent in the tree of settings.
defaultValue (Iterable[Optional[str]] = []) – 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: Iterable[str | None] = [], description: str | None = '', options: Qgis.SettingsOptions | Qgis.SettingsOption = Qgis.SettingsOptions())
Constructor for QgsSettingsEntryStringList. 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 (Iterable[Optional[str]] = []) – 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: QgsSettingsEntryStringList)
- Parameters: