Class: QgsSettingsEntryBool¶
- class qgis.core.QgsSettingsEntryBool¶
Bases:
QgsSettingsEntryBaseTemplateboolBase
A boolean settings entry.
New in version 3.20.
QgsSettingsEntryBool(name: str, parent:
QgsSettingsTreeNode
, defaultValue: bool = False, description: str = ‘’, options: Union[Qgis.SettingsOptions, Qgis.SettingsOption] = Qgis.SettingsOptions()) Constructor for QgsSettingsEntryBool.- Parameters:
name – specifies the name of the setting.
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.
QgsSettingsEntryBool(key: str, pluginName: str, defaultValue: bool = False, description: str = ‘’, options: Union[Qgis.SettingsOptions, Qgis.SettingsOption] = Qgis.SettingsOptions()) Constructor for QgsSettingsEntryBool. This constructor is intended to be used from plugins.
- Parameters:
key – specifies the key of the settings.
pluginName – is inserted in the key after 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.
QgsSettingsEntryBool(
QgsSettingsEntryBool
)Methods
Check if the value is valid
- param value:
Converts the value to a variant
Sets the settings value with an optional list of dynamic parts
- rtype:
Qgis.SettingsType
- checkValuePrivate(self, value: bool) bool ¶
Check if the value is valid
- convertFromVariant(self, value: Any) bool ¶
- Parameters:
value (Any) –
- Return type:
bool
- convertToVariant(self, value: bool) Any ¶
Converts the value to a variant
- setValuePrivate(self, value: bool, dynamicKeyPartList: Iterable[str]) bool ¶
Sets the settings value with an optional list of dynamic parts
- settingsType(self) Qgis.SettingsType ¶
- Return type: