KConfig 5.109.0
|
Class for storing a preferences setting. More...
#include <KCoreConfigSkeleton>
Public Types | |
typedef QHash< QString, KConfigSkeletonItem * > | Dict |
typedef QHash< QString, KConfigSkeletonItem * >::Iterator | DictIterator |
typedef QList< KConfigSkeletonItem * > | List |
Public Member Functions | |
KConfigSkeletonItem (const QString &_group, const QString &_key) | |
Constructor. | |
virtual | ~KConfigSkeletonItem () |
Destructor. | |
KConfigGroup | configGroup (KConfig *config) const |
Return a KConfigGroup, the one provided by setGroup(const KConfigGroup&) if it's valid, or make one from config and item's group. | |
QVariant | getDefault () const |
Returns the default value. | |
QString | group () const |
Return name of config file group. | |
bool | isDefault () const |
Indicates if the item is set to its default value. | |
virtual bool | isEqual (const QVariant &p) const =0 |
Check whether the item is equal to p . | |
bool | isImmutable () const |
Return if the entry can be modified. | |
bool | isSaveNeeded () const |
Indicates if the item has a different value than the previously loaded value. | |
QString | key () const |
Return config file key. | |
QString | label () const |
Return the label of the item. | |
virtual QVariant | maxValue () const |
Return maximum value of item or invalid if not specified. | |
virtual QVariant | minValue () const |
Return minimum value of item or invalid if not specified. | |
QString | name () const |
Return internal name of entry. | |
virtual QVariant | property () const =0 |
Return item as property. | |
virtual void | readConfig (KConfig *)=0 |
This function is called by KCoreConfigSkeleton to read the value for this setting from a config file. | |
virtual void | readDefault (KConfig *)=0 |
Read global default value. | |
virtual void | setDefault ()=0 |
Sets the current value to the default value. | |
void | setGroup (const KConfigGroup &cg) |
Set config file group but giving the KConfigGroup. | |
void | setGroup (const QString &_group) |
Set config file group. | |
void | setKey (const QString &_key) |
Set config file key. | |
void | setLabel (const QString &l) |
Set label providing a translated one-line description of the item. | |
void | setName (const QString &_name) |
Set internal name of entry. | |
virtual void | setProperty (const QVariant &p)=0 |
Set item to p . | |
void | setToolTip (const QString &t) |
Set ToolTip description of item. | |
void | setWhatsThis (const QString &w) |
Set WhatsThis description of item. | |
void | setWriteFlags (KConfigBase::WriteConfigFlags flags) |
The write flags to be used when writing configuration. | |
virtual void | swapDefault ()=0 |
Exchanges the current value with the default value Used by KCoreConfigSkeleton::useDefaults(bool);. | |
QString | toolTip () const |
Return ToolTip description of item. | |
QString | whatsThis () const |
Return WhatsThis description of item. | |
virtual void | writeConfig (KConfig *)=0 |
This function is called by KCoreConfigSkeleton to write the value of this setting to a config file. | |
KConfigBase::WriteConfigFlags | writeFlags () const |
Return write flags to be used when writing configuration. | |
Protected Member Functions | |
__attribute__ ((visibility("hidden"))) explicit KConfigSkeletonItem(KConfigSkeletonItemPrivate &dd | |
void | readImmutability (const KConfigGroup &group) |
Sets mIsImmutable to true if mKey in config is immutable. | |
void | setGetDefaultImpl (const std::function< QVariant()> &impl) |
void | setIsDefaultImpl (const std::function< bool()> &impl) |
void | setIsSaveNeededImpl (const std::function< bool()> &impl) |
Protected Attributes | |
const QString & | _group |
const QString const QString & | _key |
KConfigSkeletonItemPrivate *const | d_ptr |
QString | mGroup |
The group name for this item. | |
QString | mKey |
The config key for this item. | |
QString | mName |
The name of this item. | |
Class for storing a preferences setting.
This class represents one preferences setting as used by KCoreConfigSkeleton. Subclasses of KConfigSkeletonItem implement storage functions for a certain type of setting. Normally you don't have to use this class directly. Use the special addItem() functions of KCoreConfigSkeleton instead. If you subclass this class you will have to register instances with the function KCoreConfigSkeleton::addItem().
KConfigSkeletonItem::KConfigSkeletonItem | ( | const QString & | _group, |
const QString & | _key | ||
) |
Constructor.
_group | Config file group. |
_key | Config file key. |
|
virtual |
Destructor.
KConfigGroup KConfigSkeletonItem::configGroup | ( | KConfig * | config | ) | const |
Return a KConfigGroup, the one provided by setGroup(const KConfigGroup&) if it's valid, or make one from config
and item's group.
QVariant KConfigSkeletonItem::getDefault | ( | ) | const |
Returns the default value.
QString KConfigSkeletonItem::group | ( | ) | const |
Return name of config file group.
bool KConfigSkeletonItem::isDefault | ( | ) | const |
Indicates if the item is set to its default value.
|
pure virtual |
Check whether the item is equal to p
.
Use this function to compare items that use custom types, because QVariant::operator== will not work for those.
p | QVariant to compare to |
true
if the item is equal to p
, false
otherwise Implemented in KPropertySkeletonItem, KConfigCompilerSignallingItem, KCoreConfigSkeleton::ItemString, KCoreConfigSkeleton::ItemUrl, KCoreConfigSkeleton::ItemProperty, KCoreConfigSkeleton::ItemBool, KCoreConfigSkeleton::ItemInt, KCoreConfigSkeleton::ItemLongLong, KCoreConfigSkeleton::ItemUInt, KCoreConfigSkeleton::ItemULongLong, KCoreConfigSkeleton::ItemDouble, KCoreConfigSkeleton::ItemRect, KCoreConfigSkeleton::ItemPoint, KCoreConfigSkeleton::ItemSize, KCoreConfigSkeleton::ItemDateTime, KCoreConfigSkeleton::ItemStringList, KCoreConfigSkeleton::ItemUrlList, KCoreConfigSkeleton::ItemIntList, KConfigSkeleton::ItemColor, and KConfigSkeleton::ItemFont.
bool KConfigSkeletonItem::isImmutable | ( | ) | const |
Return if the entry can be modified.
bool KConfigSkeletonItem::isSaveNeeded | ( | ) | const |
Indicates if the item has a different value than the previously loaded value.
QString KConfigSkeletonItem::key | ( | ) | const |
Return config file key.
QString KConfigSkeletonItem::label | ( | ) | const |
Return the label of the item.
|
virtual |
Return maximum value of item or invalid if not specified.
Reimplemented in KConfigCompilerSignallingItem, KCoreConfigSkeleton::ItemInt, KCoreConfigSkeleton::ItemLongLong, KCoreConfigSkeleton::ItemUInt, KCoreConfigSkeleton::ItemULongLong, and KCoreConfigSkeleton::ItemDouble.
|
virtual |
Return minimum value of item or invalid if not specified.
Reimplemented in KConfigCompilerSignallingItem, KCoreConfigSkeleton::ItemInt, KCoreConfigSkeleton::ItemLongLong, KCoreConfigSkeleton::ItemUInt, KCoreConfigSkeleton::ItemULongLong, and KCoreConfigSkeleton::ItemDouble.
QString KConfigSkeletonItem::name | ( | ) | const |
Return internal name of entry.
|
pure virtual |
Return item as property.
Implemented in KPropertySkeletonItem, KConfigCompilerSignallingItem, KCoreConfigSkeleton::ItemString, KCoreConfigSkeleton::ItemUrl, KCoreConfigSkeleton::ItemProperty, KCoreConfigSkeleton::ItemBool, KCoreConfigSkeleton::ItemInt, KCoreConfigSkeleton::ItemLongLong, KCoreConfigSkeleton::ItemUInt, KCoreConfigSkeleton::ItemULongLong, KCoreConfigSkeleton::ItemDouble, KCoreConfigSkeleton::ItemRect, KCoreConfigSkeleton::ItemPoint, KCoreConfigSkeleton::ItemSize, KCoreConfigSkeleton::ItemDateTime, KCoreConfigSkeleton::ItemStringList, KCoreConfigSkeleton::ItemUrlList, KCoreConfigSkeleton::ItemIntList, KConfigSkeleton::ItemColor, and KConfigSkeleton::ItemFont.
|
pure virtual |
This function is called by KCoreConfigSkeleton to read the value for this setting from a config file.
Implemented in KPropertySkeletonItem, KConfigCompilerSignallingItem, KCoreConfigSkeleton::ItemString, KCoreConfigSkeleton::ItemUrl, KCoreConfigSkeleton::ItemProperty, KCoreConfigSkeleton::ItemBool, KCoreConfigSkeleton::ItemInt, KCoreConfigSkeleton::ItemLongLong, KCoreConfigSkeleton::ItemEnum, KCoreConfigSkeleton::ItemUInt, KCoreConfigSkeleton::ItemULongLong, KCoreConfigSkeleton::ItemDouble, KCoreConfigSkeleton::ItemRect, KCoreConfigSkeleton::ItemPoint, KCoreConfigSkeleton::ItemSize, KCoreConfigSkeleton::ItemDateTime, KCoreConfigSkeleton::ItemStringList, KCoreConfigSkeleton::ItemPathList, KCoreConfigSkeleton::ItemUrlList, KCoreConfigSkeleton::ItemIntList, KConfigSkeleton::ItemColor, and KConfigSkeleton::ItemFont.
|
pure virtual |
Read global default value.
Implemented in KPropertySkeletonItem, KConfigCompilerSignallingItem, KConfigSkeletonGenericItem< T >, KConfigSkeletonGenericItem< bool >, KConfigSkeletonGenericItem< double >, KConfigSkeletonGenericItem< QColor >, KConfigSkeletonGenericItem< QDateTime >, KConfigSkeletonGenericItem< QFont >, KConfigSkeletonGenericItem< qint32 >, KConfigSkeletonGenericItem< qint64 >, KConfigSkeletonGenericItem< QList< int > >, KConfigSkeletonGenericItem< QList< QUrl > >, KConfigSkeletonGenericItem< QPoint >, KConfigSkeletonGenericItem< QRect >, KConfigSkeletonGenericItem< QSize >, KConfigSkeletonGenericItem< QString >, KConfigSkeletonGenericItem< QStringList >, KConfigSkeletonGenericItem< quint32 >, KConfigSkeletonGenericItem< quint64 >, KConfigSkeletonGenericItem< QUrl >, and KConfigSkeletonGenericItem< QVariant >.
|
protected |
Sets mIsImmutable to true
if mKey in config is immutable.
group | KConfigGroup to check if mKey is immutable in |
|
pure virtual |
Sets the current value to the default value.
Implemented in KPropertySkeletonItem, KConfigSkeletonGenericItem< T >, KConfigSkeletonGenericItem< bool >, KConfigSkeletonGenericItem< double >, KConfigSkeletonGenericItem< QColor >, KConfigSkeletonGenericItem< QDateTime >, KConfigSkeletonGenericItem< QFont >, KConfigSkeletonGenericItem< qint32 >, KConfigSkeletonGenericItem< qint64 >, KConfigSkeletonGenericItem< QList< int > >, KConfigSkeletonGenericItem< QList< QUrl > >, KConfigSkeletonGenericItem< QPoint >, KConfigSkeletonGenericItem< QRect >, KConfigSkeletonGenericItem< QSize >, KConfigSkeletonGenericItem< QString >, KConfigSkeletonGenericItem< QStringList >, KConfigSkeletonGenericItem< quint32 >, KConfigSkeletonGenericItem< quint64 >, KConfigSkeletonGenericItem< QUrl >, KConfigSkeletonGenericItem< QVariant >, and KConfigCompilerSignallingItem.
void KConfigSkeletonItem::setGroup | ( | const KConfigGroup & | cg | ) |
void KConfigSkeletonItem::setGroup | ( | const QString & | _group | ) |
Set config file group.
void KConfigSkeletonItem::setKey | ( | const QString & | _key | ) |
Set config file key.
void KConfigSkeletonItem::setLabel | ( | const QString & | l | ) |
Set label providing a translated one-line description of the item.
void KConfigSkeletonItem::setName | ( | const QString & | _name | ) |
Set internal name of entry.
|
pure virtual |
Set item to p
.
Implemented in KPropertySkeletonItem, KConfigCompilerSignallingItem, KCoreConfigSkeleton::ItemString, KCoreConfigSkeleton::ItemUrl, KCoreConfigSkeleton::ItemProperty, KCoreConfigSkeleton::ItemBool, KCoreConfigSkeleton::ItemInt, KCoreConfigSkeleton::ItemLongLong, KCoreConfigSkeleton::ItemUInt, KCoreConfigSkeleton::ItemULongLong, KCoreConfigSkeleton::ItemDouble, KCoreConfigSkeleton::ItemRect, KCoreConfigSkeleton::ItemPoint, KCoreConfigSkeleton::ItemSize, KCoreConfigSkeleton::ItemDateTime, KCoreConfigSkeleton::ItemStringList, KCoreConfigSkeleton::ItemUrlList, KCoreConfigSkeleton::ItemIntList, KConfigSkeleton::ItemColor, and KConfigSkeleton::ItemFont.
void KConfigSkeletonItem::setToolTip | ( | const QString & | t | ) |
Set ToolTip description of item.
void KConfigSkeletonItem::setWhatsThis | ( | const QString & | w | ) |
Set WhatsThis description of item.
void KConfigSkeletonItem::setWriteFlags | ( | KConfigBase::WriteConfigFlags | flags | ) |
The write flags to be used when writing configuration.
|
pure virtual |
Exchanges the current value with the default value Used by KCoreConfigSkeleton::useDefaults(bool);.
Implemented in KPropertySkeletonItem, KConfigSkeletonGenericItem< T >, KConfigSkeletonGenericItem< bool >, KConfigSkeletonGenericItem< double >, KConfigSkeletonGenericItem< QColor >, KConfigSkeletonGenericItem< QDateTime >, KConfigSkeletonGenericItem< QFont >, KConfigSkeletonGenericItem< qint32 >, KConfigSkeletonGenericItem< qint64 >, KConfigSkeletonGenericItem< QList< int > >, KConfigSkeletonGenericItem< QList< QUrl > >, KConfigSkeletonGenericItem< QPoint >, KConfigSkeletonGenericItem< QRect >, KConfigSkeletonGenericItem< QSize >, KConfigSkeletonGenericItem< QString >, KConfigSkeletonGenericItem< QStringList >, KConfigSkeletonGenericItem< quint32 >, KConfigSkeletonGenericItem< quint64 >, KConfigSkeletonGenericItem< QUrl >, KConfigSkeletonGenericItem< QVariant >, and KConfigCompilerSignallingItem.
QString KConfigSkeletonItem::toolTip | ( | ) | const |
QString KConfigSkeletonItem::whatsThis | ( | ) | const |
Return WhatsThis description of item.
|
pure virtual |
This function is called by KCoreConfigSkeleton to write the value of this setting to a config file.
Make sure to pass writeFlags() to every call of KConfigGroup::writeEntry() and KConfigGroup::revertToDefault().
Implemented in KPropertySkeletonItem, KConfigCompilerSignallingItem, KConfigSkeletonGenericItem< T >, KConfigSkeletonGenericItem< bool >, KConfigSkeletonGenericItem< double >, KConfigSkeletonGenericItem< QColor >, KConfigSkeletonGenericItem< QDateTime >, KConfigSkeletonGenericItem< QFont >, KConfigSkeletonGenericItem< qint32 >, KConfigSkeletonGenericItem< qint64 >, KConfigSkeletonGenericItem< QList< int > >, KConfigSkeletonGenericItem< QList< QUrl > >, KConfigSkeletonGenericItem< QPoint >, KConfigSkeletonGenericItem< QRect >, KConfigSkeletonGenericItem< QSize >, KConfigSkeletonGenericItem< QString >, KConfigSkeletonGenericItem< QStringList >, KConfigSkeletonGenericItem< quint32 >, KConfigSkeletonGenericItem< quint64 >, KConfigSkeletonGenericItem< QUrl >, KConfigSkeletonGenericItem< QVariant >, KCoreConfigSkeleton::ItemString, KCoreConfigSkeleton::ItemUrl, KCoreConfigSkeleton::ItemEnum, KCoreConfigSkeleton::ItemPathList, and KCoreConfigSkeleton::ItemUrlList.
KConfigBase::WriteConfigFlags KConfigSkeletonItem::writeFlags | ( | ) | const |
Return write flags to be used when writing configuration.
They should be passed to every call of KConfigGroup::writeEntry() and KConfigGroup::revertToDefault().
|
protected |
The group name for this item.
|
protected |
The config key for this item.
|
protected |
The name of this item.