Class: QgsSettingsEntryStringList¶
- class qgis.core.QgsSettingsEntryStringList¶
Bases:
QgsSettingsEntryBase
A string list settings entry.
New in version 3.20.
QgsSettingsEntryStringList(key: str, pluginName: str, defaultValue: Iterable[str] = [], description: str = ‘’) Constructor for QgsSettingsEntryStringList. This constructor is intended to be used from plugins.
The
key
argument specifies the key of the settings. ThepluginName
argument is inserted in the key after the section. ThedefaultValue
argument specifies the default value for the settings entry. Thedescription
argument specifies a description for the settings entry.QgsSettingsEntryStringList(
QgsSettingsEntryStringList
)Methods
Returns settings default value.
Set settings value.
- rtype:
QgsSettingsEntryBase.SettingsType
Returns settings value.
- defaultValue(self) List[str] ¶
Returns settings default value.
- Return type:
List[str]
- setValue(self, value: Iterable[str], dynamicKeyPart: str = '') bool ¶
Set settings value.
The
value
to set. ThedynamicKeyPart
argument specifies the dynamic part of the settings key.setValue(self, value: Iterable[str], dynamicKeyPartList: Iterable[str]) -> bool Set settings value.
The
value
to set. ThedynamicKeyParts
argument specifies the list of dynamic parts of the settings key.- Parameters:
value (Iterable[str]) –
dynamicKeyPart (str = '') –
- Return type:
bool
- settingsType(self) QgsSettingsEntryBase.SettingsType ¶
- Return type:
- value(self, dynamicKeyPart: str = '', useDefaultValueOverride: bool = False, defaultValueOverride: Iterable[str] = []) List[str] ¶
Returns settings value.
The
dynamicKeyPart
argument specifies the dynamic part of the settings key. TheuseDefaultValueOverride
argument specifies if defaultValueOverride should be used. ThedefaultValueOverride
argument if valid is used instead of the normal default value.value(self, dynamicKeyPartList: Iterable[str], useDefaultValueOverride: bool = False, defaultValueOverride: Iterable[str] = []) -> List[str] Returns settings value.
The
dynamicKeyParts
argument specifies the list of dynamic parts of the settings key. TheuseDefaultValueOverride
argument specifies if defaultValueOverride should be used. ThedefaultValueOverride
argument if valid is used instead of the normal default value.- Parameters:
dynamicKeyPart (str = '') –
useDefaultValueOverride (bool = False) –
defaultValueOverride (Iterable[str] = []) –
- Return type:
List[str]