• Skip to content
  • Skip to link menu
KDE API Reference
  • KDE API Reference
  • kdelibs API Reference
  • KDE Home
  • Contact Us
 

KDECore

Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
KConfig Class Reference

#include <KConfig>

Inheritance diagram for KConfig:
Inheritance graph
[legend]

Public Types

enum  OpenFlag {
  IncludeGlobals = 0x01, CascadeConfig = 0x02, SimpleConfig = 0x00, NoCascade = IncludeGlobals,
  NoGlobals = CascadeConfig, FullConfig = IncludeGlobals|CascadeConfig
}
 
- Public Types inherited from KConfigBase
enum  AccessMode { NoAccess, ReadOnly, ReadWrite }
 
enum  WriteConfigFlag { Persistent = 0x01, Global = 0x02, Localized = 0x04, Normal =Persistent }
 

Public Member Functions

 KConfig (const QString &file=QString(), OpenFlags mode=FullConfig, const char *resourceType="config")
 
 KConfig (const KComponentData &componentData, const QString &file=QString(), OpenFlags mode=FullConfig, const char *resourceType="config")
 
 KConfig (const QString &file, const QString &backend, const char *resourceType="config")
 
virtual ~KConfig ()
 
void checkUpdate (const QString &id, const QString &updateFile)
 
const KComponentData & componentData () const
 
KConfig * copyTo (const QString &file, KConfig *config=0) const
 
QMap< QString, QString > entryMap (const QString &aGroup=QString()) const
 
QStringList groupList () const
 
bool isDirty () const
 
void markAsClean ()
 
QString name () const
 
void reparseConfiguration ()
 
void sync ()
 
AccessMode accessMode () const
 
bool isConfigWritable (bool warnUser)
 
void addConfigSources (const QStringList &sources)
 
QString locale () const
 
bool setLocale (const QString &aLocale)
 
void setReadDefaults (bool b)
 
bool readDefaults () const
 
bool isImmutable () const
 
void setForceGlobal (bool force)
 
bool forceGlobal () const
 
- Public Member Functions inherited from KConfigBase
virtual ~KConfigBase ()
 
void deleteGroup (const QByteArray &group, WriteConfigFlags flags=Normal)
 
void deleteGroup (const QString &group, WriteConfigFlags flags=Normal)
 
void deleteGroup (const char *group, WriteConfigFlags flags=Normal)
 
KConfigGroup group (const QByteArray &group)
 
KConfigGroup group (const QString &group)
 
KConfigGroup group (const char *group)
 
const KConfigGroup group (const QByteArray &group) const
 
const KConfigGroup group (const QString &group) const
 
const KConfigGroup group (const char *group) const
 
bool hasGroup (const QString &group) const
 
bool hasGroup (const char *group) const
 
bool hasGroup (const QByteArray &group) const
 
bool isGroupImmutable (const QByteArray &aGroup) const
 
bool isGroupImmutable (const QString &aGroup) const
 
bool isGroupImmutable (const char *aGroup) const
 

Protected Member Functions

 KConfig (KConfigPrivate &d)
 
virtual void deleteGroupImpl (const QByteArray &group, WriteConfigFlags flags=Normal)
 
virtual KConfigGroup groupImpl (const QByteArray &b)
 
virtual const KConfigGroup groupImpl (const QByteArray &b) const
 
virtual bool hasGroupImpl (const QByteArray &group) const
 
virtual bool isGroupImmutableImpl (const QByteArray &aGroup) const
 
virtual void virtual_hook (int id, void *data)
 
- Protected Member Functions inherited from KConfigBase
 KConfigBase ()
 

Protected Attributes

KConfigPrivate *const d_ptr
 

Detailed Description

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

Definition at line 70 of file kconfig.h.

Member Enumeration Documentation

enum KConfig::OpenFlag

Determines how the system-wide and user's global settings will affect the reading of the configuration.

If CascadeConfig is selected, system-wide configuration sources are used to provide defaults for the settings accessed through this object, or possibly to override those settings in certain cases.

IncludeGlobals does the same, but with the global settings sources.

Note that the main configuration source overrides the cascaded sources, which override those provided to addConfigSources(), which override the global sources. The exception is that if a key or group is marked as being immutable, it will not be overridden.

Note that all values other than IncludeGlobals and CascadeConfig are convenience definitions for the basic mode. Do not combine them with anything.

Enumerator
IncludeGlobals 

Blend kdeglobals into the config object.

CascadeConfig 

Cascade to system-wide config files.

SimpleConfig 

Just a single config file.

NoCascade 

Include user's globals, but omit system settings.

NoGlobals 

Cascade to system settings, but omit user's globals.

FullConfig 

Fully-fledged config, including globals and cascading to system settings.

Definition at line 92 of file kconfig.h.

Constructor & Destructor Documentation

KConfig::KConfig ( const QString &  file = QString(),
OpenFlags  mode = FullConfig,
const char *  resourceType = "config" 
)
explicit

Creates a KConfig object to manipulate a configuration file for the current application.

If an absolute path is specified for file, that file will be used as the store for the configuration settings. If a non-absolute path is provided, the file will be looked for in the standard directory specified by resourceType. If no path is provided, a default configuration file will be used based on the name of the main application component.

mode determines whether the user or global settings will be allowed to influence the values returned by this object. See OpenFlags for more details.

Note
You probably want to use KSharedConfig::openConfig instead.
Parameters
filethe name of the file. If an empty string is passed in and SimpleConfig is passed in for the OpenFlags, then an in-memory KConfig object is created which will not write out to file nor which requires any file in the filesystem at all.
modehow global settings should affect the configuration options exposed by this KConfig object
resourceTypeThe standard directory to look for the configuration file in (see KStandardDirs)
See also
KSharedConfig::openConfig(const QString&, OpenFlags, const char*)

Definition at line 211 of file kconfig.cpp.

KConfig::KConfig ( const KComponentData &  componentData,
const QString &  file = QString(),
OpenFlags  mode = FullConfig,
const char *  resourceType = "config" 
)
explicit

Creates a KConfig object to manipulate the configuration for a specific component.

If an absolute path is specified for file, that file will be used as the store for the configuration settings. If a non-absolute path is provided, the file will be looked for in the standard directory specified by resourceType. If no path is provided, a default configuration file will be used based on the component's name.

mode determines whether the user or global settings will be allowed to influence the values returned by this object. See KConfig::OpenFlags for more details.

Note
You probably want to use KSharedConfig::openConfig instead.
Parameters
componentDatathe component that you wish to load a configuration file for
fileoverrides the configuration file name if not empty; if it is empty and SimpleConfig is passed in for the OpenFlags, then an in-memory KConfig object is created which will not write out to file nor which requires any file in the filesystem at all.
modehow global settings should affect the configuration options exposed by this KConfig object. See OpenFlags
resourceTypeThe standard directory to look for the configuration file in
See also
KSharedConfig::openConfig(const KComponentData&, const QString&, OpenFlags, const char*)

Definition at line 221 of file kconfig.cpp.

KConfig::KConfig ( const QString &  file,
const QString &  backend,
const char *  resourceType = "config" 
)

Creates a KConfig object using the specified backend. If the backend can not be found or loaded, then the standard configuration parser is used as a fallback.

Parameters
filethe file to be parsed
backendthe backend to load
resourceTypewhere to look for the file if an absolute path is not provided
Since
4.1

Definition at line 231 of file kconfig.cpp.

KConfig::~KConfig ( )
virtual

Definition at line 247 of file kconfig.cpp.

KConfig::KConfig ( KConfigPrivate &  d)
protected

Definition at line 242 of file kconfig.cpp.

Member Function Documentation

KConfig::AccessMode KConfig::accessMode ( ) const
virtual

configuration object state

Reimplemented from superclass.

Implements KConfigBase.

Definition at line 672 of file kconfig.cpp.

void KConfig::addConfigSources ( const QStringList &  sources)

extra config files

Adds the list of configuration sources to the merge stack.

Currently only files are accepted as configuration sources.

The first entry in sources is treated as the most general and will be overridden by the second entry. The settings in the final entry in sources will override all the other sources provided in the list.

The settings in sources will also be overridden by the sources provided by any previous calls to addConfigSources().

The settings in the global configuration sources will be overridden by the sources provided to this method (

See also
IncludeGlobals). All the sources provided to any call to this method will be overridden by any files that cascade from the source provided to the constructor (
CascadeConfig), which will in turn be overridden by the source provided to the constructor (either explicitly or implicity via a KComponentData).

Note that only the most specific file, ie: the file provided to the constructor, will be written to by this object.

The state is automatically updated by this method, so there is no need to call reparseConfiguration().

Parameters
sourcesA list of extra config sources.

Definition at line 678 of file kconfig.cpp.

void KConfig::checkUpdate ( const QString &  id,
const QString &  updateFile 
)

Ensures that the configuration file contains a certain update.

If the configuration file does not contain the update id as contained in updateFile, kconf_update is run to update the configuration 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
idthe update to check
updateFilethe file containing the update

Definition at line 475 of file kconfig.cpp.

const KComponentData & KConfig::componentData ( ) const

Returns the component data this configuration is for.

Definition at line 255 of file kconfig.cpp.

KConfig * KConfig::copyTo ( const QString &  file,
KConfig *  config = 0 
) const

Copies all entries from this config object to a new config object that will save itself to file.

The configuration will not actually be saved to file until the returned object is destroyed, or sync() is called on it.

Do not forget to delete the returned KConfig object if config was 0.

Parameters
filethe new config object will save itself to
configif not 0, copy to the given KConfig object rather than creating a new one
Returns
config if it was set, otherwise a new KConfig object

Definition at line 486 of file kconfig.cpp.

