class KConfig

KDE Configuration Management class. More...

Definition#include <kconfig.h>
InheritsKConfigBase
Inherited byKDesktopFile, KSimpleConfig
List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

Public Methods

Protected Methods

Protected Members


Detailed Description

Access KDE Configuration entries.

This class implements KDE's default configuration system.

See also: config, KConfigBase, KSimpleConfig

 KConfig ( const QString& fileName = QString::null, bool bReadOnly = false, bool bUseKDEGlobals = true, const char *resType="config")

Construct a KConfig object.

Parameters:

KConfig ()

[virtual]

Destructor.

Writes back any dirty configuration entries, and destroys dynamically created objects.

void  rollback (bool bDeep = true)

[virtual]

Clears all entries out of the dirtyEntryMap, so the values will not be written to disk on a later call to sync().

Parameters:

Reimplemented from KConfigBase.

bool  hasGroup (const QString &_pGroup)

[const virtual]

Parameters:

Returns: true if the group exists.

Reimplemented from KConfigBase.

QStringList  groupList ()

[const virtual]

Retrieve a list of groups that are known.

Returns: The list of groups.

Reimplemented from KConfigBase.

bool  hasKey (const QString &pKey)

[const virtual]

Reimplemented from KConfigBase.

QMap  entryMap (const QString &pGroup)

[const virtual]

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

Parameters:

Returns: A map of entries in the group specified, indexed by key. The returned map may be empty if the group is not found.

Reimplemented from KConfigBase.

void  reparseConfiguration ()

[virtual]

Clear all internal data structures and then reread configuration information from disk.

Reimplemented from KConfigBase.

KEntryMap  internalEntryMap (const QString &pGroup)

[protected const virtual]

Retrieve a map (tree) of the entries in the specified group.

Do not use this function, the implementation / return type are subject to change.

Parameters:

Returns: The map of the entries in the group.

Reimplemented from KConfigBase.

KEntryMap  internalEntryMap ()

[protected const virtual]

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.

Parameters:

Returns: The map of the entries in the group.

Reimplemented from KConfigBase.

void  putData (const KEntryKey &_key, const KEntry &_data)

[protected virtual]

Insert a key,value pair into the internal storage mechanism of the configuration object.

Parameters:

Reimplemented from KConfigBase.

KEntry  lookupData (const KEntryKey &_key)

[protected const virtual]

Look up an entry in the config object's internal structure.

Parameters:

Returns: the KEntry value (data) found for the key. KEntry.aValue will be the null string if nothing was located.

Reimplemented from KConfigBase.

KEntryMap aEntryMap

[protected]

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.

bool  hasGroup (const QCString &_pGroup)

[const virtual]

Overloaded public functions.

Reimplemented from KConfigBase.

bool  hasGroup (const char *_pGroup)

[const virtual]

Reimplemented from KConfigBase.

bool  hasKey (const char *pKey)

[const virtual]

Reimplemented from KConfigBase.