.TH "KSimpleConfig" kde3 "11 Jun 2005" "Version Version 3.4.1" "kdecore Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KSimpleConfig \- \fBKDE\fP Configuration entries \fBKDE\fP Configuration Management class with deletion ability.  

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

.in +1c
.ti -1c
.RI "\fBKSimpleConfig\fP (const \fBQString\fP &fileName, bool bReadOnly=false)"
.br
.ti -1c
.RI "\fBKSimpleConfig\fP (\fBKConfigBackEnd\fP *\fBbackEnd\fP, bool bReadOnly=false)"
.br
.ti -1c
.RI "virtual \fB~KSimpleConfig\fP ()"
.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 
\fBKDE\fP Configuration entries \fBKDE\fP Configuration Management class with deletion ability. 

This is a trivial extension of \fBKConfig\fP for applications that need only one configuration file and no default system. A difference with \fBKConfig\fP is that when the data in memory is written back it is not merged with what is on disk. Whatever is in memory simply replaces what is on disk entirely.
.PP
\fBAuthor:\fP
.RS 4
Kalle Dalheimer <kalle@kde.org>, Preston Brown <pbrown@kde.org> 
.RE
.PP
\fBSee also:\fP
.RS 4
\fBKConfigBase\fP \fBKConfig\fP 
.RE
.PP

.PP
Definition at line 41 of file ksimpleconfig.h.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "KSimpleConfig::KSimpleConfig (const \fBQString\fP & fileName, bool bReadOnly = \fCfalse\fP)"
.PP
Construct a KSimpleConfig object and make it either read-write or read-only. 
.PP
\fBParameters:\fP
.RS 4
\fIfileName\fP The file used for saving the config data. Either a full path can be specified or just the filename. If only a filename is specified, the default directory for 'config' files is used. 
.br
\fIbReadOnly\fP Whether the object should be read-only. 
.RE
.PP

.PP
Definition at line 40 of file ksimpleconfig.cpp.
.PP
References KConfigBackEnd::changeFileName(), QDir::isRelativePath(), KConfig::reparseConfiguration(), and KConfigBase::setReadOnly().
.SS "KSimpleConfig::~\fBKSimpleConfig\fP ()\fC [virtual]\fP"
.PP
Destructor. 
.PP
Writes back any dirty configuration entries. 
.PP
Definition at line 59 of file ksimpleconfig.cpp.
.PP
References sync().
.SH "Member Function Documentation"
.PP 
.SS "void KSimpleConfig::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 68 of file ksimpleconfig.cpp.
.PP
References KConfigBase::isDirty(), KConfigBase::isReadOnly(), KConfig::rollback(), and KConfigBackEnd::sync().
.PP
Referenced by ~KSimpleConfig().

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