KDECore
KConfigSkeletonItem Class Reference
#include <KConfigSkeletonItem>

Detailed Description
Class for storing a preferences setting.
- See also:
- KCoreConfigSkeleton
Definition at line 52 of file kcoreconfigskeleton.h.
Public Types | |
typedef QHash< QString, KConfigSkeletonItem * > | Dict |
typedef QHash< QString, KConfigSkeletonItem * > ::Iterator | DictIterator |
typedef QList < KConfigSkeletonItem * > | List |
Public Member Functions | |
QString | group () const |
virtual bool | isEqual (const QVariant &v) const =0 |
bool | isImmutable () const |
KConfigSkeletonItem (const QString &_group, const QString &_key) | |
QString | key () const |
QString | label () const |
virtual QVariant | maxValue () const |
virtual QVariant | minValue () const |
QString | name () const |
virtual QVariant | property () const =0 |
virtual void | readConfig (KConfig *)=0 |
virtual void | readDefault (KConfig *)=0 |
virtual void | setDefault ()=0 |
void | setGroup (const QString &_group) |
void | setKey (const QString &_key) |
void | setLabel (const QString &l) |
void | setName (const QString &_name) |
virtual void | setProperty (const QVariant &p)=0 |
void | setWhatsThis (const QString &w) |
virtual void | swapDefault ()=0 |
QString | whatsThis () const |
virtual void | writeConfig (KConfig *)=0 |
virtual | ~KConfigSkeletonItem () |
Protected Member Functions | |
void | readImmutability (const KConfigGroup &group) |
Protected Attributes | |
QString | mGroup |
QString | mKey |
QString | mName |
Member Typedef Documentation
typedef QHash< QString, KConfigSkeletonItem* > KConfigSkeletonItem::Dict |
Definition at line 56 of file kcoreconfigskeleton.h.
typedef QHash< QString, KConfigSkeletonItem* >::Iterator KConfigSkeletonItem::DictIterator |
Definition at line 57 of file kcoreconfigskeleton.h.
typedef QList< KConfigSkeletonItem * > KConfigSkeletonItem::List |
Definition at line 55 of file kcoreconfigskeleton.h.
Constructor & Destructor Documentation
Constructor.
- Parameters:
-
_group Config file group. _key Config file key.
Definition at line 31 of file kcoreconfigskeleton.cpp.
KConfigSkeletonItem::~KConfigSkeletonItem | ( | ) | [virtual] |
Member Function Documentation
QString KConfigSkeletonItem::group | ( | ) | const |
Check whether the item is equal to v.
Use this function to compare items that use custom types such as KUrl, because QVariant::operator== will not work for those.
- Parameters:
-
v QVariant to compare to
- Returns:
- true if the item is equal to v, false otherwise
Implemented in 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, and KCoreConfigSkeleton::ItemIntList.
bool KConfigSkeletonItem::isImmutable | ( | ) | const |
QString KConfigSkeletonItem::key | ( | ) | const |
QString KConfigSkeletonItem::label | ( | ) | const |
QVariant KConfigSkeletonItem::maxValue | ( | ) | const [virtual] |
Return maximum value of item or invalid if not specified.
Reimplemented in KCoreConfigSkeleton::ItemInt, KCoreConfigSkeleton::ItemLongLong, KCoreConfigSkeleton::ItemUInt, KCoreConfigSkeleton::ItemULongLong, and KCoreConfigSkeleton::ItemDouble.
Definition at line 99 of file kcoreconfigskeleton.cpp.
QVariant KConfigSkeletonItem::minValue | ( | ) | const [virtual] |
Return minimum value of item or invalid if not specified.
Reimplemented in KCoreConfigSkeleton::ItemInt, KCoreConfigSkeleton::ItemLongLong, KCoreConfigSkeleton::ItemUInt, KCoreConfigSkeleton::ItemULongLong, and KCoreConfigSkeleton::ItemDouble.
Definition at line 94 of file kcoreconfigskeleton.cpp.
QString KConfigSkeletonItem::name | ( | ) | const |
virtual QVariant KConfigSkeletonItem::property | ( | ) | const [pure virtual] |
Return item as property.
Implemented in 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, and KCoreConfigSkeleton::ItemIntList.
virtual void KConfigSkeletonItem::readConfig | ( | KConfig * | ) | [pure virtual] |
This function is called by KCoreConfigSkeleton to read the value for this setting from a config file.
Implemented in 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, and KCoreConfigSkeleton::ItemIntList.
virtual void KConfigSkeletonItem::readDefault | ( | KConfig * | ) | [pure virtual] |
Read global default value.
Implemented in KConfigSkeletonGenericItem< T >, KConfigSkeletonGenericItem< QList< int > >, KConfigSkeletonGenericItem< quint64 >, KConfigSkeletonGenericItem< double >, KConfigSkeletonGenericItem< QString >, KConfigSkeletonGenericItem< QVariant >, KConfigSkeletonGenericItem< KUrl >, KConfigSkeletonGenericItem< KUrl::List >, KConfigSkeletonGenericItem< QDateTime >, KConfigSkeletonGenericItem< QSize >, KConfigSkeletonGenericItem< bool >, KConfigSkeletonGenericItem< qint64 >, KConfigSkeletonGenericItem< quint32 >, KConfigSkeletonGenericItem< qint32 >, KConfigSkeletonGenericItem< QStringList >, KConfigSkeletonGenericItem< QRect >, and KConfigSkeletonGenericItem< QPoint >.
void KConfigSkeletonItem::readImmutability | ( | const KConfigGroup & | group | ) | [protected] |
sets mIsImmutable to true if mKey in config is immutable
- Parameters:
-
group KConfigGroup to check if mKey is immutable in
Definition at line 109 of file kcoreconfigskeleton.cpp.
virtual void KConfigSkeletonItem::setDefault | ( | ) | [pure virtual] |
Sets the current value to the default value.
Implemented in KConfigSkeletonGenericItem< T >, KConfigSkeletonGenericItem< QList< int > >, KConfigSkeletonGenericItem< quint64 >, KConfigSkeletonGenericItem< double >, KConfigSkeletonGenericItem< QString >, KConfigSkeletonGenericItem< QVariant >, KConfigSkeletonGenericItem< KUrl >, KConfigSkeletonGenericItem< KUrl::List >, KConfigSkeletonGenericItem< QDateTime >, KConfigSkeletonGenericItem< QSize >, KConfigSkeletonGenericItem< bool >, KConfigSkeletonGenericItem< qint64 >, KConfigSkeletonGenericItem< quint32 >, KConfigSkeletonGenericItem< qint32 >, KConfigSkeletonGenericItem< QStringList >, KConfigSkeletonGenericItem< QRect >, and KConfigSkeletonGenericItem< QPoint >.
void KConfigSkeletonItem::setGroup | ( | const QString & | _group | ) |
void KConfigSkeletonItem::setKey | ( | const QString & | _key | ) |
void KConfigSkeletonItem::setLabel | ( | const QString & | l | ) |
Set label providing a translated one-line description of the item.
Definition at line 74 of file kcoreconfigskeleton.cpp.
void KConfigSkeletonItem::setName | ( | const QString & | _name | ) |
virtual void KConfigSkeletonItem::setProperty | ( | const QVariant & | p | ) | [pure virtual] |
Set item to p
.
Implemented in 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, and KCoreConfigSkeleton::ItemIntList.
void KConfigSkeletonItem::setWhatsThis | ( | const QString & | w | ) |
virtual void KConfigSkeletonItem::swapDefault | ( | ) | [pure virtual] |
Exchanges the current value with the default value Used by KCoreConfigSkeleton::useDefaults(bool);.
Implemented in KConfigSkeletonGenericItem< T >, KConfigSkeletonGenericItem< QList< int > >, KConfigSkeletonGenericItem< quint64 >, KConfigSkeletonGenericItem< double >, KConfigSkeletonGenericItem< QString >, KConfigSkeletonGenericItem< QVariant >, KConfigSkeletonGenericItem< KUrl >, KConfigSkeletonGenericItem< KUrl::List >, KConfigSkeletonGenericItem< QDateTime >, KConfigSkeletonGenericItem< QSize >, KConfigSkeletonGenericItem< bool >, KConfigSkeletonGenericItem< qint64 >, KConfigSkeletonGenericItem< quint32 >, KConfigSkeletonGenericItem< qint32 >, KConfigSkeletonGenericItem< QStringList >, KConfigSkeletonGenericItem< QRect >, and KConfigSkeletonGenericItem< QPoint >.
QString KConfigSkeletonItem::whatsThis | ( | ) | const |
Return WhatsThis description of item.
See setWhatsThis().
Definition at line 89 of file kcoreconfigskeleton.cpp.
virtual void KConfigSkeletonItem::writeConfig | ( | KConfig * | ) | [pure virtual] |
This function is called by KCoreConfigSkeleton to write the value of this setting to a config file.
Implemented in KConfigSkeletonGenericItem< T >, KCoreConfigSkeleton::ItemString, KCoreConfigSkeleton::ItemUrl, KCoreConfigSkeleton::ItemEnum, KCoreConfigSkeleton::ItemPathList, KCoreConfigSkeleton::ItemUrlList, KConfigSkeletonGenericItem< QList< int > >, KConfigSkeletonGenericItem< quint64 >, KConfigSkeletonGenericItem< double >, KConfigSkeletonGenericItem< QString >, KConfigSkeletonGenericItem< QVariant >, KConfigSkeletonGenericItem< KUrl >, KConfigSkeletonGenericItem< KUrl::List >, KConfigSkeletonGenericItem< QDateTime >, KConfigSkeletonGenericItem< QSize >, KConfigSkeletonGenericItem< bool >, KConfigSkeletonGenericItem< qint64 >, KConfigSkeletonGenericItem< quint32 >, KConfigSkeletonGenericItem< qint32 >, KConfigSkeletonGenericItem< QStringList >, KConfigSkeletonGenericItem< QRect >, and KConfigSkeletonGenericItem< QPoint >.
Member Data Documentation
QString KConfigSkeletonItem::mGroup [protected] |
QString KConfigSkeletonItem::mKey [protected] |
QString KConfigSkeletonItem::mName [protected] |
The documentation for this class was generated from the following files: