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

kdecore

Public Member Functions | Protected Member Functions | List of all members
KConfigINIBackEnd Class Reference

#include <kconfigbackend.h>

Inheritance diagram for KConfigINIBackEnd:
KConfigBackEnd

Public Member Functions

 KConfigINIBackEnd (KConfigBase *_config, const TQString &_fileName, const char *_resType, bool _useKDEGlobals=true)
 
virtual ~KConfigINIBackEnd ()
 
bool parseConfigFiles ()
 
virtual void sync (bool bMerge=true)
 
- Public Member Functions inherited from KConfigBackEnd
 KConfigBackEnd (KConfigBase *_config, const TQString &_fileName, const char *_resType, bool _useKDEGlobals)
 
virtual ~KConfigBackEnd ()
 
void changeFileName (const TQString &_fileName, const char *_resType, bool _useKDEGlobals)
 
virtual KConfigBase::ConfigState getConfigState () const
 
TQString fileName () const
 
const char * resource () const
 
void setLocaleString (const TQCString &_localeString)
 
void setFileWriteMode (int mode)
 
bool checkConfigFilesWritable (bool warnUser)
 
KLockFile::Ptr lockFile (bool bGlobal=false)
 
KDE_DEPRECATED TQString filename () const
 

Protected Member Functions

void parseSingleConfigFile (TQFile &rFile, KEntryMap *pWriteBackMap=0L, bool bGlobal=false, bool bDefault=false)
 
void translateKey (KLocale &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)
 

Additional Inherited Members

- Protected Attributes inherited from KConfigBackEnd
KConfigBase * pConfig
 
TQString mfileName
 
TQCString resType
 
bool useKDEGlobals: 1
 
bool bFileImmutable: 1
 
TQCString localeString
 
TQString mLocalFileName
 
TQString mGlobalFileName
 
KConfigBase::ConfigState mConfigState
 
int mFileMode
 
KConfigBackEndPrivate * d
 

Detailed Description

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

Author
Preston Brown pbrow.nosp@m.n@kd.nosp@m.e.org, Matthias Kalle Dalheimer kalle.nosp@m.@kde.nosp@m..org

Definition at line 191 of file kconfigbackend.h.

Constructor & Destructor Documentation

KConfigINIBackEnd::KConfigINIBackEnd ( KConfigBase *  _config,
const TQString &  _fileName,
const char *  _resType,
bool  _useKDEGlobals = true 
)
inline

Constructs an ini-style configuration back end.

Parameters
_configSpecifies 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.
_fileNameThe name of the file in which config data is stored. All registered configuration directories will be looked in in order of decreasing relevance.
<em>resTypethe resource type of the fileName specified, _if it is not an absolute path (otherwise this parameter is ignored).
_useKDEGlobalsIf 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 kconfigbackend.h.

virtual KConfigINIBackEnd::~KConfigINIBackEnd ( )
inlinevirtual

Destructs the configuration backend.

Definition at line 217 of file kconfigbackend.h.

Member Function Documentation

bool KConfigINIBackEnd::getEntryMap ( KEntryMap &  map,
bool  bGlobal,
TQFile *  mergeFile 
)
protected

Get the entry map.

Parameters
mapthe entries will be stored in this object.
bGlobalSpecifies whether to get only entries which are marked as belonging to the global KDE config file. If this is false, it skips those entries.
mergeFileif 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 kconfigbackend.cpp.

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 320 of file kconfigbackend.cpp.

void KConfigINIBackEnd::parseSingleConfigFile ( TQFile &  rFile,
KEntryMap *  pWriteBackMap = 0L,
bool  bGlobal = false,
bool  bDefault = false 
)
protected

Parses one configuration file.

Parameters
rFileThe configuration file to parse
pWriteBackMapIf 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.
bGlobalSpecifies whether entries should be marked as belonging to the global KDE configuration file rather than the application-specific KDE configuration file(s).
bDefaultSpecifies whether entries should be marked as being default values.

Definition at line 450 of file kconfigbackend.cpp.

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

Writes configuration data to file(s).

Parameters
bMergeSpecifies 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 791 of file kconfigbackend.cpp.

bool KConfigINIBackEnd::writeConfigFile ( TQString  filename,
bool  bGlobal = false,
bool  bMerge = true 
)
protected

Writes configuration file back.

Parameters
filenameThe name of the file to write.
bGlobalSpecifies whether to write only entries which are marked as belonging to the global KDE config file. If this is false, it skips those entries.
bMergeSpecifies 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 kconfigbackend.cpp.

void KConfigINIBackEnd::writeEntries ( FILE *  pStream,
const KEntryMap &  aTempMap 
)
protected

Write the entries in aTempMap to the file stream.

Definition at line 1138 of file kconfigbackend.cpp.


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

kdecore

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

kdecore

Skip menu "kdecore"
  • arts
  • dcop
  • dnssd
  • interfaces
  •     interface
  •     library
  •   kspeech
  •   ktexteditor
  • kabc
  • kate
  • kcmshell
  • kdecore
  • kded
  • kdefx
  • kdeprint
  • kdesu
  • kdeui
  • kdoctools
  • khtml
  • kimgio
  • kinit
  • kio
  •   bookmarks
  •   httpfilter
  •   kfile
  •   kio
  •   kioexec
  •   kpasswdserver
  •   kssl
  • kioslave
  •   http
  • kjs
  • kmdi
  •   kmdi
  • knewstuff
  • kparts
  • krandr
  • kresources
  • kspell2
  • kunittest
  • kutils
  • kwallet
  • libkmid
  • libkscreensaver
Generated for kdecore by doxygen 1.8.3.1
This website is maintained by Timothy Pearson.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. |