Class: QgsSettingsEntryInteger

class qgis.core.QgsSettingsEntryInteger

Bases: QgsSettingsEntryByValueintBase

An integer settings entry.

New in version 3.20.

QgsSettingsEntryInteger(name: str, parent: QgsSettingsTreeNode, defaultValue: int = 0, description: str = ‘’, options: Union[Qgis.SettingsOptions, Qgis.SettingsOption] = Qgis.SettingsOptions(), minValue: int = INT_MIN, maxValue: int = INT_MAX) Constructor for QgsSettingsEntryInteger.

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.

  • minValue – specifies the minimal value.

  • maxValue – specifies the maximal value.

QgsSettingsEntryInteger(key: str, pluginName: str, defaultValue: int = 0, description: str = ‘’, options: Union[Qgis.SettingsOptions, Qgis.SettingsOption] = Qgis.SettingsOptions(), minValue: int = INT_MIN, maxValue: int = INT_MAX) Constructor for QgsSettingsEntryInteger. This constructor is intended to be used from plugins.

Parameters:

  • key – specifies the key of the settings.

  • pluginName – is used to define the key of the setting

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

  • minValue – specifies the minimal value.

  • maxValue – specifies the maximal value.

QgsSettingsEntryInteger(QgsSettingsEntryInteger)

Methods

checkValue

Check if the value is valid

convertFromVariant

Converts the variant value to the value type of the setting

convertToVariant

Converts the value to a variant

maxValue

Returns the maximum value.

minValue

Returns the minimum value.

setValuePrivate

Sets the settings value with an optional list of dynamic parts

setVariantValuePrivate

Sets the settings value with a variant value.

settingsType

rtype:

Qgis.SettingsType
checkValue(self, value: int) → bool

Check if the value is valid

convertFromVariant(self, value: Any) → int

Converts the variant value to the value type of the setting

convertToVariant(self, value: int) → Any

Converts the value to a variant

maxValue(self) → int

Returns the maximum value.

Return type:

int

minValue(self) → int

Returns the minimum value.

Return type:

int

setValuePrivate(self, value: int, dynamicKeyPartList: Iterable[str]) → bool

Sets the settings value with an optional list of dynamic parts

setVariantValuePrivate(self, value: Any, dynamicKeyPartList: Iterable[str] = []) → bool

Sets the settings value with a variant value. This should be called from any implementation as it takes care of actually calling QSettings

New in version 3.26.

settingsType(self) → Qgis.SettingsType
Return type:

Qgis.SettingsType