class KConfig

KDE Configuration Management class. More...

Definition#include <kconfig.h>
InheritsKConfigBase [public ]
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: KConfigBase, KSimpleConfig, KSimpleConfig

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

KConfig

Constructs a KConfig object.

Parameters:
fileNameA file to parse in addition to the system-wide file(s). If it is not provided, only global KDE configuration data will be read (depending on the value of bUseKDEGlobals).
bReadOnlySet the config object's read-only status.
bUseKDEGlobalsToggle reading the global KDE configuration file.
resTypethe place to look in (config, data, etc) See KStandardDirs.

 ~KConfig ()

~KConfig

[virtual]

Destructs the KConfig object.

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

void  rollback (bool bDeep = true)

rollback

[virtual]

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

Parameters:
bDeepIf true, the dirty map is actually emptied. otherwise, the config object's global dirty flag is set to false, but the dirty entries remain in the dirty entry map.

See also: rollback

Reimplemented from KConfigBase.

QStringList  groupList ()

groupList

[const virtual]

Returns a list of groups that are known.

Reimplemented from KConfigBase.

QMap<QString, QString>  entryMap (const QString &pGroup)

entryMap

[const virtual]

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.

Parameters:
pGroupA group to get keys from.

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 ()

reparseConfiguration

[virtual]

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

Reimplemented from KConfigBase.

void  setFileWriteMode (int mode)

setFileWriteMode

Set the file mode for newly created files.

See also: man:chmod(2), for, a, description, of, @p, mode

void  setForceGlobal ( bool force )

setForceGlobal

Forces all following write-operations being performed on kdeglobals, independent of the bGlobal flag in writeEntry().

See also: forceGlobal

bool  forceGlobal ()

forceGlobal

[const]

Returns true if all entries are being written into kdeglobals.

See also: setForceGlobal

bool  internalHasGroup (const QCString &group)

internalHasGroup

[protected const virtual]

Returns true if the specified group is known.

Parameters:
groupThe group to search for.

Returns: true if the group exists.

Reimplemented from KConfigBase.

KEntryMap  internalEntryMap (const QString &pGroup)

internalEntryMap

[protected const virtual]

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

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

Parameters:
pGroupthe group to provide a KEntryMap for.

Returns: The map of the entries in the group.

Reimplemented from KConfigBase.

KEntryMap  internalEntryMap ()

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:
pGroupthe group to provide a KEntryMap for.

Returns: The map of the entries in the group.

Reimplemented from KConfigBase.

void  putData (const KEntryKey &_key, const KEntry &_data, bool _checkGroup=true)

putData

[protected virtual]

Inserts a (key, value) pair into the internal storage mechanism of the configuration object.

Parameters:
_keyThe key to insert. It contains information both on the group of the key and the key itself. If the key already exists, the old value will be replaced.
_datathe KEntry that is to be stored.
_checkGroupWhen false, assume that the group already exists.

Reimplemented from KConfigBase.

KEntry  lookupData (const KEntryKey &_key)

lookupData

[protected const virtual]

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

Parameters:
_keyThe key to look up It contains information both on the group of the key and the entry's key itself.

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

aEntryMap

[protected]

void  virtual_hook ( int id, void* data )

virtual_hook

[protected virtual]

Reimplemented from KConfigBase.