Class: QgsSettingsEntryDouble¶
- class qgis.core.QgsSettingsEntryDouble¶
Bases:
QgsSettingsEntryBase
A double settings entry.
New in version 3.20.
QgsSettingsEntryDouble(key: str, pluginName: str, defaultValue: float, description: str = ‘’) Constructor for QgsSettingsEntryDouble. This constructor is intended to be used from plugins.
The
key
argument specifies the key of the settings. ThepluginName
argument is inserted in the key after the section. ThedefaultValueargument
specifies the default value for the settings entry. Thedescription
argument specifies a description for the settings entry.QgsSettingsEntryDouble(
QgsSettingsEntryDouble
)Methods
Returns settings default value.
Returns how much decimals should be shown in the Gui.
Returns the maximum value.
Returns the minimum value.
Set the display hint decimals.
Set the maximum value.
Set the minimum value.
Set settings value.
- rtype:
QgsSettingsEntryBase.SettingsType
Returns settings value.
- defaultValue(self) float ¶
Returns settings default value.
- Return type:
float
- displayHintDecimals(self) int ¶
Returns how much decimals should be shown in the Gui.
- Return type:
int
- maxValue(self) float ¶
Returns the maximum value.
- Return type:
float
- minValue(self) float ¶
Returns the minimum value.
- Return type:
float
- setDisplayHintDecimals(self, displayHintDecimals: int)¶
Set the display hint decimals.
displayHintDecimals The number of decimals that should be shown in the Gui.
- Parameters:
displayHintDecimals (int) –
- setMaxValue(self, maxValue: float)¶
Set the maximum value.
maxValue The maximum value.
- Parameters:
maxValue (float) –
- setMinValue(self, minValue: float)¶
Set the minimum value.
minValue The minimum value.
- Parameters:
minValue (float) –
- setValue(self, value: float, dynamicKeyPart: str = '') bool ¶
Set settings value.
The
value
to set. ThedynamicKeyPart
argument specifies the dynamic part of the settings key.setValue(self, value: float, dynamicKeyPartList: Iterable[str]) -> bool Set settings value.
The
value
to set. ThedynamicKeyParts
argument specifies the list of dynamic parts of the settings key.- Parameters:
value (float) –
dynamicKeyPart (str = '') –
- Return type:
bool
- settingsType(self) QgsSettingsEntryBase.SettingsType ¶
- Return type:
- value(self, dynamicKeyPart: str = '', useDefaultValueOverride: bool = False, defaultValueOverride: float = 0) float ¶
Returns settings value.
The
dynamicKeyPart
argument specifies the dynamic part of the settings key. TheuseDefaultValueOverride
argument specifies if defaultValueOverride should be used. ThedefaultValueOverride
argument if valid is used instead of the normal default value.value(self, dynamicKeyPartList: Iterable[str], useDefaultValueOverride: bool = False, defaultValueOverride: float = 0) -> float Returns settings value.
The
dynamicKeyParts
argument specifies the list of dynamic parts of the settings key. TheuseDefaultValueOverride
argument specifies if defaultValueOverride should be used. ThedefaultValueOverride
argument if valid is used instead of the normal default value.- Parameters:
dynamicKeyPart (str = '') –
useDefaultValueOverride (bool = False) –
defaultValueOverride (float = 0) –
- Return type:
float