KConfig Class Reference
Access KDE Configuration entries. KDE Configuration Management class. More...
#include <kconfig.h>
Inheritance diagram for KConfig:


Public Member Functions | |
KConfig (const QString &fileName=QString::null, bool bReadOnly=false, bool bUseKDEGlobals=true, const char *resType="config") | |
Constructs a KConfig object. | |
virtual | ~KConfig () |
Destructs the KConfig object. | |
virtual void | rollback (bool bDeep=true) |
Clears all entries out of the dirtyEntryMap , so the values will not be written to disk on a later call to sync(). | |
virtual QStringList | groupList () const |
Returns a list of groups that are known. | |
virtual QMap< QString, QString > | entryMap (const QString &pGroup) const |
Returns a map (tree) of entries for all entries in a particular group. | |
virtual void | reparseConfiguration () |
Clears all internal data structures and then reread configuration information from disk. | |
void | setFileWriteMode (int mode) |
Set the file mode for newly created files. | |
void | setForceGlobal (bool force) |
Forces all following write-operations being performed on kdeglobals, independent of the bGlobal flag in writeEntry(). | |
bool | forceGlobal () const |
Returns true if all entries are being written into kdeglobals. | |
void | checkUpdate (const QString &id, const QString &updateFile) |
Checks whether the config file contains the update id as contained in updateFile . | |
Protected Member Functions | |
virtual bool | internalHasGroup (const QCString &group) const |
Returns true if the specified group is known. | |
virtual KEntryMap | internalEntryMap (const QString &pGroup) const |
Returns a map (tree) of the entries in the specified group. | |
virtual KEntryMap | internalEntryMap () const |
Returns a copy of the internal map used to hold all entries. | |
virtual void | putData (const KEntryKey &_key, const KEntry &_data, bool _checkGroup=true) |
Inserts a (key, value) pair into the internal storage mechanism of the configuration object. | |
virtual KEntry | lookupData (const KEntryKey &_key) const |
Looks up an entry in the config object's internal structure. | |
virtual void | virtual_hook (int id, void *data) |
Protected Attributes | |
KEntryMap | aEntryMap |
Contains all key,value entries, as well as some "special" keys which indicate the start of a group of entries. |
Detailed Description
Access KDE Configuration entries. KDE Configuration Management class.This class implements KDE's default configuration system.
- Author:
- Kalle Dalheimer <kalle@kde.org>, Preston Brown <pbrown@kde.org>
- Version:
- Id
- kconfig.h,v 1.51 2002/09/28 12:28:47 tjansen Exp
- See also:
- KGlobal::config(), KConfigBase, KSimpleConfig
Definition at line 43 of file kconfig.h.
Constructor & Destructor Documentation
|
Constructs a KConfig object.
Definition at line 43 of file kconfig.cpp. References KStandardDirs::addCustomized(), KConfigBase::backEnd, KGlobal::dirs(), reparseConfiguration(), and KConfigBase::setReadOnly(). |
|
Destructs the KConfig object. Writes back any dirty configuration entries, and destroys dynamically created objects. Definition at line 76 of file kconfig.cpp. References KConfigBase::backEnd, and KConfigBase::sync(). |
Member Function Documentation
|
Clears all entries out of the
Reimplemented from KConfigBase. Definition at line 83 of file kconfig.cpp. References aEntryMap, QMap::begin(), QMap::end(), and KConfigBase::rollback(). Referenced by KSimpleConfig::sync(). |
|
Returns a list of groups that are known.
Implements KConfigBase. Definition at line 96 of file kconfig.cpp. References aEntryMap, QMap::begin(), QMap::end(), QString::fromUtf8(), KConfigBase::group(), and QMap::isEmpty(). |
|
Returns a map (tree) of entries for all entries in a particular group. Only the actual entry string is returned, none of the other internal data should be included.
Implements KConfigBase. Definition at line 130 of file kconfig.cpp. References aEntryMap, QMap::end(), QMap::find(), QString::fromUtf8(), QMap::insert(), and QString::utf8(). Referenced by KStandardDirs::addCustomized(). |
|
Clears all internal data structures and then reread configuration information from disk.
Implements KConfigBase. Definition at line 150 of file kconfig.cpp. References aEntryMap, QMap::clear(), QMap::insert(), and KConfigBase::parseConfigFiles(). Referenced by checkUpdate(), KInstance::config(), KInstance::dirs(), KConfig(), KDesktopFile::KDesktopFile(), and KSimpleConfig::KSimpleConfig(). |
|
Set the file mode for newly created files.
Definition at line 259 of file kconfig.cpp. References KConfigBase::backEnd, and KConfigBackEnd::setFileWriteMode(). |
|
Forces all following write-operations being performed on kdeglobals, independent of the bGlobal flag in writeEntry().
|
|
Returns true if all entries are being written into kdeglobals.
|
|
Checks whether the config file contains the update If not, it runs kconf_update to update the config file. If you install config update files with critical fixes you may wish to use this method to verify that a critical update has indeed been performed to catch the case where a user restores an old config file from backup that has not been updated yet.
Definition at line 264 of file kconfig.cpp. References KConfigBase::group(), KApplication::kdeinitExecWait(), KConfigBase::readListEntry(), reparseConfiguration(), and KConfigBase::setGroup(). |
|
Returns true if the specified group is known.
Implements KConfigBase. Definition at line 238 of file kconfig.cpp. References aEntryMap, QMap::end(), QMap::find(), and QMap::isEmpty(). |
|
Returns a map (tree) of the entries in the specified group. Do not use this function, the implementation / return type are subject to change.
Implements KConfigBase. Definition at line 163 of file kconfig.cpp. References aEntryMap, QMap::end(), QMap::find(), QMap::insert(), and QString::utf8(). |
|
Returns a copy of the internal map used to hold all entries. Do not use this function, the implementation / return type are subject to change.
Implements KConfigBase. Definition at line 183 of file kconfig.h. References aEntryMap. |
|
Inserts a (key, value) pair into the internal storage mechanism of the configuration object.
Implements KConfigBase. Definition at line 187 of file kconfig.cpp. References aEntryMap, KEntryKey::bDefault, KEntry::bGlobal, KEntry::bImmutable, KStdAccel::key(), and KEntryKey::mGroup. |
|
Looks up an entry in the config object's internal structure.
Implements KConfigBase. Definition at line 222 of file kconfig.cpp. References aEntryMap, KEntry::bDeleted, QMap::end(), and QMap::find(). |
Member Data Documentation
|
Contains all key,value entries, as well as some "special" keys which indicate the start of a group of entries. These special keys will have the .key portion of their KEntryKey set to QString::null. Definition at line 214 of file kconfig.h. Referenced by entryMap(), groupList(), internalEntryMap(), internalHasGroup(), lookupData(), putData(), reparseConfiguration(), and rollback(). |
The documentation for this class was generated from the following files: