QGIS API Documentation 3.40.0-Bratislava (b56115d8743)
|
A color settings entry. More...
#include <qgssettingsentryimpl.h>
Public Member Functions | |
QgsSettingsEntryColor (const QString &key, const QString §ion, const QColor &defaultValue=QColor(), const QString &description=QString(), Qgis::SettingsOptions options=Qgis::SettingsOptions(), bool allowAlpha=true) | |
Constructor for QgsSettingsEntryColor. | |
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. | |
bool | allowAlpha () const |
Returns true if transparency is allowed for the color. | |
QColor | convertFromVariant (const QVariant &value) const override |
Converts the variant value to the value type of the setting. | |
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. | |
void | copyValueToKeys (const QString &redKey, const QString &greenKey, const QString &blueKey, const QString &alphaKey=QString()) const |
Copies the settings to the given keys. | |
virtual Qgis::SettingsType | settingsType () const override |
Returns the settings entry type. | |
Public Member Functions inherited from QgsSettingsEntryBaseTemplate< QColor > | |
QgsSettingsEntryBaseTemplate (const QString &key, const QString §ion, const QVariant &defaultValue, const QString &description=QString(), Qgis::SettingsOptions options=Qgis::SettingsOptions()) | |
Constructor for QgsSettingsEntryByReference. | |
QgsSettingsEntryBaseTemplate (const QString &name, QgsSettingsTreeNode *parent, const QVariant &defaultValue, const QString &description=QString(), Qgis::SettingsOptions options=Qgis::SettingsOptions()) | |
Constructor for QgsSettingsEntryByReference. | |
bool | checkValueVariant (const QVariant &value) const override |
Returns true if the given value is valid towards the setting definition. | |
QColor | defaultValue () const |
Returns settings default value. | |
QColor | formerValue (const QString &dynamicKeyPart=QString()) const |
Returns the former value. | |
QColor | formerValue (const QStringList &dynamicKeyPartList) const |
Returns the former value Returns the current value (or default) if there is no former value. | |
bool | setValue (const QColor &value, const QString &dynamicKeyPart=QString()) const |
Set settings value. | |
bool | setValue (const QColor &value, const QStringList &dynamicKeyPartList) const |
Set settings value. | |
QColor | value (const QString &dynamicKeyPart=QString()) const |
Returns settings value. | |
QColor | value (const QStringList &dynamicKeyPartList) const |
Returns settings value. | |
QColor | valueWithDefaultOverride (const QColor &defaultValueOverride, const QString &dynamicKeyPart=QString()) const |
Returns the settings value with a defaultValueOverride and with an optional dynamicKeyPart. | |
QColor | valueWithDefaultOverride (const QColor &defaultValueOverride, const QStringList &dynamicKeyPartList) const |
Returns the settings value with a defaultValueOverride for the dynamicKeyPartList. | |
Public Member Functions inherited from QgsSettingsEntryBase | |
QgsSettingsEntryBase (const QString &key, const QString §ion, const QVariant &defaultValue=QVariant(), const QString &description=QString(), Qgis::SettingsOptions options=Qgis::SettingsOptions()) | |
Constructor for QgsSettingsEntryBase. | |
QgsSettingsEntryBase (const QString &name, QgsSettingsTreeNode *parent, const QVariant &defaultValue=QVariant(), const QString &description=QString(), Qgis::SettingsOptions options=Qgis::SettingsOptions()) | |
Constructor for QgsSettingsEntryBase. | |
virtual | ~QgsSettingsEntryBase () |
bool | copyValueFromKey (const QString &key, bool removeSettingAtKey=false) const |
Copies the value from a given key if it exists. | |
bool | copyValueFromKey (const QString &key, const QStringList &dynamicKeyPartList, bool removeSettingAtKey=false) const |
Copies the value from a given key if it exists. | |
void | copyValueToKey (const QString &key, const QStringList &dynamicKeyPartList=QStringList()) const |
Copies the settings to the given key. | |
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()). | |
QVariant | defaultValueAsVariant () const |
Returns settings default value. | |
QString | definitionKey () const |
Returns settings entry defining key. | |
QString | description () const |
Returns the settings entry description. | |
bool | exists (const QString &dynamicKeyPart=QString()) const |
Returns true if the settings is contained in the underlying QSettings. | |
bool | exists (const QStringList &dynamicKeyPartList) const |
Returns true if the settings is contained in the underlying QSettings. | |
QVariant | formerValueAsVariant (const QString &dynamicKeyPart) const |
Returns the former value of the settings if it has been enabled in the options. | |
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. | |
bool | hasChanged () const |
Returns true if the setting was changed during the current QGIS session. | |
bool | hasDynamicKey () const |
Returns true if a part of the settings key is built dynamically. | |
QString | key (const QString &dynamicKeyPart=QString()) const |
Returns settings entry key. | |
QString | key (const QStringList &dynamicKeyPartList) const |
Returns settings entry key. | |
bool | keyIsValid (const QString &key) const |
Returns true if the provided key match the settings entry. | |
QString | name () const |
Returns the name of the settings. | |
Qgis::SettingsOptions | options () const |
Returns the settings options. | |
Qgis::SettingsOrigin | origin (const QStringList &dynamicKeyPartList) const |
Returns the origin of the setting if it exists. | |
QgsSettingsTreeNode * | parent () const |
Returns the parent tree element. | |
void | remove (const QString &dynamicKeyPart=QString()) const |
Removes the settings from the underlying QSettings. | |
void | remove (const QStringList &dynamicKeyPartList) const |
Removes the settings from the underlying QSettings. | |
Q_DECL_DEPRECATED int | section () const |
Returns settings section. | |
bool | setVariantValue (const QVariant &value, const QString &dynamicKeyPart=QString()) const |
Set settings value. | |
bool | setVariantValue (const QVariant &value, const QStringList &dynamicKeyPartList) const |
Set settings value. | |
virtual QString | typeId () const |
Returns the id of the type of settings This can be re-implemented in a custom implementation of a setting. | |
Q_DECL_DEPRECATED QVariant | valueAsVariant (const QString &dynamicKeyPart, bool useDefaultValueOverride, const QVariant &defaultValueOverride) const |
Returns settings value with an optional default value override. | |
QVariant | valueAsVariant (const QString &dynamicKeyPart=QString()) const |
Returns settings value with. | |
QVariant | valueAsVariant (const QStringList &dynamicKeyPartList) const |
Returns settings value with. | |
Q_DECL_DEPRECATED QVariant | valueAsVariant (const QStringList &dynamicKeyPartList, bool useDefaultValueOverride, const QVariant &defaultValueOverride) const |
Returns settings value with an optional default value override. | |
QVariant | valueAsVariantWithDefaultOverride (const QVariant &defaultValueOverride, const QString &dynamicKeyPart=QString()) const |
Returns settings value with a defaultValueOverride. | |
QVariant | valueAsVariantWithDefaultOverride (const QVariant &defaultValueOverride, const QStringList &dynamicKeyPartList) const |
Returns settings value. | |
Additional Inherited Members | |
Static Public Member Functions inherited from QgsSettingsEntryBase | |
static QStringList | dynamicKeyPartToList (const QString &dynamicKeyPart) |
Transforms a dynamic key part string to list. | |
Protected Member Functions inherited from QgsSettingsEntryBaseTemplate< QColor > | |
virtual QVariant | convertToVariant (const QColor &value) const |
Converts the value to a variant. | |
virtual bool | setValuePrivate (const QColor &value, const QStringList &dynamicKeyPartList) const |
Sets the settings value with an optional list of dynamic parts. | |
|
inline |
Constructor for QgsSettingsEntryColor.
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.
|
inline |
Constructor for QgsSettingsEntryColor.
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.
|
inline |
Returns true
if transparency is allowed for the color.
Definition at line 766 of file qgssettingsentryimpl.h.
|
overridevirtual |
Converts the variant value to the value type of the setting.
Implements QgsSettingsEntryBaseTemplate< QColor >.
Definition at line 225 of file qgssettingsentryimpl.cpp.
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.
true
if the keys exist and the settings values could be copied Definition at line 246 of file qgssettingsentryimpl.cpp.
void QgsSettingsEntryColor::copyValueToKeys | ( | const QString & | redKey, |
const QString & | greenKey, | ||
const QString & | blueKey, | ||
const QString & | alphaKey = QString() |
||
) | const |
Copies the settings to the given keys.
Definition at line 272 of file qgssettingsentryimpl.cpp.
|
overridevirtual |
Returns the settings entry type.
Implements QgsSettingsEntryBaseTemplate< QColor >.
Definition at line 230 of file qgssettingsentryimpl.cpp.