.TH "KConfigSkeleton" kde3 "11 Jun 2005" "Version Version 3.4.1" "kdecore Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KConfigSkeleton \- Class for handling preferences settings for an application.  

.PP
.SH SYNOPSIS
.br
.PP
\fC#include <kconfigskeleton.h>\fP
.PP
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBKConfigSkeleton\fP (const \fBQString\fP &configname=QString::null)"
.br
.ti -1c
.RI "\fBKConfigSkeleton\fP (\fBKSharedConfig::Ptr\fP config)"
.br
.ti -1c
.RI "virtual \fB~KConfigSkeleton\fP ()"
.br
.ti -1c
.RI "void \fBsetDefaults\fP ()"
.br
.ti -1c
.RI "void \fBreadConfig\fP ()"
.br
.ti -1c
.RI "void \fBwriteConfig\fP ()"
.br
.ti -1c
.RI "void \fBsetCurrentGroup\fP (const \fBQString\fP &group)"
.br
.ti -1c
.RI "\fBQString\fP \fBcurrentGroup\fP ()"
.br
.ti -1c
.RI "void \fBaddItem\fP (\fBKConfigSkeletonItem\fP *, const \fBQString\fP &name=QString::null)"
.br
.ti -1c
.RI "\fBItemString\fP * \fBaddItemString\fP (const \fBQString\fP &name, \fBQString\fP &reference, const \fBQString\fP &defaultValue=\fBQString::fromLatin1\fP(''), const \fBQString\fP &key=QString::null)"
.br
.ti -1c
.RI "\fBItemPassword\fP * \fBaddItemPassword\fP (const \fBQString\fP &name, \fBQString\fP &reference, const \fBQString\fP &defaultValue=\fBQString::fromLatin1\fP(''), const \fBQString\fP &key=QString::null)"
.br
.ti -1c
.RI "\fBItemPath\fP * \fBaddItemPath\fP (const \fBQString\fP &name, \fBQString\fP &reference, const \fBQString\fP &defaultValue=\fBQString::fromLatin1\fP(''), const \fBQString\fP &key=QString::null)"
.br
.ti -1c
.RI "\fBItemProperty\fP * \fBaddItemProperty\fP (const \fBQString\fP &name, \fBQVariant\fP &reference, const \fBQVariant\fP &defaultValue=\fBQVariant\fP(), const \fBQString\fP &key=QString::null)"
.br
.ti -1c
.RI "\fBItemBool\fP * \fBaddItemBool\fP (const \fBQString\fP &name, bool &reference, bool defaultValue=false, const \fBQString\fP &key=QString::null)"
.br
.ti -1c
.RI "\fBItemInt\fP * \fBaddItemInt\fP (const \fBQString\fP &name, int &reference, int defaultValue=0, const \fBQString\fP &key=QString::null)"
.br
.ti -1c
.RI "\fBItemUInt\fP * \fBaddItemUInt\fP (const \fBQString\fP &name, unsigned int &reference, unsigned int defaultValue=0, const \fBQString\fP &key=QString::null)"
.br
.ti -1c
.RI "\fBItemLong\fP * \fBaddItemLong\fP (const \fBQString\fP &name, long &reference, long defaultValue=0, const \fBQString\fP &key=QString::null)"
.br
.ti -1c
.RI "\fBItemULong\fP * \fBaddItemULong\fP (const \fBQString\fP &name, unsigned long &reference, unsigned long defaultValue=0, const \fBQString\fP &key=QString::null)"
.br
.ti -1c
.RI "\fBItemInt64\fP * \fBaddItemInt64\fP (const \fBQString\fP &name, Q_INT64 &reference, Q_INT64 defaultValue=0, const \fBQString\fP &key=QString::null)"
.br
.ti -1c
.RI "\fBItemUInt64\fP * \fBaddItemUInt64\fP (const \fBQString\fP &name, Q_UINT64 &reference, Q_UINT64 defaultValue=0, const \fBQString\fP &key=QString::null)"
.br
.ti -1c
.RI "\fBItemDouble\fP * \fBaddItemDouble\fP (const \fBQString\fP &name, double &reference, double defaultValue=0.0, const \fBQString\fP &key=QString::null)"
.br
.ti -1c
.RI "\fBItemColor\fP * \fBaddItemColor\fP (const \fBQString\fP &name, \fBQColor\fP &reference, const \fBQColor\fP &defaultValue=\fBQColor\fP(128, 128, 128), const \fBQString\fP &key=QString::null)"
.br
.ti -1c
.RI "\fBItemFont\fP * \fBaddItemFont\fP (const \fBQString\fP &name, \fBQFont\fP &reference, const \fBQFont\fP &defaultValue=KGlobalSettings::generalFont(), const \fBQString\fP &key=QString::null)"
.br
.ti -1c
.RI "\fBItemRect\fP * \fBaddItemRect\fP (const \fBQString\fP &name, \fBQRect\fP &reference, const \fBQRect\fP &defaultValue=\fBQRect\fP(), const \fBQString\fP &key=QString::null)"
.br
.ti -1c
.RI "\fBItemPoint\fP * \fBaddItemPoint\fP (const \fBQString\fP &name, \fBQPoint\fP &reference, const \fBQPoint\fP &defaultValue=\fBQPoint\fP(), const \fBQString\fP &key=QString::null)"
.br
.ti -1c
.RI "\fBItemSize\fP * \fBaddItemSize\fP (const \fBQString\fP &name, \fBQSize\fP &reference, const \fBQSize\fP &defaultValue=\fBQSize\fP(), const \fBQString\fP &key=QString::null)"
.br
.ti -1c
.RI "\fBItemDateTime\fP * \fBaddItemDateTime\fP (const \fBQString\fP &name, \fBQDateTime\fP &reference, const \fBQDateTime\fP &defaultValue=\fBQDateTime\fP(), const \fBQString\fP &key=QString::null)"
.br
.ti -1c
.RI "\fBItemStringList\fP * \fBaddItemStringList\fP (const \fBQString\fP &name, \fBQStringList\fP &reference, const \fBQStringList\fP &defaultValue=\fBQStringList\fP(), const \fBQString\fP &key=QString::null)"
.br
.ti -1c
.RI "\fBItemIntList\fP * \fBaddItemIntList\fP (const \fBQString\fP &name, \fBQValueList\fP< int > &reference, const \fBQValueList\fP< int > &defaultValue=\fBQValueList\fP< int >(), const \fBQString\fP &key=QString::null)"
.br
.ti -1c
.RI "\fBKConfig\fP * \fBconfig\fP () const "
.br
.ti -1c
.RI "\fBKConfigSkeletonItem::List\fP \fBitems\fP () const "
.br
.ti -1c
.RI "bool \fBisImmutable\fP (const \fBQString\fP &name)"
.br
.ti -1c
.RI "\fBKConfigSkeletonItem\fP * \fBfindItem\fP (const \fBQString\fP &name)"
.br
.ti -1c
.RI "bool \fBuseDefaults\fP (bool b)"
.br
.in -1c
.SS "Protected Member Functions"

.in +1c
.ti -1c
.RI "virtual void \fBusrUseDefaults\fP (bool)"
.br
.ti -1c
.RI "virtual void \fBusrSetDefaults\fP ()"
.br
.ti -1c
.RI "virtual void \fBusrReadConfig\fP ()"
.br
.ti -1c
.RI "virtual void \fBusrWriteConfig\fP ()"
.br
.in -1c
.SS "Classes"

.in +1c
.ti -1c
.RI "class \fBItemBool\fP"
.br
.RI "\fIClass for handling a bool preferences item. \fP"
.ti -1c
.RI "class \fBItemColor\fP"
.br
.RI "\fIClass for handling a color preferences item. \fP"
.ti -1c
.RI "class \fBItemDateTime\fP"
.br
.RI "\fIClass for handling a \fBQDateTime\fP preferences item. \fP"
.ti -1c
.RI "class \fBItemDouble\fP"
.br
.RI "\fIClass for handling a floating point preference item. \fP"
.ti -1c
.RI "class \fBItemEnum\fP"
.br
.RI "\fIClass for handling enums. \fP"
.ti -1c
.RI "class \fBItemFont\fP"
.br
.RI "\fIClass for handling a font preferences item. \fP"
.ti -1c
.RI "class \fBItemInt\fP"
.br
.RI "\fIClass for handling an integer preferences item. \fP"
.ti -1c
.RI "class \fBItemInt64\fP"
.br
.RI "\fIClass for handling an 64-bit integer preferences item. \fP"
.ti -1c
.RI "class \fBItemIntList\fP"
.br
.RI "\fIClass for handling an integer list preferences item. \fP"
.ti -1c
.RI "class \fBItemLong\fP"
.br
.RI "\fIClass for hanlding a long integer preferences item. \fP"
.ti -1c
.RI "class \fBItemPassword\fP"
.br
.RI "\fIClass for handling a password preferences item. \fP"
.ti -1c
.RI "class \fBItemPath\fP"
.br
.RI "\fIClass for handling a path preferences item. \fP"
.ti -1c
.RI "class \fBItemPathList\fP"
.br
.RI "\fIClass for handling a path list preferences item. \fP"
.ti -1c
.RI "class \fBItemPoint\fP"
.br
.RI "\fIClass for handling a \fBQPoint\fP preferences item. \fP"
.ti -1c
.RI "class \fBItemProperty\fP"
.br
.RI "\fIClass for handling a \fBQVariant\fP preferences item. \fP"
.ti -1c
.RI "class \fBItemRect\fP"
.br
.RI "\fIClass for handling a \fBQRect\fP preferences item. \fP"
.ti -1c
.RI "class \fBItemSize\fP"
.br
.RI "\fIClass for handling a \fBQSize\fP preferences item. \fP"
.ti -1c
.RI "class \fBItemString\fP"
.br
.RI "\fIClass for handling a string preferences item. \fP"
.ti -1c
.RI "class \fBItemStringList\fP"
.br
.RI "\fIClass for handling a string list preferences item. \fP"
.ti -1c
.RI "class \fBItemUInt\fP"
.br
.RI "\fIClass for handling an unsingend integer preferences item. \fP"
.ti -1c
.RI "class \fBItemUInt64\fP"
.br
.RI "\fIClass for handling unsigned 64-bit integer preferences item. \fP"
.ti -1c
.RI "class \fBItemULong\fP"
.br
.RI "\fIClass for handling an unsigned long integer preferences item. \fP"
.in -1c
.SH "Detailed Description"
.PP 
Class for handling preferences settings for an application. 

\fBAuthor:\fP
.RS 4
Cornelius Schumacher 
.RE
.PP
\fBSee also:\fP
.RS 4
\fBKConfigSkeletonItem\fP
.RE
.PP
This class provides an interface to preferences settings. Preferences items can be registered by the \fBaddItem()\fP function corresponding to the data type of the seetting. KConfigSkeleton then handles reading and writing of config files and setting of default values.
.PP
Normally you will subclass KConfigSkeleton, add data members for the preferences settings and register the members in the constructor of the subclass.
.PP
Example: 
.PP
.nf
 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;
 }

.fi
.PP
.PP
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.
.PP
You can write the data to the configuration file by calling \fBwriteConfig()\fP and read the data from the configuration file by calling \fBreadConfig()\fP.
.PP
If you have items, which are not covered by the existing \fBaddItem()\fP functions you can add customized code for reading, writing and default setting by implementing the functions \fBusrUseDefaults()\fP, \fBusrReadConfig()\fP and \fBusrWriteConfig()\fP.
.PP
Internally preferences settings are stored in instances of subclasses of \fBKConfigSkeletonItem\fP. You can also add \fBKConfigSkeletonItem\fP subclasses for your own types and call the generic \fBaddItem()\fP to register them.
.PP
In many cases you don't have to write the specific KConfigSkeleton subclasses yourself, but you can use \fBThe KDE Configuration Compiler\fP to automatically generate the C++ code from an XML description of the configuration options. 
.PP
Definition at line 365 of file kconfigskeleton.h.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "KConfigSkeleton::KConfigSkeleton (const \fBQString\fP & configname = \fCQString::null\fP)"
.PP
Constructor. 
.PP
\fBParameters:\fP
.RS 4
\fIconfigname\fP name of config file. If no name is given, the default config file as returned by kapp()->\fBconfig()\fP is used. 
.RE
.PP

.PP
Definition at line 881 of file kconfigskeleton.cpp.
.PP
References endl(), KSharedConfig::openConfig(), and KGlobal::sharedConfig().
.SS "KConfigSkeleton::KConfigSkeleton (\fBKSharedConfig::Ptr\fP config)"
.PP
Constructor. 
.PP
\fBParameters:\fP
.RS 4
\fIconfig\fP configuration object to use. 
.RE
.PP

.PP
Definition at line 896 of file kconfigskeleton.cpp.
.PP
References endl().
.SS "KConfigSkeleton::~\fBKConfigSkeleton\fP ()\fC [virtual]\fP"
.PP
Destructor. 
.PP
Definition at line 904 of file kconfigskeleton.cpp.
.PP
References QValueList::begin(), and QValueList::end().
.SH "Member Function Documentation"
.PP 
.SS "void KConfigSkeleton::setDefaults ()"
.PP
Set all registered items to their default values. 
.PP
Definition at line 939 of file kconfigskeleton.cpp.
.PP
References QValueList::begin(), and QValueList::end().
.SS "void KConfigSkeleton::readConfig ()"
.PP
Read preferences from config file. 
.PP
All registered items are set to the values read from disk. 
.PP
Definition at line 949 of file kconfigskeleton.cpp.
.PP
References QValueList::begin(), QValueList::end(), endl(), and usrReadConfig().
.PP
Referenced by writeConfig().
.SS "void KConfigSkeleton::writeConfig ()"
.PP
Write preferences to config file. 
.PP
The values of all registered items are written to disk. 
.PP
Definition at line 967 of file kconfigskeleton.cpp.
.PP
References QValueList::begin(), QValueList::end(), endl(), readConfig(), and usrWriteConfig().
.PP
Referenced by KConfigDialogManager::updateSettings().
.SS "void KConfigSkeleton::setCurrentGroup (const \fBQString\fP & group)"
.PP
Set the config file group for subsequent \fBaddItem()\fP calls. 
.PP
It is valid until \fBsetCurrentGroup()\fP is called with a new argument. Call this before you add any items. The default value is 'No Group'. 
.PP
Definition at line 913 of file kconfigskeleton.cpp.
.SS "\fBQString\fP KConfigSkeleton::currentGroup ()\fC [inline]\fP"
.PP
Returns the current group used for \fBaddItem()\fP calls. 
.PP
Definition at line 837 of file kconfigskeleton.h.
.SS "void KConfigSkeleton::addItem (\fBKConfigSkeletonItem\fP *, const \fBQString\fP & name = \fCQString::null\fP)"
.PP
Register a custom \fBKConfigSkeletonItem\fP with a given name. 
.PP
If the name parameter is null, take the name from \fBKConfigSkeletonItem::key()\fP. Note that all names must be unique but that multiple entries can have the same key if they reside in different groups. 
.PP
Definition at line 988 of file kconfigskeleton.cpp.
.PP
References QValueList::append(), and QDict::insert().
.PP
Referenced by addItemBool(), addItemColor(), addItemDateTime(), addItemDouble(), addItemFont(), addItemInt(), addItemInt64(), addItemIntList(), addItemLong(), addItemPassword(), addItemPath(), addItemPoint(), addItemProperty(), addItemRect(), addItemSize(), addItemString(), addItemStringList(), addItemUInt(), addItemUInt64(), and addItemULong().
.SS "\fBKConfigSkeleton::ItemString\fP * KConfigSkeleton::addItemString (const \fBQString\fP & name, \fBQString\fP & reference, const \fBQString\fP & defaultValue = \fC\fBQString::fromLatin1\fP('')\fP, const \fBQString\fP & key = \fCQString::null\fP)"
.PP
Register an item of type \fBQString\fP. 
.PP
\fBParameters:\fP
.RS 4
\fIname\fP Name used to indentify this setting. Names must be unique. 
.br
\fIreference\fP Pointer to the variable, which is set by \fBreadConfig()\fP calls and read by \fBwriteConfig()\fP calls. 
.br
\fIdefaultValue\fP Default value, which is used when the config file does not yet contain the key of this item. 
.br
\fIkey\fP Key used in config file. If key is null, name is used as key. 
.RE
.PP
\fBReturns:\fP
.RS 4
The created item 
.RE
.PP

.PP
Definition at line 996 of file kconfigskeleton.cpp.
.PP
References addItem(), and QString::isEmpty().
.SS "\fBKConfigSkeleton::ItemPassword\fP * KConfigSkeleton::addItemPassword (const \fBQString\fP & name, \fBQString\fP & reference, const \fBQString\fP & defaultValue = \fC\fBQString::fromLatin1\fP('')\fP, const \fBQString\fP & key = \fCQString::null\fP)"
.PP
Register a password item of type \fBQString\fP. 
.PP
The string value is written encrypted to the config file. Note that the current encryption scheme is very weak.
.PP
\fBParameters:\fP
.RS 4
\fIname\fP Name used to indentify this setting. Names must be unique. 
.br
\fIreference\fP Pointer to the variable, which is set by \fBreadConfig()\fP calls and read by \fBwriteConfig()\fP calls. 
.br
\fIdefaultValue\fP Default value, which is used when the config file does not yet contain the key of this item. 
.br
\fIkey\fP Key used in config file. If key is null, name is used as key. 
.RE
.PP
\fBReturns:\fP
.RS 4
The created item 
.RE
.PP

.PP
Definition at line 1007 of file kconfigskeleton.cpp.
.PP
References addItem(), and QString::isNull().
.SS "\fBKConfigSkeleton::ItemPath\fP * KConfigSkeleton::addItemPath (const \fBQString\fP & name, \fBQString\fP & reference, const \fBQString\fP & defaultValue = \fC\fBQString::fromLatin1\fP('')\fP, const \fBQString\fP & key = \fCQString::null\fP)"
.PP
Register a path item of type \fBQString\fP. 
.PP
The string value is interpreted as a path. This means, dollar expension is activated for this value, so that e.g. $HOME gets expanded.
.PP
\fBParameters:\fP
.RS 4
\fIname\fP Name used to indentify this setting. Names must be unique. 
.br
\fIreference\fP Pointer to the variable, which is set by \fBreadConfig()\fP calls and read by \fBwriteConfig()\fP calls. 
.br
\fIdefaultValue\fP Default value, which is used when the config file does not yet contain the key of this item. 
.br
\fIkey\fP Key used in config file. If key is null, name is used as key. 
.RE
.PP
\fBReturns:\fP
.RS 4
The created item 
.RE
.PP

.PP
Definition at line 1017 of file kconfigskeleton.cpp.
.PP
References addItem(), and QString::isNull().
.SS "\fBKConfigSkeleton::ItemProperty\fP * KConfigSkeleton::addItemProperty (const \fBQString\fP & name, \fBQVariant\fP & reference, const \fBQVariant\fP & defaultValue = \fC\fBQVariant\fP()\fP, const \fBQString\fP & key = \fCQString::null\fP)"
.PP
Register a property item of type \fBQVariant\fP. 
.PP
Note that only the following \fBQVariant\fP types are allowed: String, StringList, Font, Point, Rect, Size, Color, Int, UInt, Bool, Double, DateTime and Date.
.PP
\fBParameters:\fP
.RS 4
\fIname\fP Name used to indentify this setting. Names must be unique. 
.br
\fIreference\fP Pointer to the variable, which is set by \fBreadConfig()\fP calls and read by \fBwriteConfig()\fP calls. 
.br
\fIdefaultValue\fP Default value, which is used when the config file does not yet contain the key of this item. 
.br
\fIkey\fP Key used in config file. If key is null, name is used as key. 
.RE
.PP
\fBReturns:\fP
.RS 4
The created item 
.RE
.PP

.PP
Definition at line 1027 of file kconfigskeleton.cpp.
.PP
References addItem(), and QString::isNull().
.SS "\fBKConfigSkeleton::ItemBool\fP * KConfigSkeleton::addItemBool (const \fBQString\fP & name, bool & reference, bool defaultValue = \fCfalse\fP, const \fBQString\fP & key = \fCQString::null\fP)"
.PP
Register an item of type bool. 
.PP
\fBParameters:\fP
.RS 4
\fIname\fP Name used to indentify this setting. Names must be unique. 
.br
\fIreference\fP Pointer to the variable, which is set by \fBreadConfig()\fP calls and read by \fBwriteConfig()\fP calls. 
.br
\fIdefaultValue\fP Default value, which is used when the config file does not yet contain the key of this item. 
.br
\fIkey\fP Key used in config file. If key is null, name is used as key. 
.RE
.PP
\fBReturns:\fP
.RS 4
The created item 
.RE
.PP

.PP
Definition at line 1037 of file kconfigskeleton.cpp.
.PP
References addItem(), and QString::isNull().
.SS "\fBKConfigSkeleton::ItemInt\fP * KConfigSkeleton::addItemInt (const \fBQString\fP & name, int & reference, int defaultValue = \fC0\fP, const \fBQString\fP & key = \fCQString::null\fP)"
.PP
Register an item of type int. 
.PP
\fBParameters:\fP
.RS 4
\fIname\fP Name used to indentify this setting. Names must be unique. 
.br
\fIreference\fP Pointer to the variable, which is set by \fBreadConfig()\fP calls and read by \fBwriteConfig()\fP calls. 
.br
\fIdefaultValue\fP Default value, which is used when the config file does not yet contain the key of this item. 
.br
\fIkey\fP Key used in config file. If key is null, name is used as key. 
.RE
.PP
\fBReturns:\fP
.RS 4
The created item 
.RE
.PP

.PP
Definition at line 1047 of file kconfigskeleton.cpp.
.PP
References addItem(), and QString::isNull().
.SS "\fBKConfigSkeleton::ItemUInt\fP * KConfigSkeleton::addItemUInt (const \fBQString\fP & name, unsigned int & reference, unsigned int defaultValue = \fC0\fP, const \fBQString\fP & key = \fCQString::null\fP)"
.PP
Register an item of type unsigned int. 
.PP
\fBParameters:\fP
.RS 4
\fIname\fP Name used to indentify this setting. Names must be unique. 
.br
\fIreference\fP Pointer to the variable, which is set by \fBreadConfig()\fP calls and read by \fBwriteConfig()\fP calls. 
.br
\fIdefaultValue\fP Default value, which is used when the config file does not yet contain the key of this item. 
.br
\fIkey\fP Key used in config file. If key is null, name is used as key. 
.RE
.PP
\fBReturns:\fP
.RS 4
The created item 
.RE
.PP

.PP
Definition at line 1057 of file kconfigskeleton.cpp.
.PP
References addItem(), and QString::isNull().
.SS "\fBKConfigSkeleton::ItemLong\fP * KConfigSkeleton::addItemLong (const \fBQString\fP & name, long & reference, long defaultValue = \fC0\fP, const \fBQString\fP & key = \fCQString::null\fP)"
.PP
Register an item of type long. 
.PP
\fBParameters:\fP
.RS 4
\fIname\fP Name used to indentify this setting. Names must be unique. 
.br
\fIreference\fP Pointer to the variable, which is set by \fBreadConfig()\fP calls and read by \fBwriteConfig()\fP calls. 
.br
\fIdefaultValue\fP Default value, which is used when the config file does not yet contain the key of this item. 
.br
\fIkey\fP Key used in config file. If key is null, name is used as key. 
.RE
.PP
\fBReturns:\fP
.RS 4
The created item 
.RE
.PP

.PP
Definition at line 1087 of file kconfigskeleton.cpp.
.PP
References addItem(), and QString::isNull().
.SS "\fBKConfigSkeleton::ItemULong\fP * KConfigSkeleton::addItemULong (const \fBQString\fP & name, unsigned long & reference, unsigned long defaultValue = \fC0\fP, const \fBQString\fP & key = \fCQString::null\fP)"
.PP
Register an item of type unsigned long. 
.PP
\fBParameters:\fP
.RS 4
\fIname\fP Name used to indentify this setting. Names must be unique. 
.br
\fIreference\fP Pointer to the variable, which is set by \fBreadConfig()\fP calls and read by \fBwriteConfig()\fP calls. 
.br
\fIdefaultValue\fP Default value, which is used when the config file does not yet contain the key of this item. 
.br
\fIkey\fP Key used in config file. If key is null, name is used as key. 
.RE
.PP
\fBReturns:\fP
.RS 4
The created item 
.RE
.PP

.PP
Definition at line 1097 of file kconfigskeleton.cpp.
.PP
References addItem(), and QString::isNull().
.SS "\fBKConfigSkeleton::ItemInt64\fP * KConfigSkeleton::addItemInt64 (const \fBQString\fP & name, Q_INT64 & reference, Q_INT64 defaultValue = \fC0\fP, const \fBQString\fP & key = \fCQString::null\fP)"
.PP
Register an item of type Q_INT64. 
.PP
\fBParameters:\fP
.RS 4
\fIname\fP Name used to indentify this setting. Names must be unique. 
.br
\fIreference\fP Pointer to the variable, which is set by \fBreadConfig()\fP calls and read by \fBwriteConfig()\fP calls. 
.br
\fIdefaultValue\fP Default value, which is used when the config file does not yet contain the key of this item. 
.br
\fIkey\fP Key used in config file. If key is null, name is used as key. 
.RE
.PP
\fBReturns:\fP
.RS 4
The created item 
.RE
.PP

.PP
Definition at line 1067 of file kconfigskeleton.cpp.
.PP
References addItem(), and QString::isNull().
.SS "\fBKConfigSkeleton::ItemUInt64\fP * KConfigSkeleton::addItemUInt64 (const \fBQString\fP & name, Q_UINT64 & reference, Q_UINT64 defaultValue = \fC0\fP, const \fBQString\fP & key = \fCQString::null\fP)"
.PP
Register an item of type Q_UINT64. 
.PP
\fBParameters:\fP
.RS 4
\fIname\fP Name used to indentify this setting. Names must be unique. 
.br
\fIreference\fP Pointer to the variable, which is set by \fBreadConfig()\fP calls and read by \fBwriteConfig()\fP calls. 
.br
\fIdefaultValue\fP Default value, which is used when the config file does not yet contain the key of this item. 
.br
\fIkey\fP Key used in config file. If key is null, name is used as key. 
.RE
.PP
\fBReturns:\fP
.RS 4
The created item 
.RE
.PP

.PP
Definition at line 1077 of file kconfigskeleton.cpp.
.PP
References addItem(), and QString::isNull().
.SS "\fBKConfigSkeleton::ItemDouble\fP * KConfigSkeleton::addItemDouble (const \fBQString\fP & name, double & reference, double defaultValue = \fC0.0\fP, const \fBQString\fP & key = \fCQString::null\fP)"
.PP
Register an item of type double. 
.PP
\fBParameters:\fP
.RS 4
\fIname\fP Name used to indentify this setting. Names must be unique. 
.br
\fIreference\fP Pointer to the variable, which is set by \fBreadConfig()\fP calls and read by \fBwriteConfig()\fP calls. 
.br
\fIdefaultValue\fP Default value, which is used when the config file does not yet contain the key of this item. 
.br
\fIkey\fP Key used in config file. If key is null, name is used as key. 
.RE
.PP
\fBReturns:\fP
.RS 4
The created item 
.RE
.PP

.PP
Definition at line 1107 of file kconfigskeleton.cpp.
.PP
References addItem(), and QString::isNull().
.SS "\fBKConfigSkeleton::ItemColor\fP * KConfigSkeleton::addItemColor (const \fBQString\fP & name, \fBQColor\fP & reference, const \fBQColor\fP & defaultValue = \fC\fBQColor\fP(128, 128, 128)\fP, const \fBQString\fP & key = \fCQString::null\fP)"
.PP
Register an item of type \fBQColor\fP. 
.PP
\fBParameters:\fP
.RS 4
\fIname\fP Name used to indentify this setting. Names must be unique. 
.br
\fIreference\fP Pointer to the variable, which is set by \fBreadConfig()\fP calls and read by \fBwriteConfig()\fP calls. 
.br
\fIdefaultValue\fP Default value, which is used when the config file does not yet contain the key of this item. 
.br
\fIkey\fP Key used in config file. If key is null, name is used as key. 
.RE
.PP
\fBReturns:\fP
.RS 4
The created item 
.RE
.PP

.PP
Definition at line 1117 of file kconfigskeleton.cpp.
.PP
References addItem(), and QString::isNull().
.SS "\fBKConfigSkeleton::ItemFont\fP * KConfigSkeleton::addItemFont (const \fBQString\fP & name, \fBQFont\fP & reference, const \fBQFont\fP & defaultValue = \fCKGlobalSettings::generalFont()\fP, const \fBQString\fP & key = \fCQString::null\fP)"
.PP
Register an item of type \fBQFont\fP. 
.PP
\fBParameters:\fP
.RS 4
\fIname\fP Name used to indentify this setting. Names must be unique. 
.br
\fIreference\fP Pointer to the variable, which is set by \fBreadConfig()\fP calls and read by \fBwriteConfig()\fP calls. 
.br
\fIdefaultValue\fP Default value, which is used when the config file does not yet contain the key of this item. 
.br
\fIkey\fP Key used in config file. If key is null, name is used as key. 
.RE
.PP
\fBReturns:\fP
.RS 4
The created item 
.RE
.PP

.PP
Definition at line 1127 of file kconfigskeleton.cpp.
.PP
References addItem(), and QString::isNull().
.SS "\fBKConfigSkeleton::ItemRect\fP * KConfigSkeleton::addItemRect (const \fBQString\fP & name, \fBQRect\fP & reference, const \fBQRect\fP & defaultValue = \fC\fBQRect\fP()\fP, const \fBQString\fP & key = \fCQString::null\fP)"
.PP
Register an item of type \fBQRect\fP. 
.PP
\fBParameters:\fP
.RS 4
\fIname\fP Name used to indentify this setting. Names must be unique. 
.br
\fIreference\fP Pointer to the variable, which is set by \fBreadConfig()\fP calls and read by \fBwriteConfig()\fP calls. 
.br
\fIdefaultValue\fP Default value, which is used when the config file does not yet contain the key of this item. 
.br
\fIkey\fP Key used in config file. If key is null, name is used as key. 
.RE
.PP
\fBReturns:\fP
.RS 4
The created item 
.RE
.PP

.PP
Definition at line 1137 of file kconfigskeleton.cpp.
.PP
References addItem(), and QString::isNull().
.SS "\fBKConfigSkeleton::ItemPoint\fP * KConfigSkeleton::addItemPoint (const \fBQString\fP & name, \fBQPoint\fP & reference, const \fBQPoint\fP & defaultValue = \fC\fBQPoint\fP()\fP, const \fBQString\fP & key = \fCQString::null\fP)"
.PP
Register an item of type \fBQPoint\fP. 
.PP
\fBParameters:\fP
.RS 4
\fIname\fP Name used to indentify this setting. Names must be unique. 
.br
\fIreference\fP Pointer to the variable, which is set by \fBreadConfig()\fP calls and read by \fBwriteConfig()\fP calls. 
.br
\fIdefaultValue\fP Default value, which is used when the config file does not yet contain the key of this item. 
.br
\fIkey\fP Key used in config file. If key is null, name is used as key. 
.RE
.PP
\fBReturns:\fP
.RS 4
The created item 
.RE
.PP

.PP
Definition at line 1147 of file kconfigskeleton.cpp.
.PP
References addItem(), and QString::isNull().
.SS "\fBKConfigSkeleton::ItemSize\fP * KConfigSkeleton::addItemSize (const \fBQString\fP & name, \fBQSize\fP & reference, const \fBQSize\fP & defaultValue = \fC\fBQSize\fP()\fP, const \fBQString\fP & key = \fCQString::null\fP)"
.PP
Register an item of type \fBQSize\fP. 
.PP
\fBParameters:\fP
.RS 4
\fIname\fP Name used to indentify this setting. Names must be unique. 
.br
\fIreference\fP Pointer to the variable, which is set by \fBreadConfig()\fP calls and read by \fBwriteConfig()\fP calls. 
.br
\fIdefaultValue\fP Default value, which is used when the config file does not yet contain the key of this item. 
.br
\fIkey\fP Key used in config file. If key is null, name is used as key. 
.RE
.PP
\fBReturns:\fP
.RS 4
The created item 
.RE
.PP

.PP
Definition at line 1157 of file kconfigskeleton.cpp.
.PP
References addItem(), and QString::isNull().
.SS "\fBKConfigSkeleton::ItemDateTime\fP * KConfigSkeleton::addItemDateTime (const \fBQString\fP & name, \fBQDateTime\fP & reference, const \fBQDateTime\fP & defaultValue = \fC\fBQDateTime\fP()\fP, const \fBQString\fP & key = \fCQString::null\fP)"
.PP
Register an item of type \fBQDateTime\fP. 
.PP
\fBParameters:\fP
.RS 4
\fIname\fP Name used to indentify this setting. Names must be unique. 
.br
\fIreference\fP Pointer to the variable, which is set by \fBreadConfig()\fP calls and read by \fBwriteConfig()\fP calls. 
.br
\fIdefaultValue\fP Default value, which is used when the config file does not yet contain the key of this item. 
.br
\fIkey\fP Key used in config file. If key is null, name is used as key. 
.RE
.PP
\fBReturns:\fP
.RS 4
The created item 
.RE
.PP

.PP
Definition at line 1167 of file kconfigskeleton.cpp.
.PP
References addItem(), and QString::isNull().
.SS "\fBKConfigSkeleton::ItemStringList\fP * KConfigSkeleton::addItemStringList (const \fBQString\fP & name, \fBQStringList\fP & reference, const \fBQStringList\fP & defaultValue = \fC\fBQStringList\fP()\fP, const \fBQString\fP & key = \fCQString::null\fP)"
.PP
Register an item of type \fBQStringList\fP. 
.PP
\fBParameters:\fP
.RS 4
\fIname\fP Name used to indentify this setting. Names must be unique. 
.br
\fIreference\fP Pointer to the variable, which is set by \fBreadConfig()\fP calls and read by \fBwriteConfig()\fP calls. 
.br
\fIdefaultValue\fP Default value, which is used when the config file does not yet contain the key of this item. 
.br
\fIkey\fP Key used in config file. If key is null, name is used as key. 
.RE
.PP
\fBReturns:\fP
.RS 4
The created item 
.RE
.PP

.PP
Definition at line 1177 of file kconfigskeleton.cpp.
.PP
References addItem(), and QString::isNull().
.SS "\fBKConfigSkeleton::ItemIntList\fP * KConfigSkeleton::addItemIntList (const \fBQString\fP & name, \fBQValueList\fP< int > & reference, const \fBQValueList\fP< int > & defaultValue = \fC\fBQValueList\fP< int >()\fP, const \fBQString\fP & key = \fCQString::null\fP)"
.PP
Register an item of type \fBQValueList<int>\fP. 
.PP
\fBParameters:\fP
.RS 4
\fIname\fP Name used to indentify this setting. Names must be unique. 
.br
\fIreference\fP Pointer to the variable, which is set by \fBreadConfig()\fP calls and read by \fBwriteConfig()\fP calls. 
.br
\fIdefaultValue\fP Default value, which is used when the config file does not yet contain the key of this item. 
.br
\fIkey\fP Key used in config file. If key is null, name is used as key. 
.RE
.PP
\fBReturns:\fP
.RS 4
The created item 
.RE
.PP

.PP
Definition at line 1187 of file kconfigskeleton.cpp.
.PP
References addItem(), and QString::isNull().
.SS "\fBKConfig\fP * KConfigSkeleton::config () const"
.PP
Return the \fBKConfig\fP object used for reading and writing the settings. 
.PP
Definition at line 918 of file kconfigskeleton.cpp.
.SS "\fBKConfigSkeletonItem::List\fP KConfigSkeleton::items () const\fC [inline]\fP"
.PP
Return list of items managed by this KConfigSkeleton object. 
.PP
Definition at line 1164 of file kconfigskeleton.h.
.SS "bool KConfigSkeleton::isImmutable (const \fBQString\fP & name)"
.PP
Return whether a certain item is immutable. 
.PP
Definition at line 1197 of file kconfigskeleton.cpp.
.PP
References findItem(), and KConfigSkeletonItem::isImmutable().
.SS "\fBKConfigSkeletonItem\fP * KConfigSkeleton::findItem (const \fBQString\fP & name)"
.PP
Lookup item by name. 
.PP
Definition at line 1203 of file kconfigskeleton.cpp.
.PP
References QDict::find().
.PP
Referenced by KConfigDialogManager::hasChanged(), isImmutable(), KConfigDialogManager::parseChildren(), KConfigDialogManager::updateSettings(), and KConfigDialogManager::updateWidgets().
.SS "bool KConfigSkeleton::useDefaults (bool b)"
.PP
Indicate whether this object should reflect the actual values or the default values. 
.PP
\fBParameters:\fP
.RS 4
\fIb\fP If true this object reflects the default values. 
.RE
.PP
\fBReturns:\fP
.RS 4
The state prior to this call 
.RE
.PP

.PP
Definition at line 923 of file kconfigskeleton.cpp.
.PP
References QValueList::begin(), QValueList::end(), and usrUseDefaults().
.PP
Referenced by KConfigDialogManager::isDefault(), and KConfigDialogManager::updateWidgetsDefault().
.SS "virtual void KConfigSkeleton::usrUseDefaults (bool)\fC [inline, protected, virtual]\fP"
.PP
Implemented by subclasses that use special defaults. 
.PP
It should replace the default values with the actual values and vice versa. 
.PP
Definition at line 1193 of file kconfigskeleton.h.
.PP
Referenced by useDefaults().
.SS "virtual void KConfigSkeleton::usrReadConfig ()\fC [inline, protected, virtual]\fP"
.PP
Implemented by subclasses that read special config values. 
.PP
Definition at line 1204 of file kconfigskeleton.h.
.PP
Referenced by readConfig().
.SS "virtual void KConfigSkeleton::usrWriteConfig ()\fC [inline, protected, virtual]\fP"
.PP
Implemented by subclasses that write special config values. 
.PP
Definition at line 1211 of file kconfigskeleton.h.
.PP
Referenced by writeConfig().

.SH "Author"
.PP 
Generated automatically by Doxygen for kdecore Library from the source code.
