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") | |
KConfig (KConfigBackEnd *backEnd, bool bReadOnly=false) | |
virtual | ~KConfig () |
virtual void | rollback (bool bDeep=true) |
virtual QStringList | groupList () const |
virtual QMap< QString, QString > | entryMap (const QString &pGroup) const |
virtual void | reparseConfiguration () |
void | setFileWriteMode (int mode) |
void | setForceGlobal (bool force) |
bool | forceGlobal () const |
void | checkUpdate (const QString &id, const QString &updateFile) |
KConfig * | copyTo (const QString &file, KConfig *config=0) const |
KLockFile::Ptr | lockFile (bool bGlobal=false) |
Protected Member Functions | |
virtual bool | internalHasGroup (const QCString &group) const |
virtual KEntryMap | internalEntryMap (const QString &pGroup) const |
virtual KEntryMap | internalEntryMap () const |
virtual void | putData (const KEntryKey &_key, const KEntry &_data, bool _checkGroup=true) |
virtual KEntry | lookupData (const KEntryKey &_key) const |
virtual void | virtual_hook (int id, void *data) |
Protected Attributes | |
KEntryMap | aEntryMap |
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>
- See also:
- KGlobal::config(), KConfigBase, KSimpleConfig
Definition at line 43 of file kconfig.h.
Constructor & Destructor Documentation
|
Constructs a KConfig object.
Definition at line 44 of file kconfig.cpp. References KConfigBase::backEnd, KGlobal::dirs(), KConfigBase::KConfigINIBackEnd, reparseConfiguration(), and KConfigBase::setReadOnly(). Referenced by copyTo(). |
|
Destructs the KConfig object. Writes back any dirty configuration entries, and destroys dynamically created objects. Definition at line 87 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 94 of file kconfig.cpp. References aEntryMap, and KConfigBase::rollback(). Referenced by KSimpleConfig::sync(). |
|
Returns a list of groups that are known.
Implements KConfigBase. Definition at line 107 of file kconfig.cpp. References aEntryMap, QString::fromUtf8(), and KConfigBase::group(). Referenced by copyTo(). |
|
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 141 of file kconfig.cpp. References aEntryMap, QString::fromUtf8(), QMap::insert(), and QString::utf8(). Referenced by KStandardDirs::addCustomized(), and copyTo(). |
|
Clears all internal data structures and then reread configuration information from disk.
Implements KConfigBase. Definition at line 161 of file kconfig.cpp. References aEntryMap, KConfigBase::backEnd, KConfigBase::bDirty, KConfigBase::bReadOnly, KConfigBase::isReadOnly(), KConfigBase::parseConfigFiles(), and KConfigBackEnd::sync(). Referenced by checkUpdate(), KConfig(), KDesktopFile::KDesktopFile(), KSimpleConfig::KSimpleConfig(), and KApplication::x11EventFilter(). |
|
Set the file mode for newly created files.
Definition at line 275 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 287 of file kconfig.cpp. References KConfigBase::group(), KApplication::kdeinitExecWait(), KConfigBase::readListEntry(), reparseConfiguration(), and KConfigBase::setGroup(). |
|
Copies all entries from this config object to a new config object that will save itself to
Actual saving to
Definition at line 303 of file kconfig.cpp. References KConfigBase::backEnd, QMap::begin(), bFileImmutable, KConfigBackEnd::changeFileName(), QMap::end(), entryMap(), groupList(), KConfig(), KConfigBackEnd::mConfigState, KConfigBase::setGroup(), KConfigBase::setReadOnly(), and KConfigBase::writeEntry(). Referenced by KDesktopFile::copyTo(). |
|
Returns a lock file object for the configuration file or 0 if the backend does not support locking.
Definition at line 280 of file kconfig.cpp. References KConfigBase::backEnd, and KConfigBackEnd::lockFile(). |
|
Returns true if the specified group is known.
Implements KConfigBase. Definition at line 254 of file kconfig.cpp. References aEntryMap. |
|
Returns a map (tree) of the entries in the specified group. This may or may not return all entries that belong to the config object. The only guarantee that you are given is that any entries that are dirty (i.e. modified and not yet written back to the disk) will be contained in the map. Some derivative classes may choose to return everything. Do not use this function, the implementation / return type are subject to change.
Implements KConfigBase. Definition at line 178 of file kconfig.cpp. References aEntryMap, and QString::utf8(). |
|
Returns a map (tree) of the entries in the tree. Do not use this function, the implementation / return type are subject to change.
Implements KConfigBase. |
|
Inserts a (key, value) pair into the internal storage mechanism of the configuration object.
Implements KConfigBase. Definition at line 202 of file kconfig.cpp. References aEntryMap, KEntryKey::bDefault, KEntry::bGlobal, KEntry::bImmutable, and KEntryKey::mGroup. |
|
Looks up an entry in the config object's internal structure.
Implements KConfigBase. Definition at line 238 of file kconfig.cpp. References aEntryMap, and KEntry::bDeleted. |
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 243 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: