.TH "KConfigGroup" kde3 "11 Jun 2005" "Version Version 3.4.1" "kdecore Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KConfigGroup \- A \fBKConfigBase\fP derived class for one specific group in a \fBKConfig\fP object.  

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

.in +1c
.ti -1c
.RI "\fBKConfigGroup\fP (\fBKConfigBase\fP *master, const \fBQCString\fP &group)"
.br
.ti -1c
.RI "\fBKConfigGroup\fP (\fBKConfigBase\fP *master, const \fBQString\fP &group)"
.br
.ti -1c
.RI "\fBKConfigGroup\fP (\fBKConfigBase\fP *master, const char *group)"
.br
.ti -1c
.RI "void \fBdeleteGroup\fP (bool bGlobal=false)"
.br
.ti -1c
.RI "bool \fBgroupIsImmutable\fP () const "
.br
.ti -1c
.RI "virtual void \fBsetDirty\fP (bool b)"
.br
.ti -1c
.RI "virtual void \fBputData\fP (const \fBKEntryKey\fP &_key, const \fBKEntry\fP &_data, bool _checkGroup=true)"
.br
.ti -1c
.RI "virtual \fBKEntry\fP \fBlookupData\fP (const \fBKEntryKey\fP &_key) const "
.br
.ti -1c
.RI "virtual void \fBsync\fP ()"
.br
.in -1c
.SS "Protected Member Functions"

.in +1c
.ti -1c
.RI "virtual void \fBvirtual_hook\fP (int id, void *data)"
.br
.in -1c
.SH "Detailed Description"
.PP 
A \fBKConfigBase\fP derived class for one specific group in a \fBKConfig\fP object. 
.PP
Definition at line 2095 of file kconfigbase.h.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "KConfigGroup::KConfigGroup (\fBKConfigBase\fP * master, const \fBQCString\fP & group)"
.PP
Construct a config group corresponding to \fCgroup\fP in \fCmaster\fP. 
.PP
\fCgroup\fP is the group name encoded in UTF-8. 
.PP
Definition at line 1777 of file kconfigbase.cpp.
.PP
References KConfigBase::aLocaleString, KConfigBase::backEnd, KConfigBase::bReadOnly, KConfigBase::readDefaults(), and KConfigBase::setReadDefaults().
.SS "KConfigGroup::KConfigGroup (\fBKConfigBase\fP * master, const \fBQString\fP & group)"
.PP
This is an overloaded constructor provided for convenience. 
.PP
It behaves essentially like the above function.
.PP
Construct a config group corresponding to \fCgroup\fP in \fCmaster\fP 
.PP
Definition at line 1764 of file kconfigbase.cpp.
.PP
References KConfigBase::aLocaleString, KConfigBase::backEnd, KConfigBase::bReadOnly, KConfigBase::readDefaults(), and KConfigBase::setReadDefaults().
.SS "KConfigGroup::KConfigGroup (\fBKConfigBase\fP * master, const char * group)"
.PP
This is an overloaded constructor provided for convenience. 
.PP
It behaves essentially like the above function.
.PP
Construct a config group corresponding to \fCgroup\fP in \fCmaster\fP \fCgroup\fP is the group name encoded in UTF-8. 
.PP
Definition at line 1790 of file kconfigbase.cpp.
.PP
References KConfigBase::aLocaleString, KConfigBase::backEnd, KConfigBase::bReadOnly, KConfigBase::readDefaults(), and KConfigBase::setReadDefaults().
.SH "Member Function Documentation"
.PP 
.SS "void KConfigGroup::deleteGroup (bool bGlobal = \fCfalse\fP)"
.PP
Delete all entries in the entire group. 
.PP
\fBParameters:\fP
.RS 4
\fIbGlobal\fP If \fCbGlobal\fP is true, the entries are not removed from the application specific config file, but from the global \fBKDE\fP config file. 
.RE
.PP

.PP
Definition at line 1803 of file kconfigbase.cpp.
.PP
References KConfigBase::deleteGroup().
.SS "bool KConfigGroup::groupIsImmutable () const"
.PP
Checks whether it is possible to change this group. 
.PP
\fBReturns:\fP
.RS 4
whether changes may be made to this group in this configuration file. 
.RE
.PP
\fBSince:\fP
.RS 4
3.4 
.RE
.PP

.PP
Definition at line 1808 of file kconfigbase.cpp.
.PP
References KConfigBase::groupIsImmutable().
.SS "void KConfigGroup::setDirty (bool _bDirty)\fC [virtual]\fP"
.PP
Sets the global dirty flag of the config object. 
.PP
\fBParameters:\fP
.RS 4
\fI_bDirty\fP How to mark the object's dirty status 
.RE
.PP

.PP
Reimplemented from \fBKConfigBase\fP.
.PP
Definition at line 1813 of file kconfigbase.cpp.
.PP
References KConfigBase::setDirty().
.SS "void KConfigGroup::putData (const \fBKEntryKey\fP & _key, const \fBKEntry\fP & _data, bool _checkGroup = \fCtrue\fP)\fC [virtual]\fP"
.PP
Inserts a (key/value) pair into the internal storage mechanism of the configuration object. 
.PP
Classes that derive from \fBKConfigBase\fP will need to implement this method in a storage-specific manner.
.PP
Do not use this function, the implementation / return type are subject to change.
.PP
\fBParameters:\fP
.RS 4
\fI_key\fP The key to insert. It contains information both on the group of the key and the key itself. If the key already exists, the old value will be replaced. 
.br
\fI_data\fP the \fBKEntry\fP that is to be stored. 
.br
\fI_checkGroup\fP When false, assume that the group already exists. 
.RE
.PP

.PP
Implements \fBKConfigBase\fP.
.PP
Definition at line 1818 of file kconfigbase.cpp.
.PP
References KConfigBase::putData().
.SS "\fBKEntry\fP KConfigGroup::lookupData (const \fBKEntryKey\fP & _key) const\fC [virtual]\fP"
.PP
Looks up an entry in the config object's internal structure. 
.PP
Classes that derive from \fBKConfigBase\fP will need to implement this method in a storage-specific manner.
.PP
Do not use this function, the implementation and return type are subject to change.
.PP
\fBParameters:\fP
.RS 4
\fI_key\fP The key to look up It contains information both on the group of the key and the entry's key itself. 
.RE
.PP
\fBReturns:\fP
.RS 4
The \fBKEntry\fP value (data) found for the key. \fCKEntry.aValue\fP will be the null string if nothing was located. 
.RE
.PP

.PP
Implements \fBKConfigBase\fP.
.PP
Definition at line 1823 of file kconfigbase.cpp.
.PP
References KConfigBase::lookupData().
.SS "void KConfigGroup::sync ()\fC [virtual]\fP"
.PP
Flushes all changes that currently reside only in memory back to disk / permanent storage. 
.PP
Dirty configuration entries are written to the most specific file available.
.PP
Asks the back end to flush out all pending writes, and then calls \fBrollback()\fP. No changes are made if the object has \fCreadOnly\fP status.
.PP
You should call this from your destructor in derivative classes.
.PP
\fBSee also:\fP
.RS 4
\fBrollback()\fP, \fBisReadOnly()\fP 
.RE
.PP

.PP
Reimplemented from \fBKConfigBase\fP.
.PP
Definition at line 1828 of file kconfigbase.cpp.
.PP
References KConfigBase::sync().

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