.TH "KConfigSkeletonItem" kde3 "11 Jun 2005" "Version Version 3.4.1" "kdecore Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KConfigSkeletonItem \- Class for storing a preferences setting.  

.PP
.SH SYNOPSIS
.br
.PP
\fC#include <kconfigskeleton.h>\fP
.PP
Inherited by KConfigSkeletonGenericItem.
.PP
.SS "Public Types"

.in +1c
.ti -1c
.RI "typedef \fBQValueList\fP< \fBKConfigSkeletonItem\fP * > \fBList\fP"
.br
.ti -1c
.RI "typedef \fBQDict\fP< \fBKConfigSkeletonItem\fP > \fBDict\fP"
.br
.ti -1c
.RI "typedef \fBQDictIterator\fP< \fBKConfigSkeletonItem\fP > \fBDictIterator\fP"
.br
.in -1c
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBKConfigSkeletonItem\fP (const \fBQString\fP &group, const \fBQString\fP &key)"
.br
.ti -1c
.RI "virtual \fB~KConfigSkeletonItem\fP ()"
.br
.ti -1c
.RI "void \fBsetGroup\fP (const \fBQString\fP &group)"
.br
.ti -1c
.RI "\fBQString\fP \fBgroup\fP () const "
.br
.ti -1c
.RI "void \fBsetKey\fP (const \fBQString\fP &key)"
.br
.ti -1c
.RI "\fBQString\fP \fBkey\fP () const "
.br
.ti -1c
.RI "void \fBsetName\fP (const \fBQString\fP &name)"
.br
.ti -1c
.RI "\fBQString\fP \fBname\fP () const "
.br
.ti -1c
.RI "void \fBsetLabel\fP (const \fBQString\fP &l)"
.br
.ti -1c
.RI "\fBQString\fP \fBlabel\fP () const "
.br
.ti -1c
.RI "void \fBsetWhatsThis\fP (const \fBQString\fP &w)"
.br
.ti -1c
.RI "\fBQString\fP \fBwhatsThis\fP () const "
.br
.ti -1c
.RI "virtual void \fBreadConfig\fP (\fBKConfig\fP *)=0"
.br
.ti -1c
.RI "virtual void \fBwriteConfig\fP (\fBKConfig\fP *)=0"
.br
.ti -1c
.RI "virtual void \fBreadDefault\fP (\fBKConfig\fP *)=0"
.br
.ti -1c
.RI "virtual void \fBsetProperty\fP (const \fBQVariant\fP &p)=0"
.br
.ti -1c
.RI "virtual \fBQVariant\fP \fBproperty\fP () const =0"
.br
.ti -1c
.RI "virtual \fBQVariant\fP \fBminValue\fP () const "
.br
.ti -1c
.RI "virtual \fBQVariant\fP \fBmaxValue\fP () const "
.br
.ti -1c
.RI "virtual void \fBsetDefault\fP ()=0"
.br
.ti -1c
.RI "virtual void \fBswapDefault\fP ()=0"
.br
.ti -1c
.RI "bool \fBisImmutable\fP () const "
.br
.in -1c
.SS "Protected Member Functions"

.in +1c
.ti -1c
.RI "void \fBreadImmutability\fP (\fBKConfig\fP *config)"
.br
.in -1c
.SS "Protected Attributes"

.in +1c
.ti -1c
.RI "\fBQString\fP \fBmGroup\fP"
.br
.ti -1c
.RI "\fBQString\fP \fBmKey\fP"
.br
.ti -1c
.RI "\fBQString\fP \fBmName\fP"
.br
.in -1c
.SH "Detailed Description"
.PP 
Class for storing a preferences setting. 

\fBAuthor:\fP
.RS 4
Cornelius Schumacher 
.RE
.PP
\fBSee also:\fP
.RS 4
\fBKConfigSkeleton\fP
.RE
.PP
This class represents one preferences setting as used by \fBKConfigSkeleton\fP. 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 \fBKConfigSkeleton\fP instead. If you subclass this class you will have to register instances with the function \fBKConfigSkeleton::addItem()\fP. 
.PP
Definition at line 50 of file kconfigskeleton.h.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "KConfigSkeletonItem::KConfigSkeletonItem (const \fBQString\fP & group, const \fBQString\fP & key)\fC [inline]\fP"
.PP
Constructor. 
.PP
\fBParameters:\fP
.RS 4
\fIgroup\fP Config file group. 
.br
\fIkey\fP Config file key. 
.RE
.PP

.PP
Definition at line 63 of file kconfigskeleton.h.
.SS "virtual KConfigSkeletonItem::~\fBKConfigSkeletonItem\fP ()\fC [inline, virtual]\fP"
.PP
Destructor. 
.PP
Definition at line 71 of file kconfigskeleton.h.
.SH "Member Function Documentation"
.PP 
.SS "void KConfigSkeletonItem::setGroup (const \fBQString\fP & group)\fC [inline]\fP"
.PP
Set config file group. 
.PP
Definition at line 78 of file kconfigskeleton.h.
.SS "\fBQString\fP KConfigSkeletonItem::group () const\fC [inline]\fP"
.PP
Return config file group. 
.PP
Definition at line 86 of file kconfigskeleton.h.
.SS "void KConfigSkeletonItem::setKey (const \fBQString\fP & key)\fC [inline]\fP"
.PP
Set config file key. 
.PP
Definition at line 94 of file kconfigskeleton.h.
.SS "\fBQString\fP KConfigSkeletonItem::key () const\fC [inline]\fP"
.PP
Return config file key. 
.PP
Definition at line 102 of file kconfigskeleton.h.
.SS "void KConfigSkeletonItem::setName (const \fBQString\fP & name)\fC [inline]\fP"
.PP
Set internal name of entry. 
.PP
Definition at line 110 of file kconfigskeleton.h.
.SS "\fBQString\fP KConfigSkeletonItem::name () const\fC [inline]\fP"
.PP
Return internal name of entry. 
.PP
Definition at line 118 of file kconfigskeleton.h.
.SS "void KConfigSkeletonItem::setLabel (const \fBQString\fP & l)\fC [inline]\fP"
.PP
Set label providing a translated one-line description of the item. 
.PP
Definition at line 126 of file kconfigskeleton.h.
.SS "\fBQString\fP KConfigSkeletonItem::label () const\fC [inline]\fP"
.PP
Return label of item. 
.PP
See \fBsetLabel()\fP. 
.PP
Definition at line 134 of file kconfigskeleton.h.
.SS "void KConfigSkeletonItem::setWhatsThis (const \fBQString\fP & w)\fC [inline]\fP"
.PP
Set WhatsThis description og item. 
.PP
Definition at line 142 of file kconfigskeleton.h.
.SS "\fBQString\fP KConfigSkeletonItem::whatsThis () const\fC [inline]\fP"
.PP
Return WhatsThis description of item. 
.PP
See \fBsetWhatsThis()\fP. 
.PP
Definition at line 150 of file kconfigskeleton.h.
.SS "virtual void KConfigSkeletonItem::readConfig (\fBKConfig\fP *)\fC [pure virtual]\fP"
.PP
This function is called by \fBKConfigSkeleton\fP to read the value for this setting from a config file. 
.PP
value. 
.PP
Implemented in \fBKConfigSkeleton::ItemDouble\fP.
.SS "virtual void KConfigSkeletonItem::writeConfig (\fBKConfig\fP *)\fC [pure virtual]\fP"
.PP
This function is called by \fBKConfigSkeleton\fP to write the value of this setting to a config file. 
.PP
.SS "virtual void KConfigSkeletonItem::readDefault (\fBKConfig\fP *)\fC [pure virtual]\fP"
.PP
Read global default value. 
.PP
.SS "virtual void KConfigSkeletonItem::setProperty (const \fBQVariant\fP & p)\fC [pure virtual]\fP"
.PP
Set item to \fCp\fP. 
.PP
Implemented in \fBKConfigSkeleton::ItemDouble\fP.
.PP
Referenced by KConfigDialogManager::updateSettings().
.SS "virtual \fBQVariant\fP KConfigSkeletonItem::property () const\fC [pure virtual]\fP"
.PP
Return item as property. 
.PP
Implemented in \fBKConfigSkeleton::ItemDouble\fP.
.PP
Referenced by KConfigDialogManager::hasChanged(), KConfigDialogManager::updateSettings(), and KConfigDialogManager::updateWidgets().
.SS "virtual \fBQVariant\fP KConfigSkeletonItem::minValue () const\fC [inline, virtual]\fP"
.PP
Return minimum value of item or invalid if not specified. 
.PP
Reimplemented in \fBKConfigSkeleton::ItemDouble\fP.
.PP
Definition at line 186 of file kconfigskeleton.h.
.SS "virtual \fBQVariant\fP KConfigSkeletonItem::maxValue () const\fC [inline, virtual]\fP"
.PP
Return maximum value of item or invalid if not specified. 
.PP
Reimplemented in \fBKConfigSkeleton::ItemDouble\fP.
.PP
Definition at line 191 of file kconfigskeleton.h.
.SS "virtual void KConfigSkeletonItem::setDefault ()\fC [pure virtual]\fP"
.PP
Sets the current value to the default value. 
.PP
.SS "virtual void KConfigSkeletonItem::swapDefault ()\fC [pure virtual]\fP"
.PP
Exchanges the current value with the default value Used by \fBKConfigSkeleton::useDefaults(bool)\fP;. 
.PP
.SS "bool KConfigSkeletonItem::isImmutable () const\fC [inline]\fP"
.PP
Return if the entry can be modified. 
.PP
Definition at line 207 of file kconfigskeleton.h.
.PP
Referenced by KConfigSkeleton::isImmutable(), and KConfigDialogManager::updateWidgets().
.SS "void KConfigSkeletonItem::readImmutability (\fBKConfig\fP * config)\fC [protected]\fP"
.PP
sets mIsImmutable to true if mKey in config is immutable 
.PP
\fBParameters:\fP
.RS 4
\fIconfig\fP \fBKConfig\fP to check if mKey is immutable in 
.RE
.PP

.PP
Definition at line 35 of file kconfigskeleton.cpp.
.PP
Referenced by KConfigSkeleton::ItemDouble::readConfig().

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