Class: QgsSettingsEntryString

class qgis.core.QgsSettingsEntryString

Bases: QgsSettingsEntryBase

A string settings entry.

New in version 3.20.

QgsSettingsEntryString(key: str, pluginName: str, defaultValue: str = ‘’, description: str = ‘’) Constructor for QgsSettingsEntryString. 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.

QgsSettingsEntryString(QgsSettingsEntryString)

Methods

defaultValue

Get settings default value.

maxLength

Returns the string maximum length.

minLength

Returns the string minimum length.

setMaxLength

Set the string maximum length.

setMinLength

Set the string minimum length.

setValue

Set settings value.

settingsType

copydoc QgsSettingsEntryBase.settingsType

value

Get settings value.

defaultValue(self)str

Get settings default value.

Return type

str

maxLength(self)int

Returns the string maximum length. By -1 there is no limitation.

Return type

int

minLength(self)int

Returns the string minimum length.

Return type

int

setMaxLength(self, maxLength: int)

Set the string maximum length.

maxLength The string maximum length.

Parameters

maxLength (int) –

setMinLength(self, minLength: int)

Set the string minimum length.

minLength The string minimum length.

Parameters

minLength (int) –

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

Set settings value.

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

setValue(self, value: str, 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 (str) –

  • dynamicKeyPart (str = '') –

Return type

bool

settingsType(self)QgsSettingsEntryBase.SettingsType

copydoc QgsSettingsEntryBase.settingsType

Return type

QgsSettingsEntryBase.SettingsType

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

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: str = ‘’) -> str 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 (str = '') –

Return type

str