class KConfig |
|
|
Access KDE Configuration entries. This class implements KDE's default configuration system.
Author Kalle Dalheimer See also KGlobal.config(), KConfigBase, KConfigGroup KDE Configuration Management class |
|
Constructs a KConfig object.
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 flags). flags - determines how the configuration file is created and accessed. Passing in IncludeGlobals will result in entries in kdeglobals being parsed and included in the merged settings |
|
Constructs a KConfig object.
resType - the place to look in (config, data, etc) See KStandardDirs. 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 flags). flags - determines how the configuration file is created and accessed. Passing in IncludeGlobals will result in entries in kdeglobals being parsed and included in the merged settings |
|
Constructs a KConfig object.
componentData - The KComponentData object of your component. If you don't know what this is you likely want to use the above constructor. 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 flags). flags - determines how the configuration file is created and accessed. Passing in IncludeGlobals will result in entries in kdeglobals being parsed and included in the merged settings resType - the place to look in (config, data, etc) See KStandardDirs. |
|
|
|
Internal copy-construction and assignment are not allowed |
|
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. id - the update to check updateFile - the file containing the update |
|
Copies all entries from this config object to a new config object that will save itself to file. Actual saving to file happens when the returned object is destructed or when sync() is called upon it.
file - the new config object will save itself to. config - optional config object to reuse |
|
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.
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. |
|
Gets the extraConfigFiles in the merge stack. |
|
Returns true if all entries are being written into kdeglobals. Returns true if all entries are being written into kdeglobals See also setForceGlobal |
|
|
|
|
|
Returns a list of groups that are known. Returns a list of of groups |
|
Internal Returns a map (tree) of the entries in the specified group. Do not use this function, the implementation / return type are subject to change.
pGroup - the group to provide a KEntryMap for. Returns The map of the entries in the group. |
|
Internal 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. Returns The map of the entries in the group. |
|
Internal copy-construction and assignment are not allowed Returns true if the specified group is known.
group - The group to search for. Returns true if the group exists. |
|
Returns a lock file object for the configuration file or 0 if the backend does not support locking. bGlobal - if true, return the lock file for the global config file NOTE: KConfig.sync() requires a lock on both the normal and global config file. When calling KConfig.sync() while having a lock on the global config file, the normal config file MUST be locked AS WELL and the normal config file MUST be locked BEFORE the global config file! Otherwise there is a risk of deadlock. |
|
Looks up an entry in the config object's internal structure.
_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. |
|
Inserts a (key, value) pair into the internal storage mechanism of the configuration object.
_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. |
|
Remove all files from merge stack. This does not include the local file that was specified in the constructor. |
|
Clears all internal data structures and then reread configuration information from disk. |
|
Clears all entries out of the dirtyEntryMap, so the values will not be written to disk on a later call to sync().
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 KConfigBase.rollback |
|
Sets the merge stack to the list of files. The stack is last in first out with the top of the stack being the most specific config file. files - A list of extra config files containing the full path of the local config file to remove from the stack. |
|
Set the file mode for newly created files.
mode - the mode for new files as described in chmod(2) See also man:chmod(2) for a description of mode |
|
Forces all following write-operations being performed on kdeglobals, independent of the bGlobal flag in writeEntry(). force - true to force writing in kdeglobals See also forceGlobal |
NoGlobals | - | ||
OnlyLocal | - | ||
IncludeGlobals | - |