void KConfig::deleteGroupImpl ( const QByteArray &  group,
WriteConfigFlags  flags = Normal 
)
protectedvirtual

Implements KConfigBase.

Definition at line 778 of file kconfig.cpp.

QMap< QString, QString > KConfig::entryMap ( const QString &  aGroup = QString()) const

Returns a map (tree) of entries in a particular group.

The entries are all returned as strings.

Parameters
aGroupThe 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

Definition at line 356 of file kconfig.cpp.

bool KConfig::forceGlobal ( ) const
Deprecated:

Returns whether all entries are being written to kdeglobals.

Returns
true if all entries are being written to kdeglobals
See also
setForceGlobal
Deprecated:

Definition at line 748 of file kconfig.cpp.

KConfigGroup KConfig::groupImpl ( const QByteArray &  b)
protectedvirtual

Implements KConfigBase.

Definition at line 755 of file kconfig.cpp.

const KConfigGroup KConfig::groupImpl ( const QByteArray &  b) const
protectedvirtual

Implements KConfigBase.

Definition at line 760 of file kconfig.cpp.

QStringList KConfig::groupList ( ) const
virtual
Reimplemented from superclass.

Implements KConfigBase.

Definition at line 261 of file kconfig.cpp.

bool KConfig::hasGroupImpl ( const QByteArray &  group) const
protectedvirtual

Implements KConfigBase.

Definition at line 822 of file kconfig.cpp.

bool KConfig::isConfigWritable ( bool  warnUser)

Whether the configuration can be written to.

If warnUser is true and the configuration cannot be written to (ie: this method returns false), a warning message box will be shown to the user telling them to contact their system administrator to get the problem fixed.

The most likely cause for this method returning false is that the user does not have write permission for the configuration file.

Parameters
warnUserwhether to show a warning message to the user if the configuration cannot be written to
Returns
true if the configuration can be written to, false if the configuration cannot be written to

Definition at line 796 of file kconfig.cpp.

bool KConfig::isDirty ( ) const

Returns true if sync has any changes to write out.

Since
4.12

Definition at line 469 of file kconfig.cpp.

bool KConfig::isGroupImmutableImpl ( const QByteArray &  aGroup) const
protectedvirtual

Implements KConfigBase.

Definition at line 733 of file kconfig.cpp.

bool KConfig::isImmutable ( ) const
virtual

immutability

Reimplemented from superclass.

Implements KConfigBase.

Definition at line 727 of file kconfig.cpp.

QString KConfig::locale ( ) const

locales

Returns the current locale.

Definition at line 690 of file kconfig.cpp.

void KConfig::markAsClean ( )
virtual
Reimplemented from superclass.

Implements KConfigBase.

Definition at line 458 of file kconfig.cpp.

QString KConfig::name ( ) const

Returns the filename used to store the configuration.

Definition at line 503 of file kconfig.cpp.

bool KConfig::readDefaults ( ) const
Returns
true if the system-wide defaults will be read instead of the user's settings

Definition at line 721 of file kconfig.cpp.

void KConfig::reparseConfiguration ( )

Updates the state of this object to match the persistent storage.

Definition at line 557 of file kconfig.cpp.

void KConfig::setForceGlobal ( bool  force)

global

Deprecated:

Forces all following write-operations to be performed on kdeglobals, independent of the Global flag in writeEntry().

Parameters
forcetrue to force writing to kdeglobals
See also
forceGlobal

Definition at line 740 of file kconfig.cpp.

bool KConfig::setLocale ( const QString &  aLocale)

Sets the locale to aLocale.

The global locale is used by default.

Note
If set to the empty string, no locale will be matched. This effectively disables reading translated entries.
Returns
true if locale was changed, false if the call had no effect (eg: aLocale was already the current locale for this object)

Definition at line 705 of file kconfig.cpp.

void KConfig::setReadDefaults ( bool  b)

defaults

When set, all readEntry calls return the system-wide (default) values instead of the user's settings.

This is off by default.

Parameters
bwhether to read the system-wide defaults instead of the user's settings

Definition at line 715 of file kconfig.cpp.

void KConfig::sync ( )
virtual
Reimplemented from superclass.

Implements KConfigBase.

Definition at line 388 of file kconfig.cpp.

void KConfig::virtual_hook ( int  id,
void *  data 
)
protectedvirtual

Virtual hook, used to add new "virtual" functions while maintaining binary compatibility.

Unused in this class.

Reimplemented from KConfigBase.

Definition at line 884 of file kconfig.cpp.

Member Data Documentation

KConfigPrivate* const KConfig::d_ptr
protected

Definition at line 403 of file kconfig.h.


The documentation for this class was generated from the following files:
  • kconfig.h
  • kconfig.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Mon Jun 22 2020 13:22:12 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

KDECore

Skip menu "KDECore"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • File Members
  • Modules
  • Related Pages

kdelibs API Reference

Skip menu "kdelibs API Reference"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDEWebKit
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • KPty
  • Kross
  • KUnitConversion
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver

Search



Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal