Class: QgsSettingsEntryBaseTemplateboolBase¶
- class qgis.core.QgsSettingsEntryBaseTemplateboolBase¶
Bases:
QgsSettingsEntryBase
Base abstract class for settings entries with typed get and set methods
See also
New in version 3.32.
QgsSettingsEntryBaseTemplateboolBase(name: str, parent:
QgsSettingsTreeNode
, defaultValue: Any, description: str = ‘’, options: Union[Qgis.SettingsOptions, Qgis.SettingsOption] = Qgis.SettingsOptions()) Constructor forQgsSettingsEntryByReference
.- Parameters:
name – specifies the key of the settings.
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.
- Raises:
QgsSettingsException – if the number of given parent named items doesn’t match the complete key definition
New in version 3.30.
QgsSettingsEntryBaseTemplateboolBase(key: str, section: str, defaultValue: Any, description: str = ‘’, options: Union[Qgis.SettingsOptions, Qgis.SettingsOption] = Qgis.SettingsOptions()) Constructor for
QgsSettingsEntryByReference
.- Parameters:
key – specifies the key of the settings.
section – specifies 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.
QgsSettingsEntryBaseTemplateboolBase(
QgsSettingsEntryBaseTemplateboolBase
)Methods
Check if the value is valid
- param value:
Converts the variant value to the value type of the setting
Converts the value to a variant
Returns settings default value.
Returns the former value.
Set settings value.
Sets the settings value with an optional list of dynamic parts
- rtype:
Qgis.SettingsType
Returns settings value.
Returns the settings value with a
defaultValueOverride
and with an optionaldynamicKeyPart
- checkValuePrivate(self, value: bool) bool ¶
Check if the value is valid
- Parameters:
value (bool) –
- Return type:
bool
- checkValueVariant(self, value: Any) bool ¶
- Parameters:
value (Any) –
- Return type:
bool
- convertFromVariant(self, value: Any) bool ¶
Converts the variant value to the value type of the setting
- Parameters:
value (Any) –
- Return type:
bool
- convertToVariant(self, value: bool) Any ¶
Converts the value to a variant
- Parameters:
value (bool) –
- Return type:
Any
- defaultValue(self) bool ¶
Returns settings default value.
- Return type:
bool
- formerValue(self, dynamicKeyPart: str = '') bool ¶
Returns the former value. Returns the current value (or default) if there is no former value.
formerValue(self, dynamicKeyPartList: Iterable[str]) -> bool Returns the former value Returns the current value (or default) if there is no former value.
- Parameters:
dynamicKeyPart (str = '') –
- Return type:
bool
- setValue(self, value: bool, dynamicKeyPart: str = '') bool ¶
Set settings value.
- Parameters:
value (bool) – specifies the value to set.
dynamicKeyPart (str = '') – specifies the dynamic part of the settings key.
setValue(self, value: bool, dynamicKeyPartList: Iterable[str]) -> bool Set settings value.
- Parameters:
value – specifies the value to set.
dynamicKeyPartList – specifies the list of dynamic parts of the settings key.
- Return type:
bool
- setValuePrivate(self, value: bool, dynamicKeyPartList: Iterable[str]) bool ¶
Sets the settings value with an optional list of dynamic parts
- Parameters:
value (bool) –
dynamicKeyPartList (Iterable[str]) –
- Return type:
bool
- settingsType(self) Qgis.SettingsType ¶
- Return type:
- value(self, dynamicKeyPart: str = '') bool ¶
Returns settings value.
- Parameters:
dynamicKeyPart (str = '') – specifies the dynamic part of the settings key.
value(self, dynamicKeyPartList: Iterable[str]) -> bool Returns settings value.
- Parameters:
dynamicKeyPartList – specifies the list of dynamic parts of the settings key.
- Return type:
bool
- valueWithDefaultOverride(self, defaultValueOverride: bool, dynamicKeyPart: str = '') bool ¶
Returns the settings value with a
defaultValueOverride
and with an optionaldynamicKeyPart
valueWithDefaultOverride(self, defaultValueOverride: bool, dynamicKeyPartList: Iterable[str]) -> bool Returns the settings value with a
defaultValueOverride
for thedynamicKeyPartList
- Parameters:
defaultValueOverride (bool) –
dynamicKeyPart (str = '') –
- Return type:
bool