Class: PyQgsSettingsEntryEnumFlag¶
- class qgis.core.PyQgsSettingsEntryEnumFlag(key, pluginName, defaultValue, description='', options=<qgis._core.Qgis.SettingsOptions object>)¶
Bases:
QgsSettingsEntryBase
class PyQgsSettingsEntryEnumFlag An enum settings entry. since QGIS 3.20
Methods
Get settings default value.
Set settings value.
Get the settings entry type.
Get settings value.
Get settings value with a default value override.
- __init__(key, pluginName, defaultValue, description='', options=<qgis._core.Qgis.SettingsOptions object>)¶
Constructor for PyQgsSettingsEntryEnumFlag. :param key: argument specifies the final part of the settings key. :param pluginName: argument is inserted in the key after the section. :param defaultValue: argument specifies the default value for the settings entry. :param description: argument specifies a description for the settings entry.
- defaultValue()¶
Get settings default value.
- setValue(value, dynamicKeyPart: (<class 'list'>, <class 'str'>) = None)¶
Set settings value. :param value: the value to set for the setting. :param dynamicKeyPart: argument specifies the dynamic part of the settings key (a single one a string, or several as a list)
- settingsType()¶
Get the settings entry type.
- value(dynamicKeyPart=None)¶
Get settings value. :param dynamicKeyPart: argument specifies the dynamic part of the settings key.
- valueWithDefaultOverride(defaultValueOverride, dynamicKeyPart=None)¶
Get settings value with a default value override. :param defaultValueOverride: argument if valid is used instead of the normal default value. :param dynamicKeyPart: argument specifies the dynamic part of the settings key.