• Skip to content
  • Skip to link menu
Trinity API Reference
  • Trinity API Reference
  • tdecore
 

tdecore

TDEConfigINIBackEnd Class Reference

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

#include <tdeconfigbackend.h>

Inheritance diagram for TDEConfigINIBackEnd:
TDEConfigBackEnd

List of all members.

Public Member Functions

 TDEConfigINIBackEnd (TDEConfigBase *_config, const TQString &_fileName, const char *_resType, bool _useKDEGlobals=true)
virtual ~TDEConfigINIBackEnd ()
bool parseConfigFiles ()
virtual void sync (bool bMerge=true)

Protected Member Functions

void parseSingleConfigFile (TQFile &rFile, KEntryMap *pWriteBackMap=0L, bool bGlobal=false, bool bDefault=false)
void translateKey (TDELocale &locale, TQCString currentGroup, TQCString key)
bool writeConfigFile (TQString filename, bool bGlobal=false, bool bMerge=true)
bool getEntryMap (KEntryMap &map, bool bGlobal, TQFile *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 191 of file tdeconfigbackend.h.


Constructor & Destructor Documentation

TDEConfigINIBackEnd::TDEConfigINIBackEnd ( TDEConfigBase *  _config,
const TQString &  _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 210 of file tdeconfigbackend.h.

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

Destructs the configuration backend.

Definition at line 217 of file tdeconfigbackend.h.


Member Function Documentation

bool TDEConfigINIBackEnd::getEntryMap ( KEntryMap &  map,
bool  bGlobal,
TQFile *  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 981 of file tdeconfigbackend.cpp.

bool TDEConfigINIBackEnd::parseConfigFiles (  )  [virtual]

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

Returns:
Whether or not parsing was successful.

Implements TDEConfigBackEnd.

Definition at line 320 of file tdeconfigbackend.cpp.

void TDEConfigINIBackEnd::parseSingleConfigFile ( TQFile &  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 450 of file tdeconfigbackend.cpp.

void TDEConfigINIBackEnd::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 TDEConfigBackEnd.

Definition at line 791 of file tdeconfigbackend.cpp.

bool TDEConfigINIBackEnd::writeConfigFile ( TQString  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 1035 of file tdeconfigbackend.cpp.

void TDEConfigINIBackEnd::writeEntries ( FILE *  pStream,
const KEntryMap &  aTempMap 
) [protected]

Write the entries in aTempMap to the file stream.

Definition at line 1138 of file tdeconfigbackend.cpp.


The documentation for this class was generated from the following files:
  • tdeconfigbackend.h
  • tdeconfigbackend.cpp

tdecore

Skip menu "tdecore"
  • Main Page
  • Modules
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

tdecore

Skip menu "tdecore"
  • arts
  • dcop
  • dnssd
  • interfaces
  •   kspeech
  •     interface
  •     library
  •   tdetexteditor
  • kate
  • kded
  • kdoctools
  • kimgio
  • kjs
  • libtdemid
  • libtdescreensaver
  • tdeabc
  • tdecmshell
  • tdecore
  • tdefx
  • tdehtml
  • tdeinit
  • tdeio
  •   bookmarks
  •   httpfilter
  •   kpasswdserver
  •   kssl
  •   tdefile
  •   tdeio
  •   tdeioexec
  • tdeioslave
  •   http
  • tdemdi
  •   tdemdi
  • tdenewstuff
  • tdeparts
  • tdeprint
  • tderandr
  • tderesources
  • tdespell2
  • tdesu
  • tdeui
  • tdeunittest
  • tdeutils
  • tdewallet
Generated for tdecore by doxygen 1.6.3
This website is maintained by Timothy Pearson.