Class: QgsSettingsEntryBase

class qgis.core.QgsSettingsEntryBase

Bases: sip.wrapper

Represent settings entry and provides methods for reading and writing settings values. Different subclasses are provided for different settings types with metainformations to validate set values and provide more accurate settings description for the gui.

New in version 3.20.

QgsSettingsEntryBase(key: str, pluginName: str, defaultValue: Any = None, description: str = ‘’) Constructor for QgsSettingsEntryBase. 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 defaultValue argument specifies the default value for the settings entry. The description argument specifies a description for the settings entry.

QgsSettingsEntryBase(QgsSettingsEntryBase)

Enums

SettingsType

Bases: enum.IntEnum

Methods

defaultValueAsVariant

Returns settings default value.

definitionKey

Returns settings entry defining key.

description

Returns the settings entry description.

exists

Returns True if the settings is contained in the underlying QSettings.

hasDynamicKey

Returns True if a part of the settings key is built dynamically.

key

Returns settings entry key.

keyIsValid

Returns True if the provided key match the settings entry.

remove

Removes the settings from the underlying QSettings.

section

Returns settings section.

setVariantValue

Set settings value.

settingsType

Returns the settings entry type.

valueAsVariant

Returns settings value.
class SettingsType(value)

Bases: enum.IntEnum

Types of settings entries

  • Variant: Generic variant

  • String: String

  • StringList: List of strings

  • Bool: Boolean

  • Integer: Integer

  • Double: Double precision numer

  • EnumFlag: Enum or Flag

  • Color: Color

Bool = 3
Color = 7
Double = 5
EnumFlag = 6
Integer = 4
String = 1
StringList = 2
Variant = 0
defaultValueAsVariant(self) → Any

Returns settings default value.

Return type

Any

definitionKey(self) → str

Returns settings entry defining key. For dynamic settings it return the key with the placeholder for dynamic part included. For non-dynamic settings returns the same as key().

Return type

str

description(self) → str

Returns the settings entry description.

Return type

str

exists(self, dynamicKeyPart: str = '') → bool

Returns True if the settings is contained in the underlying QSettings.

The dynamicKeyPart argument specifies the dynamic part of the settings key.

exists(self, dynamicKeyPartList: Iterable[str]) -> bool Returns True if the settings is contained in the underlying QSettings.

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

Parameters

dynamicKeyPart (str = '') –

Return type

bool

hasDynamicKey(self) → bool

Returns True if a part of the settings key is built dynamically.

Return type

bool

key(self, dynamicKeyPart: str = '') → str

Returns settings entry key.

The dynamicKeyPart argument specifies the dynamic part of the settings key.

key(self, dynamicKeyPartList: Iterable[str]) -> str Returns settings entry key.

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

Parameters

dynamicKeyPart (str = '') –

Return type

str

keyIsValid(self, key: str) → bool

Returns True if the provided key match the settings entry.

This is useful for settings with dynamic keys. For example this permits one to check that the settings key “NewsFeed/httpsfeedqgisorg/27/content” is valid for the settings entry defined with the key “NewsFeed/%1/%2/content”

The key to check

Parameters

key (str) –

Return type

bool

remove(self, dynamicKeyPart: str = '')

Removes the settings from the underlying QSettings.

The dynamicKeyPart argument specifies the dynamic part of the settings key.

remove(self, dynamicKeyPartList: Iterable[str]) Removes the settings from the underlying QSettings.

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

Parameters

dynamicKeyPart (str = '') –

section(self) → QgsSettings.Section

Returns settings section. The settings section of the parent group is returned if available.

Return type

QgsSettings.Section

setVariantValue(self, value: Any, dynamicKeyPart: str = '') → bool

Set settings value.

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

setVariantValue(self, value: Any, 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 (Any) –

  • dynamicKeyPart (str = '') –

Return type

bool

settingsType(self) → QgsSettingsEntryBase.SettingsType

Returns the settings entry type.

Return type

QgsSettingsEntryBase.SettingsType

valueAsVariant(self, dynamicKeyPart: str = '', useDefaultValueOverride: bool = False, defaultValueOverride: Any = None) → Any

Returns 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.

valueAsVariant(self, dynamicKeyPartList: Iterable[str], useDefaultValueOverride: bool = False, defaultValueOverride: Any = None) -> Any Returns 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 (Any = None) –

Return type

Any