Main Page   Class Hierarchy   Compound List   File List   Compound Members  

config::KConfigINIBackEnd Class Reference

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

#include <kconfigbackend.h>

Inheritance diagram for config::KConfigINIBackEnd:

config::KConfigBackEnd List of all members.

Public Methods

 KConfigINIBackEnd (KConfigBase *_config, const string &_fileName, const char *_resType, bool _useKDEGlobals=true)
 Constructs an ini-style configuration back end. More...

virtual ~KConfigINIBackEnd ()
 Destructs the configuration backend.

bool parseConfigFiles ()
 Parses all INI-style configuration files for a config object. More...

virtual void sync (bool bMerge=true)
 Writes configuration data to file(s).

Protected Methods

void parseSingleConfigFile (string &rFile, KEntryMap *pWriteBackMap=0L, bool bGlobal=false, bool bDefault=false)
 Parses one configuration file. More...

bool writeConfigFile (string filename, bool bGlobal=false, bool bMerge=true)
 Writes configuration file back. More...

virtual void virtual_hook (int id, void *data)

Detailed Description

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

Preston Brown <>, Matthias Kalle Dalheimer <>
kconfigbackend.h,v 2002/12/01 04:08:23 zl Exp

Constructor & Destructor Documentation

config::KConfigINIBackEnd::KConfigINIBackEnd KConfigBase   _config,
const string &    _fileName,
const char *    _resType,
bool    _useKDEGlobals = true

Constructs an ini-style configuration back end.

_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.

Member Function Documentation

bool config::KConfigINIBackEnd::parseConfigFiles   [virtual]

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

Whether or not parsing was successful.

Implements config::KConfigBackEnd.

void config::KConfigINIBackEnd::parseSingleConfigFile string &    rFile,
KEntryMap *    pWriteBackMap = 0L,
bool    bGlobal = false,
bool    bDefault = false

Parses one configuration file.

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.

bool config::KConfigINIBackEnd::writeConfigFile string    filename,
bool    bGlobal = false,
bool    bMerge = true

Writes configuration file back.

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.
Whether some entries are left to be written to other files.

The documentation for this class was generated from the following files:
Generated on Sat Dec 14 20:05:54 2002 for libconfig by doxygen1.2.14 written by Dimitri van Heesch, © 1997-2002