A string settings entry. More...

#include <qgssettingsentryimpl.h>

Inheritance diagram for QgsSettingsEntryString:

Public Member Functions
	QgsSettingsEntryString (const QString &key, const QString &section, const QString &defaultValue=QString(), const QString &description=QString(), Qgis::SettingsOptions options=Qgis::SettingsOptions(), int minLength=0, int maxLength=-1) SIP_THROW(QgsSettingsException) SIP_MAKE_PRIVATE
	Constructor for QgsSettingsEntryString. More...

	QgsSettingsEntryString (const QString &name, QgsSettingsTreeNode *parent, const QString &defaultValue=QString(), const QString &description=QString(), Qgis::SettingsOptions options=Qgis::SettingsOptions(), int minLength=0, int maxLength=-1) SIP_THROW(QgsSettingsException)
	Constructor for QgsSettingsEntryString. More...

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

int	maxLength () const
	Returns the string maximum length. More...

int	minLength () const
	Returns the string minimum length. More...

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

Public Member Functions inherited from QgsSettingsEntryBaseTemplate< QString >
	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 QString	convertFromVariant (const QVariant &value) const=0
	Converts the variant value to the value type of the setting. More...

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

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

QString	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 QString &value, const QString &dynamicKeyPart=QString()) const
	Set settings value. More...

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

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

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

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

QString	valueWithDefaultOverride (const QString &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()) SIP_THROW(QgsSettingsException)
	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...

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	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< QString >
virtual bool	checkValuePrivate (const QString &value) const
	Check if the value is valid. More...

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

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

Detailed Description

A string settings entry.

Since: QGIS 3.20

Definition at line 127 of file qgssettingsentryimpl.h.

Constructor & Destructor Documentation

◆ QgsSettingsEntryString() [1/2]

QgsSettingsEntryString::QgsSettingsEntryString	(	const QString &	name,
		QgsSettingsTreeNode *	parent,
		const QString &	defaultValue = `QString()`,
		const QString &	description = `QString()`,
		Qgis::SettingsOptions	options = `Qgis::SettingsOptions()`,
		int	minLength = `0`,
		int	maxLength = `-1`
	)

inline

Constructor for QgsSettingsEntryString.

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.
minLength	specifies the minimal length of the string value. 0 means no limit.
maxLength	specifies the maximal length of the string value. -1 means no limit.

Definition at line 142 of file qgssettingsentryimpl.h.

◆ QgsSettingsEntryString() [2/2]

QgsSettingsEntryString::QgsSettingsEntryString	(	const QString &	key,
		const QString &	section,
		const QString &	defaultValue = `QString()`,
		const QString &	description = `QString()`,
		Qgis::SettingsOptions	options = `Qgis::SettingsOptions()`,
		int	minLength = `0`,
		int	maxLength = `-1`
	)

inline

Constructor for QgsSettingsEntryString.

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.
minLength	specifies the minimal length of the string value. 0 means no limit.
maxLength	specifies the maximal length of the string value. -1 means no limit.

Definition at line 165 of file qgssettingsentryimpl.h.

Member Function Documentation

◆ convertFromVariant()

QString QgsSettingsEntryString::convertFromVariant ( const QVariant & value ) const

overridevirtual

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

Implements QgsSettingsEntryBaseTemplate< QString >.

Definition at line 49 of file qgssettingsentryimpl.cpp.

◆ maxLength()

int QgsSettingsEntryString::maxLength ( ) const

Returns the string maximum length.

By -1 there is no limitation.

Definition at line 64 of file qgssettingsentryimpl.cpp.

◆ minLength()

int QgsSettingsEntryString::minLength ( ) const

Returns the string minimum length.

Definition at line 59 of file qgssettingsentryimpl.cpp.

◆ settingsType()

Qgis::SettingsType QgsSettingsEntryString::settingsType ( ) const

overridevirtual

Returns the settings entry type.