Class: QgsSettingsEntryInteger

An integer settings entry.

Added in version 3.20.

Class Hierarchy

Inheritance diagram of qgis.core.QgsSettingsEntryInteger

Base classes

QgsSettingsEntryBaseTemplateintBase

Base abstract class for settings entries with typed get and set methods

QgsSettingsEntryBase

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.

Methods

maxValue

Returns the maximum value.

minValue

Returns the minimum value.
class qgis.core.QgsSettingsEntryInteger[source]

Bases: QgsSettingsEntryBaseTemplateintBase

__init__(name: str | None, parent: QgsSettingsTreeNode | None, defaultValue: int = 0, description: str | None = '', options: Qgis.SettingsOptions | Qgis.SettingsOption = Qgis.SettingsOptions(), minValue: int = INT_MIN, maxValue: int = INT_MAX)

Constructor for QgsSettingsEntryInteger.

Parameters:

  • name (Optional[str]) – specifies the name of the setting.

  • parent (Optional[QgsSettingsTreeNode]) – specifies the parent in the tree of settings.

  • defaultValue (int = 0) – specifies the default value for the settings entry.

  • description (Optional[str] = '') – specifies a description for the settings entry.

  • options (Union[Qgis.SettingsOptions, Qgis.SettingsOption] = Qgis.SettingsOptions()) – specifies the options for the settings entry.

  • minValue (int = INT_MIN) – specifies the minimal value.

  • maxValue (int = INT_MAX) – specifies the maximal value.

__init__(key: str | None, pluginName: str | None, defaultValue: int = 0, description: str | None = '', options: 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 (Optional[str]) – specifies the key of the settings.

  • pluginName (Optional[str]) – is used to define the key of the setting

  • defaultValue (int = 0) – specifies the default value for the settings entry.

  • description (Optional[str] = '') – specifies a description for the settings entry.

  • options (Union[Qgis.SettingsOptions, Qgis.SettingsOption] = Qgis.SettingsOptions()) – specifies the options for the settings entry.

  • minValue (int = INT_MIN) – specifies the minimal value.

  • maxValue (int = INT_MAX) – specifies the maximal value.

__init__(a0: QgsSettingsEntryInteger)
Parameters:

a0 (QgsSettingsEntryInteger)

maxValue(self) → int[source]

Returns the maximum value.

Return type:

int

minValue(self) → int[source]

Returns the minimum value.

Return type:

int