KConfigSkeleton Class Reference
#include <kconfigskeleton.h>
Detailed Description
Class for handling preferences settings for an application.
- Author:
- Cornelius Schumacher
- See also:
- KConfigSkeletonItem
Normally you will subclass KConfigSkeleton, add data members for the preferences settings and register the members in the constructor of the subclass.
Example:
class MyPrefs : public KConfigSkeleton { public: MyPrefs() { setCurrentGroup("MyGroup"); addItemBool("MySetting1",mMyBool,false); addItemColor("MySetting2",mMyColor,QColor(1,2,3)); setCurrentGroup("MyOtherGroup"); addItemFont("MySetting3",mMyFont,QFont("helvetica",12)); } bool mMyBool; QColor mMyColor; QFont mMyFont; }
It might be convenient in many cases to make this subclass of KConfigSkeleton a singleton for global access from all over the application without passing references to the KConfigSkeleton object around.
You can write the data to the configuration file by calling writeConfig() and read the data from the configuration file by calling readConfig().
If you have items, which are not covered by the existing addItem() functions you can add customized code for reading, writing and default setting by implementing the functions usrUseDefaults(), usrReadConfig() and usrWriteConfig().
Internally preferences settings are stored in instances of subclasses of KConfigSkeletonItem. You can also add KConfigSkeletonItem subclasses for your own types and call the generic addItem() to register them.
In many cases you don't have to write the specific KConfigSkeleton subclasses yourself, but you can use The KDE Configuration Compiler to automatically generate the C++ code from an XML description of the configuration options.
Definition at line 365 of file kconfigskeleton.h.
Public Member Functions | |
KConfigSkeleton (const QString &configname=QString::null) | |
KConfigSkeleton (KSharedConfig::Ptr config) | |
virtual | ~KConfigSkeleton () |
void | setDefaults () |
void | readConfig () |
void | writeConfig () |
void | setCurrentGroup (const QString &group) |
QString | currentGroup () |
void | addItem (KConfigSkeletonItem *, const QString &name=QString::null) |
ItemString * | addItemString (const QString &name, QString &reference, const QString &defaultValue=QString::fromLatin1(""), const QString &key=QString::null) |
ItemPassword * | addItemPassword (const QString &name, QString &reference, const QString &defaultValue=QString::fromLatin1(""), const QString &key=QString::null) |
ItemPath * | addItemPath (const QString &name, QString &reference, const QString &defaultValue=QString::fromLatin1(""), const QString &key=QString::null) |
ItemProperty * | addItemProperty (const QString &name, QVariant &reference, const QVariant &defaultValue=QVariant(), const QString &key=QString::null) |
ItemBool * | addItemBool (const QString &name, bool &reference, bool defaultValue=false, const QString &key=QString::null) |
ItemInt * | addItemInt (const QString &name, int &reference, int defaultValue=0, const QString &key=QString::null) |
ItemUInt * | addItemUInt (const QString &name, unsigned int &reference, unsigned int defaultValue=0, const QString &key=QString::null) |
ItemLong * | addItemLong (const QString &name, long &reference, long defaultValue=0, const QString &key=QString::null) |
ItemULong * | addItemULong (const QString &name, unsigned long &reference, unsigned long defaultValue=0, const QString &key=QString::null) |
ItemInt64 * | addItemInt64 (const QString &name, Q_INT64 &reference, Q_INT64 defaultValue=0, const QString &key=QString::null) |
ItemUInt64 * | addItemUInt64 (const QString &name, Q_UINT64 &reference, Q_UINT64 defaultValue=0, const QString &key=QString::null) |
ItemDouble * | addItemDouble (const QString &name, double &reference, double defaultValue=0.0, const QString &key=QString::null) |
ItemColor * | addItemColor (const QString &name, QColor &reference, const QColor &defaultValue=QColor(128, 128, 128), const QString &key=QString::null) |
ItemFont * | addItemFont (const QString &name, QFont &reference, const QFont &defaultValue=KGlobalSettings::generalFont(), const QString &key=QString::null) |
ItemRect * | addItemRect (const QString &name, QRect &reference, const QRect &defaultValue=QRect(), const QString &key=QString::null) |
ItemPoint * | addItemPoint (const QString &name, QPoint &reference, const QPoint &defaultValue=QPoint(), const QString &key=QString::null) |
ItemSize * | addItemSize (const QString &name, QSize &reference, const QSize &defaultValue=QSize(), const QString &key=QString::null) |
ItemDateTime * | addItemDateTime (const QString &name, QDateTime &reference, const QDateTime &defaultValue=QDateTime(), const QString &key=QString::null) |
ItemStringList * | addItemStringList (const QString &name, QStringList &reference, const QStringList &defaultValue=QStringList(), const QString &key=QString::null) |
ItemIntList * | addItemIntList (const QString &name, QValueList< int > &reference, const QValueList< int > &defaultValue=QValueList< int >(), const QString &key=QString::null) |
KConfig * | config () const |
KConfigSkeletonItem::List | items () const |
bool | isImmutable (const QString &name) |
KConfigSkeletonItem * | findItem (const QString &name) |
bool | useDefaults (bool b) |
Protected Member Functions | |
virtual void | usrUseDefaults (bool) |
virtual void | usrSetDefaults () |
virtual void | usrReadConfig () |
virtual void | usrWriteConfig () |
Classes | |
class | ItemBool |
Class for handling a bool preferences item. More... | |
class | ItemColor |
Class for handling a color preferences item. More... | |
class | ItemDateTime |
Class for handling a QDateTime preferences item. More... | |
class | ItemDouble |
Class for handling a floating point preference item. More... | |
class | ItemEnum |
Class for handling enums. More... | |
class | ItemFont |
Class for handling a font preferences item. More... | |
class | ItemInt |
Class for handling an integer preferences item. More... | |
class | ItemInt64 |
Class for handling an 64-bit integer preferences item. More... | |
class | ItemIntList |
Class for handling an integer list preferences item. More... | |
class | ItemLong |
Class for hanlding a long integer preferences item. More... | |
class | ItemPassword |
Class for handling a password preferences item. More... | |
class | ItemPath |
Class for handling a path preferences item. More... | |
class | ItemPathList |
Class for handling a path list preferences item. More... | |
class | ItemPoint |
Class for handling a QPoint preferences item. More... | |
class | ItemProperty |
Class for handling a QVariant preferences item. More... | |
class | ItemRect |
Class for handling a QRect preferences item. More... | |
class | ItemSize |
Class for handling a QSize preferences item. More... | |
class | ItemString |
Class for handling a string preferences item. More... | |
class | ItemStringList |
Class for handling a string list preferences item. More... | |
class | ItemUInt |
Class for handling an unsingend integer preferences item. More... | |
class | ItemUInt64 |
Class for handling unsigned 64-bit integer preferences item. More... | |
class | ItemULong |
Class for handling an unsigned long integer preferences item. More... |
Constructor & Destructor Documentation
|
Constructor.
Definition at line 881 of file kconfigskeleton.cpp. |
|
Constructor.
Definition at line 896 of file kconfigskeleton.cpp. |
|
Destructor.
Definition at line 904 of file kconfigskeleton.cpp. |
Member Function Documentation
|
Register a custom KConfigSkeletonItem with a given name. If the name parameter is null, take the name from KConfigSkeletonItem::key(). Note that all names must be unique but that multiple entries can have the same key if they reside in different groups. Definition at line 988 of file kconfigskeleton.cpp. |
|
Register an item of type bool.
Definition at line 1038 of file kconfigskeleton.cpp. |
|
Register an item of type QColor.
Definition at line 1118 of file kconfigskeleton.cpp. |
|
Register an item of type QDateTime.
Definition at line 1168 of file kconfigskeleton.cpp. |
|
Register an item of type double.
Definition at line 1108 of file kconfigskeleton.cpp. |
|
Register an item of type QFont.
Definition at line 1128 of file kconfigskeleton.cpp. |
|
Register an item of type int.
Definition at line 1048 of file kconfigskeleton.cpp. |
|
Register an item of type Q_INT64.
Definition at line 1068 of file kconfigskeleton.cpp. |
|
Register an item of type QValueList<int>.
Definition at line 1188 of file kconfigskeleton.cpp. |
|
Register an item of type long.
Definition at line 1088 of file kconfigskeleton.cpp. |
|
Register a password item of type QString. The string value is written encrypted to the config file. Note that the current encryption scheme is very weak.
Definition at line 1008 of file kconfigskeleton.cpp. |
|
Register a path item of type QString. The string value is interpreted as a path. This means, dollar expension is activated for this value, so that e.g. $HOME gets expanded.
Definition at line 1018 of file kconfigskeleton.cpp. |
|
Register an item of type QPoint.
Definition at line 1148 of file kconfigskeleton.cpp. |
|
Register a property item of type QVariant. Note that only the following QVariant types are allowed: String, StringList, Font, Point, Rect, Size, Color, Int, UInt, Bool, Double, DateTime and Date.
Definition at line 1028 of file kconfigskeleton.cpp. |
|
Register an item of type QRect.
Definition at line 1138 of file kconfigskeleton.cpp. |
|
Register an item of type QSize.
Definition at line 1158 of file kconfigskeleton.cpp. |
|
Register an item of type QString.
Definition at line 997 of file kconfigskeleton.cpp. |
|
Register an item of type QStringList.
Definition at line 1178 of file kconfigskeleton.cpp. |
|
Register an item of type unsigned int.
Definition at line 1058 of file kconfigskeleton.cpp. |
|
Register an item of type Q_UINT64.
Definition at line 1078 of file kconfigskeleton.cpp. |
|
Register an item of type unsigned long.
Definition at line 1098 of file kconfigskeleton.cpp. |
|
Return the KConfig object used for reading and writing the settings.
Definition at line 918 of file kconfigskeleton.cpp. |
|
Returns the current group used for addItem() calls.
Definition at line 837 of file kconfigskeleton.h. |
|
Lookup item by name.
Definition at line 1204 of file kconfigskeleton.cpp. |
|
Return whether a certain item is immutable.
Definition at line 1198 of file kconfigskeleton.cpp. |
|
Return list of items managed by this KConfigSkeleton object.
Definition at line 1164 of file kconfigskeleton.h. |
|
Read preferences from config file. All registered items are set to the values read from disk. Definition at line 949 of file kconfigskeleton.cpp. |
|
Set the config file group for subsequent addItem() calls. It is valid until setCurrentGroup() is called with a new argument. Call this before you add any items. The default value is "No Group". Definition at line 913 of file kconfigskeleton.cpp. |
|
Set all registered items to their default values.
Definition at line 939 of file kconfigskeleton.cpp. |
|
Indicate whether this object should reflect the actual values or the default values.
Definition at line 923 of file kconfigskeleton.cpp. |
|
Implemented by subclasses that read special config values.
Definition at line 1204 of file kconfigskeleton.h. |
|
Implemented by subclasses that use special defaults. It should replace the default values with the actual values and vice versa. Definition at line 1193 of file kconfigskeleton.h. |
|
Implemented by subclasses that write special config values.
Definition at line 1211 of file kconfigskeleton.h. |
|
Write preferences to config file. The values of all registered items are written to disk. Definition at line 967 of file kconfigskeleton.cpp. |
The documentation for this class was generated from the following files: