Class: QgsSettingsEntryVariant

class qgis.core.QgsSettingsEntryVariant

Bases: QgsSettingsEntryBaseTemplateQVariantBase

A variant settings entry.

New in version 3.20.

QgsSettingsEntryVariant(name: str, parent: QgsSettingsTreeNode, defaultValue: Any = None, description: str = ‘’, options: Union[Qgis.SettingsOptions, Qgis.SettingsOption] = Qgis.SettingsOptions()) Constructor for QgsSettingsEntryVariant.

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.

New in version 3.30.

QgsSettingsEntryVariant(key: str, pluginName: str, defaultValue: Any = None, description: str = ‘’, options: Union[Qgis.SettingsOptions, Qgis.SettingsOption] = Qgis.SettingsOptions()) Constructor for QgsSettingsEntryVariant. This constructor is intended to be used from plugins.

Parameters:
  • key – specifies the key of the settings.

  • pluginName – is inserted in the key after the section.

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

QgsSettingsEntryVariant(QgsSettingsEntryVariant)

Methods

checkValuePrivate

Check if the value is valid

convertFromVariant

param value:

convertToVariant

Converts the value to a variant

setValuePrivate

Sets the settings value with an optional list of dynamic parts

settingsType

rtype:

Qgis.SettingsType

valueAs

Returns settings value.

checkValuePrivate(self, value: Any) bool

Check if the value is valid

convertFromVariant(self, value: Any) Any
Parameters:

value (Any) –

Return type:

Any

convertToVariant(self, value: Any) Any

Converts the value to a variant

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

Sets the settings value with an optional list of dynamic parts

settingsType(self) Qgis.SettingsType
Return type:

Qgis.SettingsType

valueAs(self, type: object) object

Returns settings value.

Parameters:

type (object) – is the Python type of the value to be returned

Return type:

object