Search for usage in LXR

KCoreConfigSkeleton::ItemEnum Class Reference

#include <kcoreconfigskeleton.h>

Inheritance diagram for KCoreConfigSkeleton::ItemEnum:

Public Member Functions

 ItemEnum (const QString &_group, const QString &_key, qint32 &reference, const QList< Choice > &choices, qint32 defaultValue=0)
QList< Choice > choices () const
void readConfig (KConfig *config) override
void setValueForChoice (const QString &name, const QString &valueForChoice)
QString valueForChoice (const QString &name) const
void writeConfig (KConfig *config) override
- Public Member Functions inherited from KCoreConfigSkeleton::ItemInt
 ItemInt (const QString &_group, const QString &_key, qint32 &reference, qint32 defaultValue=0)
bool isEqual (const QVariant &p) const override
QVariant maxValue () const override
QVariant minValue () const override
QVariant property () const override
void setMaxValue (qint32)
void setMinValue (qint32)
void setProperty (const QVariant &p) override
- Public Member Functions inherited from KConfigSkeletonGenericItem< qint32 >
 KConfigSkeletonGenericItem (const QString &_group, const QString &_key, qint32 &reference, qint32 defaultValue)
void readDefault (KConfig *config) override
void setDefault () override
virtual void setDefaultValue (const qint32 &v)
void setValue (const qint32 &v)
void swapDefault () override
qint32 & value ()
const qint32 & value () const
void writeConfig (KConfig *config) override
- Public Member Functions inherited from KConfigSkeletonItem
 KConfigSkeletonItem (const QString &_group, const QString &_key)
virtual ~KConfigSkeletonItem ()
KConfigGroup configGroup (KConfig *config) const
QVariant getDefault () const
QString group () const
bool isDefault () const
bool isImmutable () const
bool isSaveNeeded () const
QString key () const
QString label () const
QString name () const
void setGroup (const KConfigGroup &cg)
void setGroup (const QString &_group)
void setKey (const QString &_key)
void setLabel (const QString &l)
void setName (const QString &_name)
void setToolTip (const QString &t)
void setWhatsThis (const QString &w)
void setWriteFlags (KConfigBase::WriteConfigFlags flags)
QString toolTip () const
QString whatsThis () const
KConfigBase::WriteConfigFlags writeFlags () const

Additional Inherited Members

- Public Types inherited from KConfigSkeletonItem
typedef QHash< QString, KConfigSkeletonItem * > Dict
typedef QHash< QString, KConfigSkeletonItem * >::Iterator DictIterator
typedef QList< KConfigSkeletonItem * > List
- Protected Member Functions inherited from KConfigSkeletonItem
KCONFIGCORE_NO_EXPORT KConfigSkeletonItem (KConfigSkeletonItemPrivate &dd, const QString &_group, const QString &_key)
void readImmutability (const KConfigGroup &group)
void setGetDefaultImpl (const std::function< QVariant()> &impl)
void setIsDefaultImpl (const std::function< bool()> &impl)
void setIsSaveNeededImpl (const std::function< bool()> &impl)
- Protected Attributes inherited from KConfigSkeletonGenericItem< qint32 >
qint32 mDefault
qint32 mLoadedValue
qint32 & mReference
- Protected Attributes inherited from KConfigSkeletonItem
KConfigSkeletonItemPrivate *const d_ptr
QString mGroup
QString mKey
QString mName

Detailed Description

Class for handling enums.

Definition at line 772 of file kcoreconfigskeleton.h.

Constructor & Destructor Documentation

◆ ItemEnum()

KCoreConfigSkeleton::ItemEnum::ItemEnum ( const QString _group,
const QString _key,
qint32 &  reference,
const QList< Choice > &  choices,
qint32  defaultValue = 0 


_groupConfig file group.
_keyConfig file key.
referenceThe initial value to hold in the item
defaultValueThe default value for the item
choicesThe list of enums that can be stored in this item

Definition at line 597 of file kcoreconfigskeleton.cpp.

Member Function Documentation

◆ readConfig()

void KCoreConfigSkeleton::ItemEnum::readConfig ( KConfig config)

This function is called by KCoreConfigSkeleton to read the value for this setting from a config file.

Reimplemented from KCoreConfigSkeleton::ItemInt.

Definition at line 603 of file kcoreconfigskeleton.cpp.

◆ setValueForChoice()

void KCoreConfigSkeleton::ItemEnum::setValueForChoice ( const QString name,
const QString valueForChoice 

Stores a choice value for name.

Definition at line 592 of file kcoreconfigskeleton.cpp.

◆ valueForChoice()

QString KCoreConfigSkeleton::ItemEnum::valueForChoice ( const QString name) const

Returns the value for the choice with the given name.

Definition at line 584 of file kcoreconfigskeleton.cpp.

◆ writeConfig()

void KCoreConfigSkeleton::ItemEnum::writeConfig ( KConfig config)

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().

Implements KConfigSkeletonItem.

Definition at line 628 of file kcoreconfigskeleton.cpp.

The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2023 The KDE developers.
Generated on Wed Jun 7 2023 04:06:31 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.