A color settings entry. More...

#include <qgssettingsentryimpl.h>

Inheritance diagram for QgsSettingsEntryColor:

Public Member Functions
	QgsSettingsEntryColor (const QString &key, const QString &section, const QColor &defaultValue=QColor(), const QString &description=QString(), Qgis::SettingsOptions options=Qgis::SettingsOptions(), bool allowAlpha=true)
	Constructor for QgsSettingsEntryColor. More...

	QgsSettingsEntryColor (const QString &name, QgsSettingsTreeNode *parent, const QColor &defaultValue=QColor(), const QString &description=QString(), Qgis::SettingsOptions options=Qgis::SettingsOptions(), bool allowAlpha=true)
	Constructor for QgsSettingsEntryColor. More...

bool	allowAlpha () const
	Returns `true` if transparency is allowed for the color. More...

QColor	convertFromVariant (const QVariant &value) const override
	Converts the variant value to the value type of the setting. More...

bool	copyValueFromKeys (const QString &redKey, const QString &greenKey, const QString &blueKey, const QString &alphaKey=QString(), bool removeSettingAtKey=false) const
	Copies the value from the given keys if they exist. More...

void	copyValueToKeys (const QString &redKey, const QString &greenKey, const QString &blueKey, const QString &alphaKey=QString()) const
	Copies the settings to the given keys. More...

virtual Qgis::SettingsType	settingsType () const override
	Returns the settings entry type. More...

Public Member Functions inherited from QgsSettingsEntryBaseTemplate< QColor >
	QgsSettingsEntryBaseTemplate (const QString &key, const QString &section, const QVariant &defaultValue, const QString &description=QString(), Qgis::SettingsOptions options=Qgis::SettingsOptions())
	Constructor for QgsSettingsEntryByReference. More...

	QgsSettingsEntryBaseTemplate (const QString &name, QgsSettingsTreeNode *parent, const QVariant &defaultValue, const QString &description=QString(), Qgis::SettingsOptions options=Qgis::SettingsOptions())
	Constructor for QgsSettingsEntryByReference. More...

bool	checkValueVariant (const QVariant &value) const override
	Returns `true` if the given value is valid towards the setting definition. More...

virtual QColor	convertFromVariant (const QVariant &value) const=0
	Converts the variant value to the value type of the setting. More...

QColor	defaultValue () const
	Returns settings default value. More...

QColor	formerValue (const QString &dynamicKeyPart=QString()) const
	Returns the former value. More...

QColor	formerValue (const QStringList &dynamicKeyPartList) const
	Returns the former value Returns the current value (or default) if there is no former value. More...

virtual Qgis::SettingsType	settingsType () const override=0
	Returns the settings entry type. More...

bool	setValue (const QColor &value, const QString &dynamicKeyPart=QString()) const
	Set settings value. More...

bool	setValue (const QColor &value, const QStringList &dynamicKeyPartList) const
	Set settings value. More...

QColor	value (const QString &dynamicKeyPart=QString()) const
	Returns settings value. More...

QColor	value (const QStringList &dynamicKeyPartList) const
	Returns settings value. More...

QColor	valueWithDefaultOverride (const QColor &defaultValueOverride, const QString &dynamicKeyPart=QString()) const
	Returns the settings value with a defaultValueOverride and with an optional dynamicKeyPart. More...

QColor	valueWithDefaultOverride (const QColor &defaultValueOverride, const QStringList &dynamicKeyPartList) const
	Returns the settings value with a defaultValueOverride for the dynamicKeyPartList. More...

Public Member Functions inherited from QgsSettingsEntryBase
	QgsSettingsEntryBase (const QString &key, const QString &section, const QVariant &defaultValue=QVariant(), const QString &description=QString(), Qgis::SettingsOptions options=Qgis::SettingsOptions())
	Constructor for QgsSettingsEntryBase. More...

	QgsSettingsEntryBase (const QString &name, QgsSettingsTreeNode *parent, const QVariant &defaultValue=QVariant(), const QString &description=QString(), Qgis::SettingsOptions options=Qgis::SettingsOptions())
	Constructor for QgsSettingsEntryBase. More...

virtual	~QgsSettingsEntryBase ()
	Destructor for QgsSettingsEntryBase. More...

virtual bool	checkValueVariant (const QVariant &value) const
	Returns `true` if the given value is valid towards the setting definition. More...

bool	copyValueFromKey (const QString &key, bool removeSettingAtKey=false) const
	Copies the value from a given key if it exists. More...

bool	copyValueFromKey (const QString &key, const QStringList &dynamicKeyPartList, bool removeSettingAtKey=false) const
	Copies the value from a given key if it exists. More...

void	copyValueToKey (const QString &key, const QStringList &dynamicKeyPartList=QStringList()) const
	Copies the settings to the given key. More...

void	copyValueToKeyIfChanged (const QString &key, const QStringList &dynamicKeyPartList=QStringList()) const
	Copies the settings to the given key, if it has changed during the current QGIS session (see hasChanged()). More...

QVariant	defaultValueAsVariant () const
	Returns settings default value. More...

QString	definitionKey () const
	Returns settings entry defining key. More...

QString	description () const
	Returns the settings entry description. More...

bool	exists (const QString &dynamicKeyPart=QString()) const
	Returns `true` if the settings is contained in the underlying QSettings. More...

bool	exists (const QStringList &dynamicKeyPartList) const
	Returns `true` if the settings is contained in the underlying QSettings. More...

QVariant	formerValueAsVariant (const QString &dynamicKeyPart) const
	Returns the former value of the settings if it has been enabled in the options. More...

QVariant	formerValueAsVariant (const QStringList &dynamicKeyPartList) const
	Returns the former value of the settings if it has been enabled in the options Returns the current value (or default) if there is no former value. More...

bool	hasChanged () const
	Returns `true` if the setting was changed during the current QGIS session. More...

bool	hasDynamicKey () const
	Returns `true` if a part of the settings key is built dynamically. More...

QString	key (const QString &dynamicKeyPart=QString()) const
	Returns settings entry key. More...

QString	key (const QStringList &dynamicKeyPartList) const
	Returns settings entry key. More...

bool	keyIsValid (const QString &key) const
	Returns `true` if the provided key match the settings entry. More...

QString	name () const
	Returns the name of the settings. More...

Qgis::SettingsOptions	options () const
	Returns the settings options. More...

Qgis::SettingsOrigin	origin (const QStringList &dynamicKeyPartList) const
	Returns the origin of the setting if it exists. More...

QgsSettingsTreeNode *	parent () const
	Returns the parent tree element. More...

void	remove (const QString &dynamicKeyPart=QString()) const
	Removes the settings from the underlying QSettings. More...

void	remove (const QStringList &dynamicKeyPartList) const
	Removes the settings from the underlying QSettings. More...

Q_DECL_DEPRECATED int	section () const
	Returns settings section. More...

virtual Qgis::SettingsType	settingsType () const
	Returns the settings entry type. More...

bool	setVariantValue (const QVariant &value, const QString &dynamicKeyPart=QString()) const
	Set settings value. More...

bool	setVariantValue (const QVariant &value, const QStringList &dynamicKeyPartList) const
	Set settings value. More...

virtual QString	typeId () const
	Returns the id of the type of settings This can be re-implemented in a custom implementation of a setting. More...

Q_DECL_DEPRECATED QVariant	valueAsVariant (const QString &dynamicKeyPart, bool useDefaultValueOverride, const QVariant &defaultValueOverride) const
	Returns settings value with an optional default value override. More...

QVariant	valueAsVariant (const QString &dynamicKeyPart=QString()) const
	Returns settings value with. More...

QVariant	valueAsVariant (const QStringList &dynamicKeyPartList) const
	Returns settings value with. More...

Q_DECL_DEPRECATED QVariant	valueAsVariant (const QStringList &dynamicKeyPartList, bool useDefaultValueOverride, const QVariant &defaultValueOverride) const
	Returns settings value with an optional default value override. More...

QVariant	valueAsVariantWithDefaultOverride (const QVariant &defaultValueOverride, const QString &dynamicKeyPart=QString()) const
	Returns settings value with a defaultValueOverride. More...

QVariant	valueAsVariantWithDefaultOverride (const QVariant &defaultValueOverride, const QStringList &dynamicKeyPartList) const
	Returns settings value. More...

Additional Inherited Members
Static Public Member Functions inherited from QgsSettingsEntryBase
static QStringList	dynamicKeyPartToList (const QString &dynamicKeyPart)
	Transforms a dynamic key part string to list. More...

Protected Member Functions inherited from QgsSettingsEntryBaseTemplate< QColor >
virtual bool	checkValuePrivate (const QColor &value) const
	Check if the value is valid. More...

virtual QVariant	convertToVariant (const QColor &value) const
	Converts the value to a variant. More...

virtual bool	setValuePrivate (const QColor &value, const QStringList &dynamicKeyPartList) const
	Sets the settings value with an optional list of dynamic parts. More...

Detailed Description

A color settings entry.

Since: QGIS 3.20

Definition at line 693 of file qgssettingsentryimpl.h.

Constructor & Destructor Documentation

◆ QgsSettingsEntryColor() [1/2]

QgsSettingsEntryColor::QgsSettingsEntryColor	(	const QString &	name,
		QgsSettingsTreeNode *	parent,
		const QColor &	defaultValue = `QColor()`,
		const QString &	description = `QString()`,
		Qgis::SettingsOptions	options = `Qgis::SettingsOptions()`,
		bool	allowAlpha = `true`
	)

inline

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.

Definition at line 707 of file qgssettingsentryimpl.h.

◆ QgsSettingsEntryColor() [2/2]

QgsSettingsEntryColor::QgsSettingsEntryColor	(	const QString &	key,
		const QString &	section,
		const QColor &	defaultValue = `QColor()`,
		const QString &	description = `QString()`,
		Qgis::SettingsOptions	options = `Qgis::SettingsOptions()`,
		bool	allowAlpha = `true`
	)

inline

Constructor for QgsSettingsEntryColor.

Parameters

key	specifies the final part of the settings key.
section	specifies 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.
allowAlpha	specifies if the color can have transparency.

Definition at line 727 of file qgssettingsentryimpl.h.

Member Function Documentation

◆ allowAlpha()

bool QgsSettingsEntryColor::allowAlpha ( ) const

inline

Returns true if transparency is allowed for the color.

Since: QGIS 3.30

Definition at line 766 of file qgssettingsentryimpl.h.

◆ convertFromVariant()

QColor QgsSettingsEntryColor::convertFromVariant ( const QVariant & value ) const

overridevirtual

Converts the variant value to the value type of the setting.

Implements QgsSettingsEntryBaseTemplate< QColor >.

Definition at line 225 of file qgssettingsentryimpl.cpp.

◆ copyValueFromKeys()

bool QgsSettingsEntryColor::copyValueFromKeys	(	const QString &	redKey,
		const QString &	greenKey,
		const QString &	blueKey,
		const QString &	alphaKey = `QString()`,
		bool	removeSettingAtKey = `false`
	)		const

Copies the value from the given keys if they exist.

Returns: true if the keys exist and the settings values could be copied

Since: QGIS 3.30

Definition at line 246 of file qgssettingsentryimpl.cpp.

◆ copyValueToKeys()

void QgsSettingsEntryColor::copyValueToKeys	(	const QString &	redKey,
		const QString &	greenKey,
		const QString &	blueKey,
		const QString &	alphaKey = `QString()`
	)		const

Copies the settings to the given keys.

Since: QGIS 3.30

Definition at line 272 of file qgssettingsentryimpl.cpp.

◆ settingsType()

Qgis::SettingsType QgsSettingsEntryColor::settingsType ( ) const

overridevirtual

Returns the settings entry type.

Implements QgsSettingsEntryBaseTemplate< QColor >.

Definition at line 230 of file qgssettingsentryimpl.cpp.

The documentation for this class was generated from the following files:

/build/qgis-3.37.0+git20240325+fdefdf9c27f+17bookworm/src/core/settings/qgssettingsentryimpl.h
/build/qgis-3.37.0+git20240325+fdefdf9c27f+17bookworm/src/core/settings/qgssettingsentryimpl.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QgsSettingsEntryColor() [1/2]

◆ QgsSettingsEntryColor() [2/2]

Member Function Documentation

◆ allowAlpha()

◆ convertFromVariant()

◆ copyValueFromKeys()

◆ copyValueToKeys()

◆ settingsType()