|
|
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:
fileName | A 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 ).
|
bReadOnly | Set the config object's read-only status. Note that the
object will automatically become read-only if either the user does not have
write permission to fileName or if no file was specified.
|
bUseKDEGlobals | Toggle reading the global KDE configuration file. |
resType | the 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:
bDeep | If 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.
Returns: a list of of groups
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:
pGroup | A 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.
Parameters:
mode | the mode for new files as described in chmod(2) |
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().
Parameters:
force | true to force writing in kdeglobals |
See also: forceGlobal
bool forceGlobal ()
| forceGlobal |
[const]
Returns true if all entries are being written into kdeglobals.
Returns: true if all entries are being written into kdeglobals
See also: setForceGlobal
void checkUpdate (const QString &id, const QString &updateFile)
| checkUpdate |
Checks whether the config file contains the update id
as contained in updateFile
. 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.
Parameters:
id | the update to check |
updateFile | the file containing the update |
bool internalHasGroup (const QCString &group)
| internalHasGroup |
[protected const virtual]
Returns true if the specified group is known.
Parameters:
group | The 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:
pGroup | the 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:
pGroup | the 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:
_key | The 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. |
_data | the KEntry that is to be stored. |
_checkGroup | When 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:
_key | The 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.