Class: QgsSettingsEntryColor

class qgis.core.QgsSettingsEntryColor

Bases: QgsSettingsEntryByReferenceQColorBase

A color settings entry.

New in version 3.20.

QgsSettingsEntryColor(name: str, parent: QgsSettingsTreeNode, defaultValue: Union[QColor, Qt.GlobalColor] = QColor(), description: str = ‘’, options: Union[Qgis.SettingsOptions, Qgis.SettingsOption] = Qgis.SettingsOptions(), allowAlpha: bool = True) Constructor for QgsSettingsEntryColor.

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.

  • allowAlpha – specifies if the color can have transparency.

QgsSettingsEntryColor(key: str, pluginName: str, defaultValue: Union[QColor, Qt.GlobalColor] = QColor(), description: str = ‘’, options: Union[Qgis.SettingsOptions, Qgis.SettingsOption] = Qgis.SettingsOptions(), allowAlpha: bool = True) Constructor for QgsSettingsEntryColor. 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.

QgsSettingsEntryColor(QgsSettingsEntryColor)

Methods

allowAlpha

Returns True if transparency is allowed for the color

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

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
allowAlpha(self) → bool

Returns True if transparency is allowed for the color

New in version 3.30.

Return type:

bool

checkValue(self, value: QColor | Qt.GlobalColor) → bool

Check if the value is valid

convertFromVariant(self, value: Any) → QColor

Converts the variant value to the value type of the setting

convertToVariant(self, value: QColor | Qt.GlobalColor) → Any

Converts the value to a variant

setValuePrivate(self, value: QColor | Qt.GlobalColor, 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