Class: QgsSettingsEntryBool

class qgis.core.QgsSettingsEntryBool

Bases: QgsSettingsEntryBase

A boolean settings entry.

New in version 3.20.

QgsSettingsEntryBool(key: str, pluginName: str, defaultValue: bool = False, description: str = ‘’) Constructor for QgsSettingsEntryBool. This constructor is intended to be used from plugins.

The key argument specifies the key of the settings. The pluginName argument is inserted in the key after the section. The default value argument specifies the default value for the settings entry. The description argument specifies a description for the settings entry.

QgsSettingsEntryBool(QgsSettingsEntryBool)

Methods

defaultValue

Get settings default value.

setValue

Set settings value.

settingsType

copydoc QgsSettingsEntryBase.settingsType

value

Get settings value.

defaultValue(self)bool

Get settings default value.

Return type

bool

setValue(self, value: bool, dynamicKeyPart: str = '')bool

Set settings value.

The value to set. The dynamicKeyPart argument specifies the dynamic part of the settings key.

setValue(self, value: bool, dynamicKeyPartList: Iterable[str]) -> bool Set settings value.

The value to set. The dynamicKeyParts argument specifies the list of dynamic parts of the settings key.

Parameters
  • value (bool) –

  • dynamicKeyPart (str = '') –

Return type

bool

settingsType(self)QgsSettingsEntryBase.SettingsType

copydoc QgsSettingsEntryBase.settingsType

Return type

QgsSettingsEntryBase.SettingsType

value(self, dynamicKeyPart: str = '', useDefaultValueOverride: bool = False, defaultValueOverride: bool = False)bool

Get settings value.

The dynamicKeyPart argument specifies the dynamic part of the settings key. The useDefaultValueOverride argument specifies if defaultValueOverride should be used. The defaultValueOverride argument if valid is used instead of the normal default value.

value(self, dynamicKeyPartList: Iterable[str], useDefaultValueOverride: bool = False, defaultValueOverride: bool = False) -> bool Get settings value.

The dynamicKeyParts argument specifies the list of dynamic parts of the settings key. The useDefaultValueOverride argument specifies if defaultValueOverride should be used. The defaultValueOverride argument if valid is used instead of the normal default value.

Parameters
  • dynamicKeyPart (str = '') –

  • useDefaultValueOverride (bool = False) –

  • defaultValueOverride (bool = False) –

Return type

bool