KConfigINIBackEnd Class Reference

Class for KDE INI-style configuration file loading/saving. More...

#include <kconfigbackend.h>

Inheritance diagram for KConfigINIBackEnd:

[legend]Collaboration diagram for KConfigINIBackEnd:


Public Member Functions
	KConfigINIBackEnd (KConfigBase _config, const QString &_fileName, const char _resType, bool _useKDEGlobals=true)
virtual	~KConfigINIBackEnd ()
bool	parseConfigFiles ()
virtual void	sync (bool bMerge=true)
Protected Member Functions
void	parseSingleConfigFile (QFile &rFile, KEntryMap *pWriteBackMap=0L, bool bGlobal=false, bool bDefault=false)
bool	writeConfigFile (QString filename, bool bGlobal=false, bool bMerge=true)
bool	getEntryMap (KEntryMap &map, bool bGlobal, QFile *mergeFile)
void	writeEntries (FILE *pStream, const KEntryMap &aTempMap)
virtual void	virtual_hook (int id, void *data)

Detailed Description

Class for KDE INI-style configuration file loading/saving.

Author:: Preston Brown <pbrown@kde.org>, Matthias Kalle Dalheimer <kalle@kde.org>

Definition at line 190 of file kconfigbackend.h.

Constructor & Destructor Documentation

KConfigINIBackEnd::KConfigINIBackEnd ( KConfigBase * _config,

const QString & _fileName,

const char * _resType,

bool _useKDEGlobals = true

) [inline]

Constructs an ini-style configuration back end.

Parameters:

_config Specifies the configuration object which values will be passed to as they are read, or from where values to be written to will be obtained from.

_fileName The name of the file in which config data is stored. All registered configuration directories will be looked in in order of decreasing relevance.

_resType the resource type of the fileName specified, _if_ it is not an absolute path (otherwise this parameter is ignored).

_useKDEGlobals If true, the user's system-wide kdeglobals file will be imported into the config object. If false, only the filename specified will be dealt with.

Definition at line 209 of file kconfigbackend.h.

virtual KConfigINIBackEnd::~KConfigINIBackEnd ( ) [inline, virtual]

Destructs the configuration backend.

Definition at line 216 of file kconfigbackend.h.

Member Function Documentation

bool KConfigINIBackEnd::parseConfigFiles ( ) [virtual]

Parses all INI-style configuration files for a config object.

Returns:
Whether or not parsing was successful.

Implements KConfigBackEnd.
Definition at line 296 of file kconfigbackend.cpp.
References KURL::directory(), KGlobal::dirs(), KStandardDirs::findAllResources(), KConfigBase::isReadOnly(), KStandardDirs::makeDir(), parseSingleConfigFile(), KConfigBackEnd::setLocaleString(), and KURL::setPath().

void KConfigINIBackEnd::sync ( bool bMerge = true ) [virtual]

Writes configuration data to file(s).

Parameters:

bMerge Specifies whether the old config file already on disk should be merged in with the data in memory. If true, data is read off the disk and merged. If false, the on-disk file is removed and only in-memory data is written out.

Implements KConfigBackEnd.
Definition at line 720 of file kconfigbackend.cpp.
References KURL::directory(), KConfigBase::isDirty(), KConfigBackEnd::lockFile(), KStandardDirs::makeDir(), KURL::setPath(), and writeConfigFile().

void KConfigINIBackEnd::parseSingleConfigFile ( QFile & rFile,

KEntryMap * pWriteBackMap = 0L,

bool bGlobal = false,

bool bDefault = false

) [protected]

Parses one configuration file.

Parameters:

rFile The configuration file to parse

pWriteBackMap If specified, points to a KEntryMap where the data read from the file should be stored, instead of inserting them directly into the configuration object. Use this area as a "scratchpad" when you need to know what is on disk but don't want to effect the configuration object.

bGlobal Specifies whether entries should be marked as belonging to the global KDE configuration file rather than the application-specific KDE configuration file(s).

bDefault Specifies whether entries should be marked as being default values.

Definition at line 430 of file kconfigbackend.cpp.
References KEntryKey::bDefault, KEntry::bDeleted, KEntry::bExpand, KEntry::bGlobal, KEntry::bImmutable, KEntryKey::bLocal, KEntry::bNLS, KConfigBase::lookupData(), KEntry::mValue, and KConfigBase::putData().
Referenced by parseConfigFiles().

bool KConfigINIBackEnd::writeConfigFile ( QString filename,

bool bGlobal = false,

bool bMerge = true

) [protected]

Writes configuration file back.

Parameters:

filename The name of the file to write.

bGlobal Specifies whether to write only entries which are marked as belonging to the global KDE config file. If this is false, it skips those entries.

bMerge Specifies whether the old config file already on disk should be merged in with the data in memory. If true, data is read off the disk and merged. If false, the on-disk file is removed and only in-memory data is written out.

Returns:
Whether some entries are left to be written to other files.

Definition at line 964 of file kconfigbackend.cpp.
References KSaveFile::abort(), KSaveFile::close(), KSaveFile::fstream(), getEntryMap(), KSaveFile::handle(), KConfigBase::isReadOnly(), KSaveFile::status(), and writeEntries().
Referenced by sync().

bool KConfigINIBackEnd::getEntryMap ( KEntryMap & map,

bool bGlobal,

QFile * mergeFile

) [protected]

Get the entry map.

Parameters:

map the entries will be stored in this object.

bGlobal Specifies whether to get only entries which are marked as belonging to the global KDE config file. If this is false, it skips those entries.

mergeFile if not null, the dirty entries for this file will be merged.

Returns:
Whether there will be some entries left for writing to other files.

Definition at line 910 of file kconfigbackend.cpp.
References KEntry::bDirty, and KEntry::bGlobal.
Referenced by writeConfigFile().

void KConfigINIBackEnd::writeEntries ( FILE * pStream,

const KEntryMap & aTempMap

) [protected]

Write the entries in aTempMap to the file stream.

Definition at line 1067 of file kconfigbackend.cpp.
Referenced by writeConfigFile().

The documentation for this class was generated from the following files:

kdecore Library API Documentation

KConfigINIBackEnd Class Reference

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation