class KConfig |
|
\class KConfig kconfig.h The central class of the KDE configuration data system. Quickstart: Get the default application config object via KGlobal.config(). Load a specific configuration file: KConfig config( "/etc/kderc", KConfig.SimpleConfig ); Load the configuration of a specific component (taking into account possible custom dirs in KStandardDirs): KConfig config( componentData(), "pluginrc" ); In general it is recommended to use KSharedConfig instead of creating multiple instances of KConfig to avoid the overhead of separate objects or concerns about synchronizing writes to disk even if the configuration object is updated from multiple code paths. KSharedConfig provides a set of open methods as counterparts for the KConfig constructors. See also KSharedConfig, KConfigGroup, the techbase HOWTO on KConfig. |
|
|
|
Creates a KConfig oject using the specified backend. If the backend can not
be found or loaded, then the standard configuration parser is used as a fallback.
@arg file the file to be parsed @arg backend the backend to load @arg resourceType where to look for the file if an absolute path is not provided @since 4.1 |
|
|
|
|
|
configuration object state |
|
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. The files in the merge
stack will be read before the file passed to the constructor and any files that
cascade from that file. This means that the entries read from the files in the
merge stack will be treated as defaults. This function will automatically call
reparseConfiguration() for you.
@note: Most specific config file is relative to this list, the overall most specific file of this KConfig object is still the file it was created with, no matter which file is passed last into this function. This means that writing always goes to the file which was used to create the KConfig object. files - A list of extra config files. |
|
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 the same as config if it was set, otherwise a new KConfig object. In that case, do not forget to delete it! |
|
|
Returns a map (tree) of entries in a particular group. Only the actual entry as a string
is returned.
aGroup - The group to get entries from. Returns A map of entries in the group specified, indexed by key. The returned map may be empty if the group is empty, or not found. See also QMap |
|
Returns whether all entries are being written to kdeglobals.
Returns true if all entries are being written to kdeglobals
See also setForceGlobal Deprecated |
|
|
|
|
|
Return false if the user cannot write to this KConfig instance,
for instance because of permission problems.
warnUser - if true, show a message box telling the user to contact his system administrator for getting this problem fixed. |
|
|
immutability |
|
Returns the current locale. |
|
|
Returns the filename passed to the constructor. |
|
|
Clears all internal data structures and then reread configuration information from persistent storage. |
|
Forces all following write-operations to be performed on kdeglobals,
independent of the Global flag in writeEntry().
force - true to force writing to kdeglobals See also forceGlobal |
|
Sets the locale to aLocale. The global locale is used by default. If set to the empty string, no locale will be matched. This effectively disables reading translated entries. Returns true if locale was changed and configuration was reparsed. |
|
When set, all readEntry calls return the system-wide (default) values instead of the user's preference. This is off by default. |
|
|
Virtual hook, used to add new "virtual" functions while maintaining binary compatibility. Unused in this class. |
IncludeGlobals | - 0x01 | - | ||
CascadeConfig | - 0x02 | - | ||
SimpleConfig | - 0x00 | - | ||
NoCascade | - IncludeGlobals | - | ||
NoGlobals | - CascadeConfig | - | ||
FullConfig | - IncludeGlobals|CascadeConfig | - |