# kdecore Library API Documentation

Overview | Class Hierarchy | Classes | Classes (annotated) | Members | Namespaces | Source Files

# KConfigBase Class Reference

KDE Configuration Management abstract base class. More...

`#include <kconfigbase.h>`

Inheritance diagram for KConfigBase:

[legend]
Collaboration diagram for KConfigBase:

[legend]
List of all members.

## Public Types

enum | ConfigState { NoAccess, ReadOnly, ReadWrite }

## Public Member Functions

| KConfigBase ()
virtual | ~KConfigBase ()
void | setGroup (const QString &group)
void | setDesktopGroup ()
QString | group () const
bool | hasGroup (const QString &group) const
virtual QStringList | groupList () const =0
QString | locale () const
QString | readEntry (const QString &pKey, const QString &aDefault=QString::null) const
QString | readEntry (const char *pKey, const QString &aDefault=QString::null) const
QVariant | readPropertyEntry (const QString &pKey, QVariant::Type) const
QVariant | readPropertyEntry (const char *pKey, QVariant::Type) const
QVariant | readPropertyEntry (const QString &pKey, const QVariant &aDefault) const
QVariant | readPropertyEntry (const char *pKey, const QVariant &aDefault) const
int | readListEntry (const QString &pKey, QStrList &list, char sep= ',') const
int | readListEntry (const char *pKey, QStrList &list, char sep= ',') const
QStringList | readListEntry (const QString &pKey, char sep= ',') const
QStringList | readListEntry (const char *pKey, char sep= ',') const
QStringList | readListEntry (const char *pKey, const QStringList &aDefault, char sep= ',') const
QValueList< int > | readIntListEntry (const QString &pKey) const
QValueList< int > | readIntListEntry (const char *pKey) const
QString | readPathEntry (const QString &pKey, const QString &aDefault=QString::null) const
QString | readPathEntry (const char *pKey, const QString &aDefault=QString::null) const
QStringList | readPathListEntry (const QString &pKey, char sep= ',') const
QStringList | readPathListEntry (const char *pKey, char sep= ',') const
int | readNumEntry (const QString &pKey, int nDefault=0) const
int | readNumEntry (const char *pKey, int nDefault=0) const
unsigned int | readUnsignedNumEntry (const QString &pKey, unsigned int nDefault=0) const
unsigned int | readUnsignedNumEntry (const char *pKey, unsigned int nDefault=0) const
long | readLongNumEntry (const QString &pKey, long nDefault=0) const
long | readLongNumEntry (const char *pKey, long nDefault=0) const
unsigned long | readUnsignedLongNumEntry (const QString &pKey, unsigned long nDefault=0) const
unsigned long | readUnsignedLongNumEntry (const char *pKey, unsigned long nDefault=0) const
Q_INT64 | readNum64Entry (const QString &pKey, Q_INT64 nDefault=0) const
Q_INT64 | readNum64Entry (const char *pKey, Q_INT64 nDefault=0) const
Q_UINT64 | readUnsignedNum64Entry (const QString &pKey, Q_UINT64 nDefault=0) const
Q_UINT64 | readUnsignedNum64Entry (const char *pKey, Q_UINT64 nDefault=0) const
double | readDoubleNumEntry (const QString &pKey, double nDefault=0.0) const
double | readDoubleNumEntry (const char *pKey, double nDefault=0.0) const
QFont | readFontEntry (const QString &pKey, const QFont *pDefault=0L) const
QFont | readFontEntry (const char *pKey, const QFont *pDefault=0L) const
bool | readBoolEntry (const QString &pKey, bool bDefault=false) const
bool | readBoolEntry (const char *pKey, bool bDefault=false) const
QRect | readRectEntry (const QString &pKey, const QRect *pDefault=0L) const
QRect | readRectEntry (const char *pKey, const QRect *pDefault=0L) const
QPoint | readPointEntry (const QString &pKey, const QPoint *pDefault=0L) const
QPoint | readPointEntry (const char *pKey, const QPoint *pDefault=0L) const
QSize | readSizeEntry (const QString &pKey, const QSize *pDefault=0L) const
QSize | readSizeEntry (const char *pKey, const QSize *pDefault=0L) const
QColor | readColorEntry (const QString &pKey, const QColor *pDefault=0L) const
QColor | readColorEntry (const char *pKey, const QColor *pDefault=0L) const
QDateTime | readDateTimeEntry (const QString &pKey, const QDateTime *pDefault=0L) const
QDateTime | readDateTimeEntry (const char *pKey, const QDateTime *pDefault=0L) const
QString | readEntryUntranslated (const QString &pKey, const QString &aDefault=QString::null) const
QString | readEntryUntranslated (const char *pKey, const QString &aDefault=QString::null) const
void | writeEntry (const QString &pKey, const QString &pValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)
void | writeEntry (const char *pKey, const QString &pValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)
void | writeEntry (const QString &pKey, const QVariant &rValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)
void | writeEntry (const char *pKey, const QVariant &rValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)
void | writeEntry (const QString &pKey, const QStrList &rValue, char sep= ',', bool bPersistent=true, bool bGlobal=false, bool bNLS=false)
void | writeEntry (const char *pKey, const QStrList &rValue, char sep= ',', bool bPersistent=true, bool bGlobal=false, bool bNLS=false)
void | writeEntry (const QString &pKey, const QStringList &rValue, char sep= ',', bool bPersistent=true, bool bGlobal=false, bool bNLS=false)
void | writeEntry (const char *pKey, const QStringList &rValue, char sep= ',', bool bPersistent=true, bool bGlobal=false, bool bNLS=false)
void | writeEntry (const QString &pKey, const QValueList< int > &rValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)
void | writeEntry (const char *pKey, const QValueList< int > &rValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)
void | writeEntry (const QString &pKey, const char *pValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)
void | writeEntry (const char *pKey, const char *pValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)
void | writeEntry (const QString &pKey, int nValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)
void | writeEntry (const char *pKey, int nValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)
void | writeEntry (const QString &pKey, unsigned int nValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)
void | writeEntry (const char *pKey, unsigned int nValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)
void | writeEntry (const QString &pKey, long nValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)
void | writeEntry (const char *pKey, long nValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)
void | writeEntry (const QString &pKey, unsigned long nValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)
void | writeEntry (const char *pKey, unsigned long nValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)
void | writeEntry (const QString &pKey, Q_INT64 nValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)
void | writeEntry (const char *pKey, Q_INT64 nValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)
void | writeEntry (const QString &pKey, Q_UINT64 nValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)
void | writeEntry (const char *pKey, Q_UINT64 nValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)
void | writeEntry (const QString &pKey, double nValue, bool bPersistent=true, bool bGlobal=false, char format= 'g', int precision=6, bool bNLS=false)
void | writeEntry (const char *pKey, double nValue, bool bPersistent=true, bool bGlobal=false, char format= 'g', int precision=6, bool bNLS=false)
void | writeEntry (const QString &pKey, bool bValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)
void | writeEntry (const char *pKey, bool bValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)
void | writeEntry (const QString &pKey, const QFont &rFont, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)
void | writeEntry (const char *pKey, const QFont &rFont, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)
void | writeEntry (const QString &pKey, const QColor &rColor, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)
void | writeEntry (const char *pKey, const QColor &rColor, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)
void | writeEntry (const QString &pKey, const QDateTime &rDateTime, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)
void | writeEntry (const char *pKey, const QDateTime &rDateTime, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)
void | writeEntry (const QString &pKey, const QRect &rValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)
void | writeEntry (const char *pKey, const QRect &rValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)
void | writeEntry (const QString &pKey, const QPoint &rValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)
void | writeEntry (const char *pKey, const QPoint &rValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)
void | writeEntry (const QString &pKey, const QSize &rValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)
void | writeEntry (const char *pKey, const QSize &rValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)
void | writePathEntry (const QString &pKey, const QString &path, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)
void | writePathEntry (const char *pKey, const QString &path, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)
void | writePathEntry (const QString &pKey, const QStringList &rValue, char sep= ',', bool bPersistent=true, bool bGlobal=false, bool bNLS=false)
void | writePathEntry (const char *pKey, const QStringList &rValue, char sep= ',', bool bPersistent=true, bool bGlobal=false, bool bNLS=false)
void | deleteEntry (const QString &pKey, bool bNLS=false, bool bGlobal=false)
void | deleteEntry (const char *pKey, bool bNLS=false, bool bGlobal=false)
bool | deleteGroup (const QString &group, bool bDeep=true, bool bGlobal=false)
void | setDollarExpansion (bool _bExpand=true)
bool | isDollarExpansion () const
virtual void | rollback (bool bDeep=true)
virtual void | sync ()
bool | isDirty () const
virtual void | setReadOnly (bool _ro)
bool | isReadOnly () const
bool | hasKey (const QString &key) const
virtual QMap< QString, QString > | entryMap (const QString &group) const =0
virtual void | reparseConfiguration ()=0
bool | isImmutable () const
bool | groupIsImmutable (const QString &group) const
bool | entryIsImmutable (const QString &key) const
ConfigState | getConfigState () const
bool | checkConfigFilesWritable (bool warnUser)
void | setReadDefaults (bool b)
bool | readDefaults () const
void | revertToDefault (const QString &key)
bool | hasDefault (const QString &key) const
void | setGroup (const QCString &pGroup)
void | setGroup (const char *pGroup)
bool | hasGroup (const QCString &_pGroup) const
bool | hasGroup (const char *_pGroup) const
bool | hasKey (const char *pKey) const

## Protected Member Functions

void | setLocale ()
virtual void | setDirty (bool _bDirty=true)
virtual void | parseConfigFiles ()
virtual KEntryMap | internalEntryMap (const QString &pGroup) const =0
virtual KEntryMap | internalEntryMap () const =0
virtual void | putData (const KEntryKey &_key, const KEntry &_data, bool _checkGroup=true)=0
virtual KEntry | lookupData (const KEntryKey &_key) const =0
virtual bool | internalHasGroup (const QCString &group) const =0
QCString | readEntryUtf8 (const char *pKey) const
virtual void | virtual_hook (int id, void *data)

## Protected Attributes

KConfigBackEnd * | backEnd
QCString | mGroup
QCString | aLocaleString
bool | bDirty
bool | bLocaleInitialized
bool | bReadOnly
bool | bExpand

## Friends

class | KConfigBackEnd
class | KConfigINIBackEnd
class | KConfigGroup

## Detailed Description

KDE Configuration Management abstract base class.

This class forms the base for all KDE configuration. It is an abstract base class, meaning that you cannot directly instantiate objects of this class. Either use KConfig (for usual KDE configuration) or KSimpleConfig (for special needs as in ksamba), or even KSharedConfig (stores values in shared memory).

All configuration entries are key, value pairs. Each entry also belongs to a specific group of related entries. All configuration entries that do not explicitly specify which group they are in are in a special group called the default group.

If there is a $ character in an entry, KConfigBase tries to expand environment variable and uses its value instead of its name. You can avoid this feature by having two consecutive $ characters in your config file which get expanded to one.

Note:
  the '=' char is not allowed in keys and the ']' char is not allowed in a group name.

Author:
  Kalle Dalheimer <kalle@kde.org>, Preston Brown <pbrown@kde.org>

See also:
  KGlobal::config()

  KConfig

  KSimpleConfig

  KSharedConfig

Definition at line 70 of file kconfigbase.h.

## Member Enumeration Documentation

enum KConfigBase::ConfigState

Possible return values for getConfigState().

See also:
  getConfigState()

Definition at line 1804 of file kconfigbase.h.

## Constructor & Destructor Documentation

KConfigBase::KConfigBase | ( |  | ) |

| Construct a KConfigBase object. Definition at line 50 of file kconfigbase.cpp. References backEnd, bDirty, and setGroup().

KConfigBase::~KConfigBase | ( |  | ) | `[virtual]`

| Destructs the KConfigBase object. Definition at line 57 of file kconfigbase.cpp.

## Member Function Documentation

void KConfigBase::setGroup | ( | const QString & | group | ) |

Specifies the group in which keys will be read and written.

Subsequent calls to readEntry() and writeEntry() will be applied only in the activated group.

Switch back to the default group by passing a null string.

Parameters:

  | group | The name of the new group.

Definition at line 79 of file kconfigbase.cpp.

References group(), QString::isEmpty(), mGroup, and QString::utf8().

Referenced by KConfig::checkUpdate(), KNotifyClient::getDefaultFile(), KNotifyClient::getDefaultPresentation(), KNotifyClient::getFile(), KNotifyClient::getPresentation(), KIconEffect::init(), KApplication::invokeMailer(), KConfigBase(), KIconTheme::KIconTheme(), KLocale::languagesTwoAlpha(), and KDesktopFile::setActionGroup().

void KConfigBase::setDesktopGroup | ( |  | ) |

| Sets the group to the "Desktop Entry" group used for desktop configuration files for applications, mime types, etc. Definition at line 104 of file kconfigbase.cpp. References mGroup. Referenced by KDesktopFile::copyTo(), and KDesktopFile::KDesktopFile().

QString KConfigBase::group | ( |  | ) | const

Returns the name of the group in which we are searching for keys and from which we are retrieving entries.

Returns:
  The current group.

Definition at line 100 of file kconfigbase.cpp.

References QString::fromUtf8(), and mGroup.

Referenced by KConfig::checkUpdate(), deleteGroup(), groupIsImmutable(), hasGroup(), and setGroup().

bool KConfigBase::hasGroup | ( | const QString & | group | ) | const

Returns true if the specified group is known about.

Parameters:

  | group | The group to search for.

Returns:
  true if the group exists.

Definition at line 134 of file kconfigbase.cpp.

References group(), and QString::utf8().

Referenced by KDesktopFile::hasActionGroup().

virtual QStringList KConfigBase::groupList | ( |  | ) | const`[pure virtual]`

Returns a list of groups that are known about.

Returns:
  The list of groups.

Implemented in KConfig.

QString KConfigBase::locale | ( |  | ) | const

Returns a the current locale.

Returns:
  A string representing the current locale.

Definition at line 74 of file kconfigbase.cpp.

References aLocaleString, and QString::fromUtf8().

Referenced by hasDefault(), and revertToDefault().

QString KConfigBase::readEntry | ( | const QString & | pKey,
|  | const QString & | aDefault = `QString::null`
| ) | const

Reads the value of an entry specified by `pKey` in the current group.

If you want to read a path, please use readPathEntry().

Parameters:

  | pKey | The key to search for.
  | aDefault | A default value returned if the key was not found.

Returns:
  The value for this key. Can be QString::null if aDefault is null.

Definition at line 203 of file kconfigbase.cpp.

Referenced by KGlobalSettings::contextMenuKey(), KIconTheme::current(), KDesktopFile::hasApplicationType(), KDesktopFile::hasDeviceType(), KDesktopFile::hasLinkType(), KDesktopFile::hasMimeTypeType(), KIconEffect::init(), KApplication::invokeMailer(), KIconTheme::KIconTheme(), KGlobalSettings::mouseSettings(), readColorEntry(), KDesktopFile::readComment(), KDesktopFile::readDevice(), readFontEntry(), KDesktopFile::readGenericName(), KDesktopFile::readIcon(), readListEntry(), KDesktopFile::readName(), readNum64Entry(), readPathEntry(), readPropertyEntry(), KDesktopFile::readType(), readUnsignedNum64Entry(), and KDesktopFile::tryExec().

QString KConfigBase::readEntry | ( | const char * | pKey,
|  | const QString & | aDefault = `QString::null`
| ) | const

Reads the value of an entry specified by `pKey` in the current group.

Parameters:

  | pKey | The key to search for.
  | aDefault | A default value returned if the key was not found.

Returns:
  The value for this key. Can be QString::null if aDefault is null.

Definition at line 209 of file kconfigbase.cpp.

References QString::ascii(), KEntryKey::bDefault, KEntry::bExpand, KEntryKey::bLocal, KEntryKey::c_key, QString::find(), KStringHandler::from8Bit(), QString::fromUtf8(), QString::isEmpty(), QString::isNull(), QCString::isNull(), QString::length(), lookupData(), mGroup, QString::mid(), KEntry::mValue, QTextStream::read(), readDefaults(), QString::remove(), QString::replace(), setLocale(), and KGlobal::staticQString().

QVariant KConfigBase::readPropertyEntry | ( | const QString & | pKey,
|  | QVariant::Type |
| ) | const

Reads the value of an entry specified by `pKey` in the current group.

The value is treated as if it is of the given type.

Note that only the following QVariant types are allowed : String, StringList, List, Font, Point, Rect, Size, Color, Int, UInt, Bool, Double, DateTime and Date.

Deprecated:

Parameters:

  | pKey | The key to search for.

Returns:
  An invalid QVariant if the key was not found or if the read value cannot be converted to the given QVariant::Type.

Definition at line 333 of file kconfigbase.cpp.

Referenced by readPropertyEntry().

QVariant KConfigBase::readPropertyEntry | ( | const char * | pKey,
|  | QVariant::Type |
| ) | const

Reads the value of an entry specified by `pKey` in the current group.

The value is treated as if it is of the given type.

Note that only the following QVariant types are allowed : String, StringList, List, Font, Point, Rect, Size, Color, Int, UInt, Bool, Double, DateTime and Date.

Deprecated:

Parameters:

  | pKey | The key to search for.

Returns:
  An invalid QVariant if the key was not found or if the read value cannot be converted to the given QVariant::Type.

Definition at line 339 of file kconfigbase.cpp.

References QVariant::cast(), hasKey(), and readPropertyEntry().

QVariant KConfigBase::readPropertyEntry | ( | const QString & | pKey,
|  | const QVariant & | aDefault
| ) | const

Reads the value of an entry specified by `pKey` in the current group.

The value is treated as if it is of the type of the given default value.

Note that only the following QVariant types are allowed : String, StringList, List, Font, Point, Rect, Size, Color, Int, UInt, Bool, Double, DateTime and Date.

Parameters:

  | pKey | The key to search for.
  | aDefault | A default value returned if the key was not found or if the read value cannot be converted to the QVariant::Type.

Returns:
  The value for the key or the default value if the key was not found.

Definition at line 348 of file kconfigbase.cpp.

References readPropertyEntry().

QVariant KConfigBase::readPropertyEntry | ( | const char * | pKey,
|  | const QVariant & | aDefault
| ) | const

Reads the value of an entry specified by `pKey` in the current group.

The value is treated as if it is of the type of the given default value.

Note that only the following QVariant types are allowed : String, StringList, List, Font, Point, Rect, Size, Color, Int, UInt, Bool, Double, DateTime and Date.

Parameters:

  | pKey | The key to search for.
  | aDefault | A default value returned if the key was not found or if the read value cannot be converted to the QVariant::Type.

Returns:
  The value for the key or the default value if the key was not found.

Definition at line 354 of file kconfigbase.cpp.

References QValueList::append(), QVariant::asColor(), QVariant::asDateTime(), QVariant::asFont(), QVariant::asPoint(), QVariant::asRect(), QVariant::asSize(), QDateTime::date(), hasKey(), readBoolEntry(), readColorEntry(), readDateTimeEntry(), readDoubleNumEntry(), readEntry(), readFontEntry(), readListEntry(), readNum64Entry(), readNumEntry(), readPointEntry(), readRectEntry(), readSizeEntry(), readUnsignedNum64Entry(), and readUnsignedNumEntry().

int KConfigBase::readListEntry | ( | const QString & | pKey,
|  | QStrList & | list,
|  | char | sep = `','`
| ) | const

Reads a list of strings.

Deprecated:

Parameters:

  | pKey | The key to search for
  | list | In this object, the read list will be returned.
  | sep | The list separator (default ",")

Returns:
  The number of entries in the list.

Definition at line 433 of file kconfigbase.cpp.

Referenced by KConfig::checkUpdate(), KIconTheme::KIconTheme(), KLocale::languagesTwoAlpha(), KDesktopFile::readActions(), readDateTimeEntry(), readIntListEntry(), readListEntry(), readPathListEntry(), readPropertyEntry(), KDesktopFile::sortOrder(), and KDesktopFile::tryExec().

int KConfigBase::readListEntry | ( | const char * | pKey,
|  | QStrList & | list,
|  | char | sep = `','`
| ) | const

Reads a list of strings.

Deprecated:

Parameters:

  | pKey | The key to search for
  | list | In this object, the read list will be returned.
  | sep | The list separator (default ",")

Returns:
  The number of entries in the list.

Definition at line 439 of file kconfigbase.cpp.

References QCString::append(), hasKey(), QCString::isEmpty(), QCString::length(), and QCString::truncate().

QStringList KConfigBase::readListEntry | ( | const QString & | pKey,
|  | char | sep = `','`
| ) | const

Reads a list of strings.

Parameters:

  | pKey | The key to search for.
  | sep | The list separator (default is ",").

Returns:
  The list. Empty if the entry does not exist.

Definition at line 478 of file kconfigbase.cpp.

References readListEntry().

QStringList KConfigBase::readListEntry | ( | const char * | pKey,
|  | char | sep = `','`
| ) | const

Reads a list of strings.

Parameters:

  | pKey | The key to search for.
  | sep | The list separator (default is ",").

Returns:
  The list. Empty if the entry does not exist.

Definition at line 483 of file kconfigbase.cpp.

References hasKey(), QString::isEmpty(), QString::length(), readEntry(), QString::reserve(), QString::squeeze(), KGlobal::staticQString(), and QString::truncate().

QStringList KConfigBase::readListEntry | ( | const char * | pKey,
|  | const QStringList & | aDefault,
|  | char | sep = `','`
| ) | const

Reads a list of strings, but returns a default if the key did not exist.

Parameters:

  | pKey | The key to search for.
  | aDefault | The default value to use if the key does not exist.
  | sep | The list separator (default is ",").

Returns:
  The list. Contains `aDefault` if the Key does not exist.

Since:
  3.3

Definition at line 524 of file kconfigbase.cpp.

References hasKey(), and readListEntry().

QValueList< int > KConfigBase::readIntListEntry | ( | const QString & | pKey | ) | const

Reads a list of Integers.

Parameters:

  | pKey | The key to search for.

Returns:
  The list. Empty if the entry does not exist.

Definition at line 533 of file kconfigbase.cpp.

Referenced by KIconTheme::KIconTheme().

QValueList< int > KConfigBase::readIntListEntry | ( | const char * | pKey | ) | const

Reads a list of Integers.

Parameters:

  | pKey | The key to search for.

Returns:
  The list. Empty if the entry does not exist.

Definition at line 538 of file kconfigbase.cpp.

References readListEntry().

QString KConfigBase::readPathEntry | ( | const QString & | pKey,
|  | const QString & | aDefault = `QString::null`
| ) | const

Reads a path.

Read the value of an entry specified by `pKey` in the current group and interpret it as a path. This means, dollar expansion is activated for this value, so that e.g. $HOME gets expanded.

Parameters:

  | pKey | The key to search for.
  | aDefault | A default value returned if the key was not found.

Returns:
  The value for this key. Can be QString::null if aDefault is null.

Definition at line 550 of file kconfigbase.cpp.

Referenced by KCharsets::codecForName(), KNotifyClient::getDefaultFile(), KNotifyClient::getFile(), KApplication::invokeMailer(), KIconTheme::KIconTheme(), KDesktopFile::readDocPath(), KDesktopFile::readPath(), KDesktopFile::readURL(), and KDesktopFile::tryExec().

QString KConfigBase::readPathEntry | ( | const char * | pKey,
|  | const QString & | aDefault = `QString::null`
| ) | const

Reads a path.

Read the value of an entry specified by `pKey` in the current group and interpret it as a path. This means, dollar expansion is activated for this value, so that e.g. $HOME gets expanded.

Parameters:

  | pKey | The key to search for.
  | aDefault | A default value returned if the key was not found.

Returns:
  The value for this key. Can be QString::null if aDefault is null.

Definition at line 555 of file kconfigbase.cpp.

References readEntry().

QStringList KConfigBase::readPathListEntry | ( | const QString & | pKey,
|  | char | sep = `','`
| ) | const

Reads a list of string paths.

Read the value of an entry specified by `pKey` in the current group and interpret it as a list of paths. This means, dollar expansion is activated for this value, so that e.g. $HOME gets expanded.

Parameters:

  | pKey | The key to search for.
  | sep | The list separator (default is ",").

Returns:
  The list. Empty if the entry does not exist.

Since:
  3.1.3

Definition at line 564 of file kconfigbase.cpp.

Referenced by KIconTheme::KIconTheme().

QStringList KConfigBase::readPathListEntry | ( | const char * | pKey,
|  | char | sep = `','`
| ) | const

Reads a list of string paths.

Read the value of an entry specified by `pKey` in the current group and interpret it as a list of paths. This means, dollar expansion is activated for this value, so that e.g. $HOME gets expanded.

Parameters:

  | pKey | The key to search for.
  | sep | The list separator (default is ",").

Returns:
  The list. Empty if the entry does not exist.

Since:
  3.1.3

Definition at line 569 of file kconfigbase.cpp.

References readListEntry().

int KConfigBase::readNumEntry | ( | const QString & | pKey,
|  | int | nDefault = `0`
| ) | const

Reads a numerical value.

Read the value of an entry specified by `pKey` in the current group and interpret it numerically.

Parameters:

  | pKey | The key to search for.
  | nDefault | A default value returned if the key was not found or if the read value cannot be interpreted.

Returns:
  The value for this key.

Definition at line 578 of file kconfigbase.cpp.

Referenced by KGlobalSettings::autoSelectDelay(), KGlobalSettings::buttonLayout(), KGlobalSettings::completionMode(), KGlobalSettings::contrast(), KGlobalSettings::dndEventDelay(), KNotifyClient::getDefaultPresentation(), KNotifyClient::getPresentation(), KGlobalSettings::insertTearOffHandle(), KIconTheme::KIconTheme(), readPropertyEntry(), KGlobalSettings::splashScreenDesktopGeometry(), and KGlobalSettings::visualActivateSpeed().

int KConfigBase::readNumEntry | ( | const char * | pKey,
|  | int | nDefault = `0`
| ) | const

Reads a numerical value.

Read the value of an entry specified by `pKey` in the current group and interpret it numerically.

Parameters:

  | pKey | The key to search for.
  | nDefault | A default value returned if the key was not found or if the read value cannot be interpreted.

Returns:
  The value for this key.

Definition at line 583 of file kconfigbase.cpp.

References QCString::isNull(), and QCString::toInt().

unsigned int KConfigBase::readUnsignedNumEntry | ( | const QString & | pKey,
|  | unsigned int | nDefault = `0`
| ) | const

Reads an unsigned numerical value.

Read the value of an entry specified by `pKey` in the current group and interpret it numerically.

Parameters:

  | pKey | The key to search for.
  | nDefault | A default value returned if the key was not found or if the read value cannot be interpreted.

Returns:
  The value for this key.

Definition at line 599 of file kconfigbase.cpp.

Referenced by readPropertyEntry().

unsigned int KConfigBase::readUnsignedNumEntry | ( | const char * | pKey,
|  | unsigned int | nDefault = `0`
| ) | const

Reads an unsigned numerical value.

Read the value of an entry specified by `pKey` in the current group and interpret it numerically.

Parameters:

  | pKey | The key to search for.
  | nDefault | A default value returned if the key was not found or if the read value cannot be interpreted.

Returns:
  The value for this key.

Definition at line 604 of file kconfigbase.cpp.

References QCString::isNull(), and QCString::toUInt().

long KConfigBase::readLongNumEntry | ( | const QString & | pKey,
|  | long | nDefault = `0`
| ) | const

Reads a numerical value.

Read the value of an entry specified by `pKey` in the current group and interpret it numerically.

Parameters:

  | pKey | The key to search for.
  | nDefault | A default value returned if the key was not found or if the read value cannot be interpreted.

Returns:
  The value for this key.

Definition at line 618 of file kconfigbase.cpp.

long KConfigBase::readLongNumEntry | ( | const char * | pKey,
|  | long | nDefault = `0`
| ) | const

Reads a numerical value.

Read the value of an entry specified by `pKey` in the current group and interpret it numerically.

Parameters:

  | pKey | The key to search for.
  | nDefault | A default value returned if the key was not found or if the read value cannot be interpreted.

Returns:
  The value for this key.

Definition at line 623 of file kconfigbase.cpp.

References QCString::isNull(), and QCString::toLong().

unsigned long KConfigBase::readUnsignedLongNumEntry | ( | const QString & | pKey,
|  | unsigned long | nDefault = `0`
| ) | const

Read an unsigned numerical value.

Read the value of an entry specified by `pKey` in the current group and interpret it numerically.

Parameters:

  | pKey | The key to search for.
  | nDefault | A default value returned if the key was not found or if the read value cannot be interpreted.

Returns:
  The value for this key.

Definition at line 637 of file kconfigbase.cpp.

unsigned long KConfigBase::readUnsignedLongNumEntry | ( | const char * | pKey,
|  | unsigned long | nDefault = `0`
| ) | const

Read an unsigned numerical value.

Read the value of an entry specified by `pKey` in the current group and interpret it numerically.

Parameters:

  | pKey | The key to search for.
  | nDefault | A default value returned if the key was not found or if the read value cannot be interpreted.

Returns:
  The value for this key.

Definition at line 642 of file kconfigbase.cpp.

References QCString::isNull(), and QCString::toULong().

Q_INT64 KConfigBase::readNum64Entry | ( | const QString & | pKey,
|  | Q_INT64 | nDefault = `0`
| ) | const

Reads a 64-bit numerical value.

Read the value of an entry specified by `pKey` in the current group and interpret it numerically.

Parameters:

  | pKey | The key to search for.
  | nDefault | A default value returned if the key was not found or if the read value cannot be interpreted.

Returns:
  The value for this key.

Definition at line 655 of file kconfigbase.cpp.

Referenced by readPropertyEntry().

Q_INT64 KConfigBase::readNum64Entry | ( | const char * | pKey,
|  | Q_INT64 | nDefault = `0`
| ) | const

Reads a 64-bit numerical value.

Read the value of an entry specified by `pKey` in the current group and interpret it numerically.

Parameters:

  | pKey | The key to search for.
  | nDefault | A default value returned if the key was not found or if the read value cannot be interpreted.

Returns:
  The value for this key.

Definition at line 660 of file kconfigbase.cpp.

References QString::isNull(), readEntry(), and QString::toLongLong().

Q_UINT64 KConfigBase::readUnsignedNum64Entry | ( | const QString & | pKey,
|  | Q_UINT64 | nDefault = `0`
| ) | const

Read an 64-bit unsigned numerical value.

Read the value of an entry specified by `pKey` in the current group and interpret it numerically.

Parameters:

  | pKey | The key to search for.
  | nDefault | A default value returned if the key was not found or if the read value cannot be interpreted.

Returns:
  The value for this key.

Definition at line 675 of file kconfigbase.cpp.

Referenced by readPropertyEntry().

Q_UINT64 KConfigBase::readUnsignedNum64Entry | ( | const char * | pKey,
|  | Q_UINT64 | nDefault = `0`
| ) | const

Read an 64-bit unsigned numerical value.

Read the value of an entry specified by `pKey` in the current group and interpret it numerically.

Parameters:

  | pKey | The key to search for.
  | nDefault | A default value returned if the key was not found or if the read value cannot be interpreted.

Returns:
  The value for this key.

Definition at line 680 of file kconfigbase.cpp.

References QString::isNull(), readEntry(), and QString::toULongLong().

double KConfigBase::readDoubleNumEntry | ( | const QString & | pKey,
|  | double | nDefault = `0.0`
| ) | const

Reads a floating point value.

Read the value of an entry specified by `pKey` in the current group and interpret it numerically.

Parameters:

  | pKey | The key to search for.
  | nDefault | A default value returned if the key was not found or if the read value cannot be interpreted.

Returns:
  The value for this key.

Definition at line 694 of file kconfigbase.cpp.

Referenced by KIconEffect::init(), and readPropertyEntry().

double KConfigBase::readDoubleNumEntry | ( | const char * | pKey,
|  | double | nDefault = `0.0`
| ) | const

Reads a floating point value.

Read the value of an entry specified by `pKey` in the current group and interpret it numerically.

Parameters:

  | pKey | The key to search for.
  | nDefault | A default value returned if the key was not found or if the read value cannot be interpreted.

Returns:
  The value for this key.

Definition at line 699 of file kconfigbase.cpp.

References QCString::isNull(), and QCString::toDouble().

QFont KConfigBase::readFontEntry | ( | const QString & | pKey,
|  | const QFont * | pDefault = `0L`
| ) | const

Reads a QFont value.

Read the value of an entry specified by `pKey` in the current group and interpret it as a font object.

Parameters:

  | pKey | The key to search for.
  | pDefault | A default value (null QFont by default) returned if the key was not found or if the read value cannot be interpreted.

Returns:
  The value for this key.

Definition at line 740 of file kconfigbase.cpp.

Referenced by KGlobalSettings::fixedFont(), KGlobalSettings::generalFont(), KGlobalSettings::menuFont(), readPropertyEntry(), KGlobalSettings::taskbarFont(), KGlobalSettings::toolBarFont(), and KGlobalSettings::windowTitleFont().

QFont KConfigBase::readFontEntry | ( | const char * | pKey,
|  | const QFont * | pDefault = `0L`
| ) | const

Reads a QFont value.

Read the value of an entry specified by `pKey` in the current group and interpret it as a font object.

Parameters:

  | pKey | The key to search for.
  | pDefault | A default value (null QFont by default) returned if the key was not found or if the read value cannot be interpreted.

Returns:
  The value for this key.

Definition at line 745 of file kconfigbase.cpp.

References QString::contains(), QString::find(), QFont::fromString(), QString::isNull(), QString::left(), QString::length(), QString::mid(), readEntry(), QString::right(), QFont::setFamily(), QFont::setFixedPitch(), QFont::setItalic(), QFont::setPointSize(), QFont::setRawMode(), QFont::setStrikeOut(), QFont::setStyleHint(), QFont::setUnderline(), QFont::setWeight(), QString::toInt(), and QString::toUInt().

bool KConfigBase::readBoolEntry | ( | const QString & | pKey,
|  | bool | bDefault = `false`
| ) | const

Reads a boolean entry.

Read the value of an entry specified by `pKey` in the current group and interpret it as a boolean value. Currently "on" and "true" are accepted as true, everything else if false.

Parameters:

  | pKey | The key to search for
  | bDefault | A default value returned if the key was not found.

Returns:
  The value for this key.

Definition at line 713 of file kconfigbase.cpp.

Referenced by KApplication::authorize(), KApplication::authorizeControlModule(), KApplication::authorizeControlModules(), KGlobalSettings::changeCursorOverIcon(), KGlobalSettings::desktopGeometry(), KIconEffect::init(), KGlobalSettings::insertTearOffHandle(), KNotifyClient::Instance::Instance(), KApplication::invokeMailer(), KIconTheme::KIconTheme(), KGlobalSettings::opaqueResize(), readPropertyEntry(), KGlobalSettings::shadeSortColumn(), KGlobalSettings::showContextMenusOnPress(), KGlobalSettings::showFilePreview(), KGlobalSettings::showIconsOnPushButtons(), KGlobalSettings::singleClick(), KGlobalSettings::splashScreenDesktopGeometry(), KDesktopFile::tryExec(), KGlobalSettings::visualActivate(), and KGlobalSettings::wheelMouseZooms().

bool KConfigBase::readBoolEntry | ( | const char * | pKey,
|  | bool | bDefault = `false`
| ) | const

Reads a boolean entry.

Read the value of an entry specified by `pKey` in the current group and interpret it as a boolean value. Currently "on" and "true" are accepted as true, everything else if false.

Parameters:

  | pKey | The key to search for
  | bDefault | A default value returned if the key was not found.

Returns:
  The value for this key.

Definition at line 718 of file kconfigbase.cpp.

References QCString::isNull(), and QCString::toInt().

QRect KConfigBase::readRectEntry | ( | const QString & | pKey,
|  | const QRect * | pDefault = `0L`
| ) | const

Reads a QRect entry.

Read the value of an entry specified by pKey in the current group and interpret it as a QRect object.

Parameters:

  | pKey | The key to search for
  | pDefault | A default value (null QRect by default) returned if the key was not found or if the read value cannot be interpreted.

Returns:
  The value for this key.

Definition at line 837 of file kconfigbase.cpp.

Referenced by readPropertyEntry().

QRect KConfigBase::readRectEntry | ( | const char * | pKey,
|  | const QRect * | pDefault = `0L`
| ) | const

Reads a QRect entry.

Read the value of an entry specified by pKey in the current group and interpret it as a QRect object.

Parameters:

  | pKey | The key to search for
  | pDefault | A default value (null QRect by default) returned if the key was not found or if the read value cannot be interpreted.

Returns:
  The value for this key.

Definition at line 842 of file kconfigbase.cpp.

References QCString::isEmpty().

QPoint KConfigBase::readPointEntry | ( | const QString & | pKey,
|  | const QPoint * | pDefault = `0L`
| ) | const

Reads a QPoint entry.

Read the value of an entry specified by `pKey` in the current group and interpret it as a QPoint object.

Parameters:

  | pKey | The key to search for
  | pDefault | A default value (null QPoint by default) returned if the key was not found or if the read value cannot be interpreted.

Returns:
  The value for this key.

Definition at line 861 of file kconfigbase.cpp.

Referenced by readPropertyEntry().

QPoint KConfigBase::readPointEntry | ( | const char * | pKey,
|  | const QPoint * | pDefault = `0L`
| ) | const

Reads a QPoint entry.

Read the value of an entry specified by `pKey` in the current group and interpret it as a QPoint object.

Parameters:

  | pKey | The key to search for
  | pDefault | A default value (null QPoint by default) returned if the key was not found or if the read value cannot be interpreted.

Returns:
  The value for this key.

Definition at line 867 of file kconfigbase.cpp.

References QCString::isEmpty().

QSize KConfigBase::readSizeEntry | ( | const QString & | pKey,
|  | const QSize * | pDefault = `0L`
| ) | const

Reads a QSize entry.

Read the value of an entry specified by `pKey` in the current group and interpret it as a QSize object.

Parameters:

  | pKey | The key to search for
  | pDefault | A default value (null QSize by default) returned if the key was not found or if the read value cannot be interpreted.

Returns:
  The value for this key.

Definition at line 886 of file kconfigbase.cpp.

Referenced by readPropertyEntry().

QSize KConfigBase::readSizeEntry | ( | const char * | pKey,
|  | const QSize * | pDefault = `0L`
| ) | const

Reads a QSize entry.

Read the value of an entry specified by `pKey` in the current group and interpret it as a QSize object.

Parameters:

  | pKey | The key to search for
  | pDefault | A default value (null QSize by default) returned if the key was not found or if the read value cannot be interpreted.

Returns:
  The value for this key.

Definition at line 892 of file kconfigbase.cpp.

References QCString::isEmpty().

QColor KConfigBase::readColorEntry | ( | const QString & | pKey,
|  | const QColor * | pDefault = `0L`
| ) | const

Reads a QColor entry.

Read the value of an entry specified by `pKey` in the current group and interpret it as a color.

Parameters:

  | pKey | The key to search for.
  | pDefault | A default value (null QColor by default) returned if the key was not found or if the value cannot be interpreted.

Returns:
  The value for this key.

Definition at line 912 of file kconfigbase.cpp.

Referenced by KGlobalSettings::activeTextColor(), KGlobalSettings::activeTitleColor(), KGlobalSettings::alternateBackgroundColor(), KGlobalSettings::baseColor(), KGlobalSettings::buttonBackground(), KGlobalSettings::buttonTextColor(), KGlobalSettings::highlightColor(), KGlobalSettings::highlightedTextColor(), KGlobalSettings::inactiveTextColor(), KGlobalSettings::inactiveTitleColor(), KIconEffect::init(), KGlobalSettings::linkColor(), readPropertyEntry(), KGlobalSettings::textColor(), KGlobalSettings::toolBarHighlightColor(), and KGlobalSettings::visitedLinkColor().

QColor KConfigBase::readColorEntry | ( | const char * | pKey,
|  | const QColor * | pDefault = `0L`
| ) | const

Reads a QColor entry.

Read the value of an entry specified by `pKey` in the current group and interpret it as a color.

Parameters:

  | pKey | The key to search for.
  | pDefault | A default value (null QColor by default) returned if the key was not found or if the value cannot be interpreted.

Returns:
  The value for this key.

Definition at line 918 of file kconfigbase.cpp.

References QString::at(), QString::find(), QString::isEmpty(), QString::left(), QString::length(), QString::mid(), readEntry(), QString::right(), QColor::setNamedColor(), QColor::setRgb(), and QString::toInt().

QDateTime KConfigBase::readDateTimeEntry | ( | const QString & | pKey,
|  | const QDateTime * | pDefault = `0L`
| ) | const

Reads a QDateTime entry.

Read the value of an entry specified by `pKey` in the current group and interpret it as a date and time.

Parameters:

  | pKey | The key to search for.
  | pDefault | A default value ( currentDateTime() by default) returned if the key was not found or if the read value cannot be interpreted.

Returns:
  The value for this key.

Definition at line 977 of file kconfigbase.cpp.

Referenced by readPropertyEntry().

QDateTime KConfigBase::readDateTimeEntry | ( | const char * | pKey,
|  | const QDateTime * | pDefault = `0L`
| ) | const

Reads a QDateTime entry.

Read the value of an entry specified by `pKey` in the current group and interpret it as a date and time.

Parameters:

  | pKey | The key to search for.
  | pDefault | A default value ( currentDateTime() by default) returned if the key was not found or if the read value cannot be interpreted.

Returns:
  The value for this key.

Definition at line 984 of file kconfigbase.cpp.

References QDateTime::currentDateTime(), hasKey(), and readListEntry().

QString KConfigBase::readEntryUntranslated | ( | const QString & | pKey,
|  | const QString & | aDefault = `QString::null`
| ) | const

Reads the value of an entry specified by `pKey` in the current group.

The untranslated entry is returned, you normally do not need this.

Parameters:

  | pKey | The key to search for.
  | aDefault | A default value returned if the key was not found.

Returns:
  The value for this key.

Definition at line 186 of file kconfigbase.cpp.

QString KConfigBase::readEntryUntranslated | ( | const char * | pKey,
|  | const QString & | aDefault = `QString::null`
| ) | const

Reads the value of an entry specified by `pKey` in the current group.

The untranslated entry is returned, you normally do not need this.

Parameters:

  | pKey | The key to search for.
  | aDefault | A default value returned if the key was not found.

Returns:
  The value for this key.

Definition at line 193 of file kconfigbase.cpp.

References QString::fromUtf8(), and QCString::isNull().

void KConfigBase::writeEntry | ( | const QString & | pKey,
|  | const QString & | pValue,
|  | bool | bPersistent = `true`,
|  | bool | bGlobal = `false`,
|  | bool | bNLS = `false`
| ) |

Writes a key/value pair.

This is stored in the most specific config file when destroying the config object or when calling sync().

If you want to write a path, please use writePathEntry().

Parameters:

  | pKey | The key to write.
  | pValue | The value to write.
  | bPersistent | If `bPersistent` is false, the entry's dirty flag will not be set and thus the entry will not be written to disk at deletion time.
  | bGlobal | If `bGlobal` is true, the pair is not saved to the application specific config file, but to the global KDE config file.
  | bNLS | If `bNLS` is true, the locale tag is added to the key when writing it back.

Definition at line 1009 of file kconfigbase.cpp.

Referenced by writeEntry(), and writePathEntry().

void KConfigBase::writeEntry | ( | const char * | pKey,
|  | const QString & | pValue,
|  | bool | bPersistent = `true`,
|  | bool | bGlobal = `false`,
|  | bool | bNLS = `false`
| ) |

Writes a key/value pair.

This is stored in the most specific config file when destroying the config object or when calling sync().

Parameters:

  | pKey | The key to write.
  | pValue | The value to write.
  | bPersistent | If `bPersistent` is false, the entry's dirty flag will not be set and thus the entry will not be written to disk at deletion time.
  | bGlobal | If `bGlobal` is true, the pair is not saved to the application specific config file, but to the global KDE config file.
  | bNLS | If `bNLS` is true, the locale tag is added to the key when writing it back.

Definition at line 1017 of file kconfigbase.cpp.

References KEntry::bDirty, KEntry::bGlobal, KEntryKey::bLocal, KEntry::bNLS, mGroup, KEntry::mValue, putData(), setDirty(), and setLocale().

void KConfigBase::writeEntry | ( | const QString & | pKey,
|  | const QVariant & | rValue,
|  | bool | bPersistent = `true`,
|  | bool | bGlobal = `false`,
|  | bool | bNLS = `false`
| ) |

writeEntry() Overridden to accept a property.

Note: Unlike the other writeEntry() functions, the old value is _not_ returned here!

Parameters:

  | pKey | The key to write
  | rValue | The property to write
  | bPersistent | If `bPersistent` is false, the entry's dirty flag will not be set and thus the entry will not be written to disk at deletion time.
  | bGlobal | If `bGlobal` is true, the pair is not saved to the application specific config file, but to the global KDE config file.
  | bNLS | If `bNLS` is true, the locale tag is added to the key when writing it back.

See also:
  writeEntry()

Definition at line 1214 of file kconfigbase.cpp.

References writeEntry().

void KConfigBase::writeEntry | ( | const char * | pKey,
|  | const QVariant & | rValue,
|  | bool | bPersistent = `true`,
|  | bool | bGlobal = `false`,
|  | bool | bNLS = `false`
| ) |

writeEntry() Overridden to accept a property.

Note: Unlike the other writeEntry() functions, the old value is _not_ returned here!

Parameters:

  | pKey | The key to write
  | rValue | The property to write
  | bPersistent | If `bPersistent` is false, the entry's dirty flag will not be set and thus the entry will not be written to disk at deletion time.
  | bGlobal | If `bGlobal` is true, the pair is not saved to the application specific config file, but to the global KDE config file.
  | bNLS | If `bNLS` is true, the locale tag is added to the key when writing it back.

See also:
  writeEntry()

Definition at line 1221 of file kconfigbase.cpp.

References QValueList::begin(), QValueList::end(), and writeEntry().

void KConfigBase::writeEntry | ( | const QString & | pKey,
|  | const QStrList & | rValue,
|  | char | sep = `','`,
|  | bool | bPersistent = `true`,
|  | bool | bGlobal = `false`,
|  | bool | bNLS = `false`
| ) |

writeEntry() overridden to accept a list of strings.

Note: Unlike the other writeEntry() functions, the old value is _not_ returned here!

Parameters:

  | pKey | The key to write
  | rValue | The list to write
  | sep | The list separator (default is ",").
  | bPersistent | If `bPersistent` is false, the entry's dirty flag will not be set and thus the entry will not be written to disk at deletion time.
  | bGlobal | If `bGlobal` is true, the pair is not saved to the application specific config file, but to the global KDE config file.
  | bNLS | If `bNLS` is true, the locale tag is added to the key when writing it back.

See also:
  writeEntry()

Definition at line 1313 of file kconfigbase.cpp.

References writeEntry().

void KConfigBase::writeEntry | ( | const char * | pKey,
|  | const QStrList & | rValue,
|  | char | sep = `','`,
|  | bool | bPersistent = `true`,
|  | bool | bGlobal = `false`,
|  | bool | bNLS = `false`
| ) |

writeEntry() overridden to accept a list of strings.

Note: Unlike the other writeEntry() functions, the old value is _not_ returned here!

Parameters:

  | pKey | The key to write
  | rValue | The list to write
  | sep | The list separator (default is ",").
  | bPersistent | If `bPersistent` is false, the entry's dirty flag will not be set and thus the entry will not be written to disk at deletion time.
  | bGlobal | If `bGlobal` is true, the pair is not saved to the application specific config file, but to the global KDE config file.
  | bNLS | If `bNLS` is true, the locale tag is added to the key when writing it back.

See also:
  writeEntry()

Definition at line 1320 of file kconfigbase.cpp.

References QString::at(), KStringHandler::from8Bit(), QString::length(), QString::truncate(), and writeEntry().

void KConfigBase::writeEntry | ( | const QString & | pKey,
|  | const QStringList & | rValue,
|  | char | sep = `','`,
|  | bool | bPersistent = `true`,
|  | bool | bGlobal = `false`,
|  | bool | bNLS = `false`
| ) |

writeEntry() overridden to accept a list of strings.

Note: Unlike the other writeEntry() functions, the old value is _not_ returned here!

Parameters:

  | pKey | The key to write
  | rValue | The list to write
  | sep | The list separator (default is ",").
  | bPersistent | If `bPersistent` is false, the entry's dirty flag will not be set and thus the entry will not be written to disk at deletion time.
  | bGlobal | If `bGlobal` is true, the pair is not saved to the application specific config file, but to the global KDE config file.
  | bNLS | If `bNLS` is true, the locale tag is added to the key when writing it back.

See also:
  writeEntry()

Definition at line 1352 of file kconfigbase.cpp.

References writeEntry().

void KConfigBase::writeEntry | ( | const char * | pKey,
|  | const QStringList & | rValue,
|  | char | sep = `','`,
|  | bool | bPersistent = `true`,
|  | bool | bGlobal = `false`,
|  | bool | bNLS = `false`
| ) |

writeEntry() overridden to accept a list of strings.

Note: Unlike the other writeEntry() functions, the old value is _not_ returned here!

Parameters:

  | pKey | The key to write
  | rValue | The list to write
  | sep | The list separator (default is ",").
  | bPersistent | If `bPersistent` is false, the entry's dirty flag will not be set and thus the entry will not be written to disk at deletion time.
  | bGlobal | If `bGlobal` is true, the pair is not saved to the application specific config file, but to the global KDE config file.
  | bNLS | If `bNLS` is true, the locale tag is added to the key when writing it back.

See also:
  writeEntry()

Definition at line 1359 of file kconfigbase.cpp.

References QString::at(), QString::length(), QString::reserve(), QString::truncate(), and writeEntry().

void KConfigBase::writeEntry | ( | const QString & | pKey,
|  | const QValueList< int > & | rValue,
|  | bool | bPersistent = `true`,
|  | bool | bGlobal = `false`,
|  | bool | bNLS = `false`
| ) |

writeEntry() overridden to accept a list of Integers.

Note: Unlike the other writeEntry() functions, the old value is _not_ returned here!

Parameters:

  | pKey | The key to write
  | rValue | The list to write
  | bPersistent | If `bPersistent` is false, the entry's dirty flag will not be set and thus the entry will not be written to disk at deletion time.
  | bGlobal | If `bGlobal` is true, the pair is not saved to the application specific config file, but to the global KDE config file.
  | bNLS | If `bNLS` is true, the locale tag is added to the key when writing it back.

See also:
  writeEntry()

Definition at line 1388 of file kconfigbase.cpp.

References writeEntry().

void KConfigBase::writeEntry | ( | const char * | pKey,
|  | const QValueList< int > & | rValue,
|  | bool | bPersistent = `true`,
|  | bool | bGlobal = `false`,
|  | bool | bNLS = `false`
| ) |

writeEntry() overridden to accept a list of Integers.

Note: Unlike the other writeEntry() functions, the old value is _not_ returned here!

Parameters:

  | pKey | The key to write
  | rValue | The list to write
  | bPersistent | If `bPersistent` is false, the entry's dirty flag will not be set and thus the entry will not be written to disk at deletion time.
  | bGlobal | If `bGlobal` is true, the pair is not saved to the application specific config file, but to the global KDE config file.
  | bNLS | If `bNLS` is true, the locale tag is added to the key when writing it back.

See also:
  writeEntry()

Definition at line 1394 of file kconfigbase.cpp.

References QString::number(), and writeEntry().

void KConfigBase::writeEntry | ( | const QString & | pKey,
|  | const char * | pValue,
|  | bool | bPersistent = `true`,
|  | bool | bGlobal = `false`,
|  | bool | bNLS = `false`
| ) | `[inline]`

Write a (key/value) pair.

This is stored to the most specific config file when destroying the config object or when calling sync().

Parameters:

  | pKey | The key to write.
  | pValue | The value to write.
  | bPersistent | If `bPersistent` is false, the entry's dirty flag will not be set and thus the entry will not be written to disk at deletion time.
  | bGlobal | If `bGlobal` is true, the pair is not saved to the application specific config file, but to the global KDE config file.
  | bNLS | If `bNLS` is true, the locale tag is added to the key when writing it back.

Definition at line 978 of file kconfigbase.h.

References writeEntry().

void KConfigBase::writeEntry | ( | const char * | pKey,
|  | const char * | pValue,
|  | bool | bPersistent = `true`,
|  | bool | bGlobal = `false`,
|  | bool | bNLS = `false`
| ) | `[inline]`

Write a (key/value) pair.

This is stored to the most specific config file when destroying the config object or when calling sync().

Parameters:

  | pKey | The key to write.
  | pValue | The value to write.
  | bPersistent | If `bPersistent` is false, the entry's dirty flag will not be set and thus the entry will not be written to disk at deletion time.
  | bGlobal | If `bGlobal` is true, the pair is not saved to the application specific config file, but to the global KDE config file.
  | bNLS | If `bNLS` is true, the locale tag is added to the key when writing it back.

Definition at line 999 of file kconfigbase.h.

References writeEntry().

void KConfigBase::writeEntry | ( | const QString & | pKey,
|  | int | nValue,
|  | bool | bPersistent = `true`,
|  | bool | bGlobal = `false`,
|  | bool | bNLS = `false`
| ) |

Write a (key/value) pair.

Same as above, but writes a numerical value.

Parameters:

  | pKey | The key to write.
  | nValue | The value to write.
  | bPersistent | If `bPersistent` is false, the entry's dirty flag will not be set and thus the entry will not be written to disk at deletion time.
  | bGlobal | If `bGlobal` is true, the pair is not saved to the application specific config file, but to the global KDE config file.
  | bNLS | If `bNLS` is true, the locale tag is added to the key when writing it back.

Definition at line 1404 of file kconfigbase.cpp.

References writeEntry().

void KConfigBase::writeEntry | ( | const char * | pKey,
|  | int | nValue,
|  | bool | bPersistent = `true`,
|  | bool | bGlobal = `false`,
|  | bool | bNLS = `false`
| ) |

Write a (key/value) pair.

Same as above, but writes a numerical value.

Parameters:

  | pKey | The key to write.
  | nValue | The value to write.
  | bPersistent | If `bPersistent` is false, the entry's dirty flag will not be set and thus the entry will not be written to disk at deletion time.
  | bGlobal | If `bGlobal` is true, the pair is not saved to the application specific config file, but to the global KDE config file.
  | bNLS | If `bNLS` is true, the locale tag is added to the key when writing it back.

Definition at line 1411 of file kconfigbase.cpp.

References writeEntry().

void KConfigBase::writeEntry | ( | const QString & | pKey,
|  | unsigned int | nValue,
|  | bool | bPersistent = `true`,
|  | bool | bGlobal = `false`,
|  | bool | bNLS = `false`
| ) |

Writes a (key/value) pair.

Same as above, but writes an unsigned numerical value.

Parameters:

  | pKey | The key to write.
  | nValue | The value to write.
  | bPersistent | If `bPersistent` is false, the entry's dirty flag will not be set and thus the entry will not be written to disk at deletion time.
  | bGlobal | If `bGlobal` is true, the pair is not saved to the application specific config file, but to the global KDE config file.
  | bNLS | If `bNLS` is true, the locale tag is added to the key when writing it back.

Definition at line 1419 of file kconfigbase.cpp.

References writeEntry().

void KConfigBase::writeEntry | ( | const char * | pKey,
|  | unsigned int | nValue,
|  | bool | bPersistent = `true`,
|  | bool | bGlobal = `false`,
|  | bool | bNLS = `false`
| ) |

Writes a (key/value) pair.

Same as above, but writes an unsigned numerical value.

Parameters:

  | pKey | The key to write.
  | nValue | The value to write.
  | bPersistent | If `bPersistent` is false, the entry's dirty flag will not be set and thus the entry will not be written to disk at deletion time.
  | bGlobal | If `bGlobal` is true, the pair is not saved to the application specific config file, but to the global KDE config file.
  | bNLS | If `bNLS` is true, the locale tag is added to the key when writing it back.

Definition at line 1426 of file kconfigbase.cpp.

References writeEntry().

void KConfigBase::writeEntry | ( | const QString & | pKey,
|  | long | nValue,
|  | bool | bPersistent = `true`,
|  | bool | bGlobal = `false`,
|  | bool | bNLS = `false`
| ) |

Writes a (key/value) pair.

Same as above, but write a long numerical value.

Parameters:

  | pKey | The key to write.
  | nValue | The value to write.
  | bPersistent | If `bPersistent` is false, the entry's dirty flag will not be set and thus the entry will not be written to disk at deletion time.
  | bGlobal | If `bGlobal` is true, the pair is not saved to the application specific config file, but to the global KDE config file.
  | bNLS | If `bNLS` is true, the locale tag is added to the key when writing it back.

Definition at line 1434 of file kconfigbase.cpp.

References writeEntry().

void KConfigBase::writeEntry | ( | const char * | pKey,
|  | long | nValue,
|  | bool | bPersistent = `true`,
|  | bool | bGlobal = `false`,
|  | bool | bNLS = `false`
| ) |

Writes a (key/value) pair.

Same as above, but write a long numerical value.

Parameters:

  | pKey | The key to write.
  | nValue | The value to write.
  | bPersistent | If `bPersistent` is false, the entry's dirty flag will not be set and thus the entry will not be written to disk at deletion time.
  | bGlobal | If `bGlobal` is true, the pair is not saved to the application specific config file, but to the global KDE config file.
  | bNLS | If `bNLS` is true, the locale tag is added to the key when writing it back.

Definition at line 1441 of file kconfigbase.cpp.

References writeEntry().

void KConfigBase::writeEntry | ( | const QString & | pKey,
|  | unsigned long | nValue,
|  | bool | bPersistent = `true`,
|  | bool | bGlobal = `false`,
|  | bool | bNLS = `false`
| ) |

Writes a (key/value) pair.

Same as above, but writes an unsigned long numerical value.

Parameters:

  | pKey | The key to write.
  | nValue | The value to write.
  | bPersistent | If `bPersistent` is false, the entry's dirty flag will not be set and thus the entry will not be written to disk at deletion time.
  | bGlobal | If `bGlobal` is true, the pair is not saved to the application specific config file, but to the global KDE config file.
  | bNLS | If `bNLS` is true, the locale tag is added to the key when writing it back.

Definition at line 1449 of file kconfigbase.cpp.

References writeEntry().

void KConfigBase::writeEntry | ( | const char * | pKey,
|  | unsigned long | nValue,
|  | bool | bPersistent = `true`,
|  | bool | bGlobal = `false`,
|  | bool | bNLS = `false`
| ) |

Writes a (key/value) pair.

Same as above, but writes an unsigned long numerical value.

Parameters:

  | pKey | The key to write.
  | nValue | The value to write.
  | bPersistent | If `bPersistent` is false, the entry's dirty flag will not be set and thus the entry will not be written to disk at deletion time.
  | bGlobal | If `bGlobal` is true, the pair is not saved to the application specific config file, but to the global KDE config file.
  | bNLS | If `bNLS` is true, the locale tag is added to the key when writing it back.

Definition at line 1456 of file kconfigbase.cpp.

References writeEntry().

void KConfigBase::writeEntry | ( | const QString & | pKey,
|  | Q_INT64 | nValue,
|  | bool | bPersistent = `true`,
|  | bool | bGlobal = `false`,
|  | bool | bNLS = `false`
| ) |

Writes a (key/value) pair.

Same as above, but write a 64-bit numerical value.

Parameters:

  | pKey | The key to write.
  | nValue | The value to write.
  | bPersistent | If `bPersistent` is false, the entry's dirty flag will not be set and thus the entry will not be written to disk at deletion time.
  | bGlobal | If `bGlobal` is true, the pair is not saved to the application specific config file, but to the global KDE config file.
  | bNLS | If `bNLS` is true, the locale tag is added to the key when writing it back.

Definition at line 1463 of file kconfigbase.cpp.

References writeEntry().

void KConfigBase::writeEntry | ( | const char * | pKey,
|  | Q_INT64 | nValue,
|  | bool | bPersistent = `true`,
|  | bool | bGlobal = `false`,
|  | bool | bNLS = `false`
| ) |

Writes a (key/value) pair.

Same as above, but write a long numerical value.

Parameters:

  | pKey | The key to write.
  | nValue | The value to write.
  | bPersistent | If `bPersistent` is false, the entry's dirty flag will not be set and thus the entry will not be written to disk at deletion time.
  | bGlobal | If `bGlobal` is true, the pair is not saved to the application specific config file, but to the global KDE config file.
  | bNLS | If `bNLS` is true, the locale tag is added to the key when writing it back.

Definition at line 1470 of file kconfigbase.cpp.

References writeEntry().

void KConfigBase::writeEntry | ( | const QString & | pKey,
|  | Q_UINT64 | nValue,
|  | bool | bPersistent = `true`,
|  | bool | bGlobal = `false`,
|  | bool | bNLS = `false`
| ) |

Writes a (key/value) pair.

Same as above, but writes an unsigned 64-bit numerical value.

Parameters:

  | pKey | The key to write.
  | nValue | The value to write.
  | bPersistent | If `bPersistent` is false, the entry's dirty flag will not be set and thus the entry will not be written to disk at deletion time.
  | bGlobal | If `bGlobal` is true, the pair is not saved to the application specific config file, but to the global KDE config file.
  | bNLS | If `bNLS` is true, the locale tag is added to the key when writing it back.

Definition at line 1478 of file kconfigbase.cpp.

References writeEntry().

void KConfigBase::writeEntry | ( | const char * | pKey,
|  | Q_UINT64 | nValue,
|  | bool | bPersistent = `true`,
|  | bool | bGlobal = `false`,
|  | bool | bNLS = `false`
| ) |

Writes a (key/value) pair.

Same as above, but writes an unsigned 64-bit numerical value.

Parameters:

  | pKey | The key to write.
  | nValue | The value to write.
  | bPersistent | If `bPersistent` is false, the entry's dirty flag will not be set and thus the entry will not be written to disk at deletion time.
  | bGlobal | If `bGlobal` is true, the pair is not saved to the application specific config file, but to the global KDE config file.
  | bNLS | If `bNLS` is true, the locale tag is added to the key when writing it back.

Definition at line 1485 of file kconfigbase.cpp.

References writeEntry().

void KConfigBase::writeEntry | ( | const QString & | pKey,
|  | double | nValue,
|  | bool | bPersistent = `true`,
|  | bool | bGlobal = `false`,
|  | char | format = `'g'`,
|  | int | precision = `6`,
|  | bool | bNLS = `false`
| ) |

Writes a (key/value) pair.

Same as above, but writes a floating-point value.

Parameters:

  | pKey | The key to write.
  | nValue | The value to write.
  | bPersistent | If `bPersistent` is false, the entry's dirty flag will not be set and thus the entry will not be written to disk at deletion time.
  | bGlobal | If `bGlobal` is true, the pair is not saved to the application specific config file, but to the global KDE config file.
  | format | `format` determines the format to which the value is converted. Default is 'g'.
  | precision | `precision` sets the precision with which the value is converted. Default is 6 as in QString.
  | bNLS | If `bNLS` is true, the locale tag is added to the key when writing it back.

Definition at line 1492 of file kconfigbase.cpp.

References writeEntry().

void KConfigBase::writeEntry | ( | const char * | pKey,
|  | double | nValue,
|  | bool | bPersistent = `true`,
|  | bool | bGlobal = `false`,
|  | char | format = `'g'`,
|  | int | precision = `6`,
|  | bool | bNLS = `false`
| ) |

Writes a (key/value) pair.

Same as above, but writes a floating-point value.

Parameters:

  | pKey | The key to write.
  | nValue | The value to write.
  | bPersistent | If `bPersistent` is false, the entry's dirty flag will not be set and thus the entry will not be written to disk at deletion time.
  | bGlobal | If `bGlobal` is true, the pair is not saved to the application specific config file, but to the global KDE config file.
  | format | `format` determines the format to which the value is converted. Default is 'g'.
  | precision | `precision` sets the precision with which the value is converted. Default is 6 as in QString.
  | bNLS | If `bNLS` is true, the locale tag is added to the key when writing it back.

Definition at line 1501 of file kconfigbase.cpp.

References writeEntry().

void KConfigBase::writeEntry | ( | const QString & | pKey,
|  | bool | bValue,
|  | bool | bPersistent = `true`,
|  | bool | bGlobal = `false`,
|  | bool | bNLS = `false`
| ) |

Writes a (key/value) pair.

Same as above, but writes a boolean value.

Parameters:

  | pKey | The key to write.
  | bValue | The value to write.
  | bPersistent | If `bPersistent` is false, the entry's dirty flag will not be set and thus the entry will not be written to disk at deletion time.
  | bGlobal | If `bGlobal` is true, the pair is not saved to the application specific config file, but to the global KDE config file.
  | bNLS | If `bNLS` is true, the locale tag is added to the key when writing it back.

Definition at line 1511 of file kconfigbase.cpp.

References writeEntry().

void KConfigBase::writeEntry | ( | const char * | pKey,
|  | bool | bValue,
|  | bool | bPersistent = `true`,
|  | bool | bGlobal = `false`,
|  | bool | bNLS = `false`
| ) |

Writes a (key/value) pair.

Same as above, but writes a boolean value.

Parameters:

  | pKey | The key to write.
  | bValue | The value to write.
  | bPersistent | If `bPersistent` is false, the entry's dirty flag will not be set and thus the entry will not be written to disk at deletion time.
  | bGlobal | If `bGlobal` is true, the pair is not saved to the application specific config file, but to the global KDE config file.
  | bNLS | If `bNLS` is true, the locale tag is added to the key when writing it back.

Definition at line 1519 of file kconfigbase.cpp.

References writeEntry().

void KConfigBase::writeEntry | ( | const QString & | pKey,
|  | const QFont & | rFont,
|  | bool | bPersistent = `true`,
|  | bool | bGlobal = `false`,
|  | bool | bNLS = `false`
| ) |

Writes a (key/value) pair.

Same as above, but writes a font value.

Parameters:

  | pKey | The key to write.
  | rFont | The font value to write.
  | bPersistent | If `bPersistent` is false, the entry's dirty flag will not be set and thus the entry will not be written to disk at deletion time.
  | bGlobal | If `bGlobal` is true, the pair is not saved to the application specific config file, but to the global KDE config file.
  | bNLS | If `bNLS` is true, the locale tag is added to the key when writing it back.

Definition at line 1535 of file kconfigbase.cpp.

References writeEntry().

void KConfigBase::writeEntry | ( | const char * | pKey,
|  | const QFont & | rFont,
|  | bool | bPersistent = `true`,
|  | bool | bGlobal = `false`,
|  | bool | bNLS = `false`
| ) |

Writes a (key/value) pair.

Same as above, but writes a font value.

Parameters:

  | pKey | The key to write.
  | rFont | The font value to write.
  | bPersistent | If `bPersistent` is false, the entry's dirty flag will not be set and thus the entry will not be written to disk at deletion time.
  | bGlobal | If `bGlobal` is true, the pair is not saved to the application specific config file, but to the global KDE config file.
  | bNLS | If `bNLS` is true, the locale tag is added to the key when writing it back.

Definition at line 1542 of file kconfigbase.cpp.

References writeEntry().

void KConfigBase::writeEntry | ( | const QString & | pKey,
|  | const QColor & | rColor,
|  | bool | bPersistent = `true`,
|  | bool | bGlobal = `false`,
|  | bool | bNLS = `false`
| ) |

Writes a (key/value) pair.

Same as above, but write a color entry.

Note: Unlike the other writeEntry() functions, the old value is _not_ returned here!

Parameters:

  | pKey | The key to write.
  | rColor | The color value to write.
  | bPersistent | If `bPersistent` is false, the entry's dirty flag will not be set and thus the entry will not be written to disk at deletion time.
  | bGlobal | If `bGlobal` is true, the pair is not saved to the application specific config file, but to the global KDE config file.
  | bNLS | If `bNLS` is true, the locale tag is added to the key when writing it back.

Definition at line 1611 of file kconfigbase.cpp.

References writeEntry().

void KConfigBase::writeEntry | ( | const char * | pKey,
|  | const QColor & | rColor,
|  | bool | bPersistent = `true`,
|  | bool | bGlobal = `false`,
|  | bool | bNLS = `false`
| ) |

Writes a (key/value) pair.

Same as above, but write a color entry.

Note: Unlike the other writeEntry() functions, the old value is _not_ returned here!

Parameters:

  | pKey | The key to write.
  | rColor | The color value to write.
  | bPersistent | If `bPersistent` is false, the entry's dirty flag will not be set and thus the entry will not be written to disk at deletion time.
  | bGlobal | If `bGlobal` is true, the pair is not saved to the application specific config file, but to the global KDE config file.
  | bNLS | If `bNLS` is true, the locale tag is added to the key when writing it back.

Definition at line 1619 of file kconfigbase.cpp.

References QString::sprintf(), and writeEntry().

void KConfigBase::writeEntry | ( | const QString & | pKey,
|  | const QDateTime & | rDateTime,
|  | bool | bPersistent = `true`,
|  | bool | bGlobal = `false`,
|  | bool | bNLS = `false`
| ) |

Writes a (key/value) pair.

Same as above, but writes a date and time entry.

Note: Unlike the other writeEntry() functions, the old value is not returned here!

Parameters:

  | pKey | The key to write.
  | rDateTime | The date and time value to write.
  | bPersistent | If `bPersistent` is false, the entry's dirty flag will not be set and thus the entry will not be written to disk at deletion time.
  | bGlobal | If `bGlobal` is true, the pair is not saved to the application specific config file, but to the global KDE config file.
  | bNLS | If `bNLS` is true, the locale tag is added to the key when writing it back.

Definition at line 1633 of file kconfigbase.cpp.

References writeEntry().

void KConfigBase::writeEntry | ( | const char * | pKey,
|  | const QDateTime & | rDateTime,
|  | bool | bPersistent = `true`,
|  | bool | bGlobal = `false`,
|  | bool | bNLS = `false`
| ) |

Writes a (key/value) pair.

Same as above, but writes a date and time entry.

Note: Unlike the other writeEntry() functions, the old value is not returned here!

Parameters:

  | pKey | The key to write.
  | rDateTime | The date and time value to write.
  | bPersistent | If `bPersistent` is false, the entry's dirty flag will not be set and thus the entry will not be written to disk at deletion time.
  | bGlobal | If `bGlobal` is true, the pair is not saved to the application specific config file, but to the global KDE config file.
  | bNLS | If `bNLS` is true, the locale tag is added to the key when writing it back.

Definition at line 1640 of file kconfigbase.cpp.

References QDate::day(), QTime::hour(), QTime::minute(), QDate::month(), QTime::second(), QCString::setNum(), writeEntry(), and QDate::year().

void KConfigBase::writeEntry | ( | const QString & | pKey,
|  | const QRect & | rValue,
|  | bool | bPersistent = `true`,
|  | bool | bGlobal = `false`,
|  | bool | bNLS = `false`
| ) |

Writes a (key/value) pair.

Same as above, but writes a rectangle.

Note: Unlike the other writeEntry() functions, the old value is _not_ returned here!

Parameters:

  | pKey | The key to write.
  | rValue | The rectangle value to write.
  | bPersistent | If `bPersistent` is false, the entry's dirty flag will not be set and thus the entry will not be written to disk at deletion time.
  | bGlobal | If `bGlobal` is true, the pair is not saved to the application specific config file, but to the global KDE config file.
  | bNLS | If `bNLS` is true, the locale tag is added to the key when writing it back.

Definition at line 1550 of file kconfigbase.cpp.

References writeEntry().

void KConfigBase::writeEntry | ( | const char * | pKey,
|  | const QRect & | rValue,
|  | bool | bPersistent = `true`,
|  | bool | bGlobal = `false`,
|  | bool | bNLS = `false`
| ) |

Writes a (key/value) pair.

Same as above, but writes a rectangle.

Note: Unlike the other writeEntry() functions, the old value is _not_ returned here!

Parameters:

  | pKey | The key to write.
  | rValue | The rectangle value to write.
  | bPersistent | If `bPersistent` is false, the entry's dirty flag will not be set and thus the entry will not be written to disk at deletion time.
  | bGlobal | If `bGlobal` is true, the pair is not saved to the application specific config file, but to the global KDE config file.
  | bNLS | If `bNLS` is true, the locale tag is added to the key when writing it back.

Definition at line 1557 of file kconfigbase.cpp.

References QCString::setNum(), and writeEntry().

void KConfigBase::writeEntry | ( | const QString & | pKey,
|  | const QPoint & | rValue,
|  | bool | bPersistent = `true`,
|  | bool | bGlobal = `false`,
|  | bool | bNLS = `false`
| ) |

Writes a (key/value) pair.

Same as above, but writes a point.

Note: Unlike the other writeEntry() functions, the old value is _not_ returned here!

Parameters:

  | pKey | The key to write.
  | rValue | The point value to write.
  | bPersistent | If `bPersistent` is false, the entry's dirty flag will not be set and thus the entry will not be written to disk at deletion time.
  | bGlobal | If `bGlobal` is true, the pair is not saved to the application specific config file, but to the global KDE config file.
  | bNLS | If `bNLS` is true, the locale tag is added to the key when writing it back.

Definition at line 1572 of file kconfigbase.cpp.

References writeEntry().

void KConfigBase::writeEntry | ( | const char * | pKey,
|  | const QPoint & | rValue,
|  | bool | bPersistent = `true`,
|  | bool | bGlobal = `false`,
|  | bool | bNLS = `false`
| ) |

Writes a (key/value) pair.

Same as above, but writes a point.

Note: Unlike the other writeEntry() functions, the old value is _not_ returned here!

Parameters:

  | pKey | The key to write.
  | rValue | The point value to write.
  | bPersistent | If `bPersistent` is false, the entry's dirty flag will not be set and thus the entry will not be written to disk at deletion time.
  | bGlobal | If `bGlobal` is true, the pair is not saved to the application specific config file, but to the global KDE config file.
  | bNLS | If `bNLS` is true, the locale tag is added to the key when writing it back.

Definition at line 1579 of file kconfigbase.cpp.

References QCString::setNum(), and writeEntry().

void KConfigBase::writeEntry | ( | const QString & | pKey,
|  | const QSize & | rValue,
|  | bool | bPersistent = `true`,
|  | bool | bGlobal = `false`,
|  | bool | bNLS = `false`
| ) |

Writes a (key/value) pair.

Same as above, but writes a size.

Note: Unlike the other writeEntry() functions, the old value is _not_ returned here!

Parameters:

  | pKey | The key to write.
  | rValue | The size value to write.
  | bPersistent | If `bPersistent` is false, the entry's dirty flag will not be set and thus the entry will not be written to disk at deletion time.
  | bGlobal | If `bGlobal` is true, the pair is not saved to the application specific config file, but to the global KDE config file.
  | bNLS | If `bNLS` is true, the locale tag is added to the key when writing it back.

Definition at line 1592 of file kconfigbase.cpp.

References writeEntry().

void KConfigBase::writeEntry | ( | const char * | pKey,
|  | const QSize & | rValue,
|  | bool | bPersistent = `true`,
|  | bool | bGlobal = `false`,
|  | bool | bNLS = `false`
| ) |

Writes a (key/value) pair.

Same as above, but writes a size.

Note: Unlike the other writeEntry() functions, the old value is _not_ returned here!

Parameters:

  | pKey | The key to write.
  | rValue | The size value to write.
  | bPersistent | If `bPersistent` is false, the entry's dirty flag will not be set and thus the entry will not be written to disk at deletion time.
  | bGlobal | If `bGlobal` is true, the pair is not saved to the application specific config file, but to the global KDE config file.
  | bNLS | If `bNLS` is true, the locale tag is added to the key when writing it back.

Definition at line 1599 of file kconfigbase.cpp.

References QCString::setNum(), and writeEntry().

void KConfigBase::writePathEntry | ( | const QString & | pKey,
|  | const QString & | path,
|  | bool | bPersistent = `true`,
|  | bool | bGlobal = `false`,
|  | bool | bNLS = `false`
| ) |

Writes a file path.

It is checked whether the path is located under $HOME. If so the path is written out with the user's home-directory replaced with $HOME. The path should be read back with readPathEntry()

Parameters:

  | pKey | The key to write.
  | path | The path to write.
  | bPersistent | If `bPersistent` is false, the entry's dirty flag will not be set and thus the entry will not be written to disk at deletion time.
  | bGlobal | If `bGlobal` is true, the pair is not saved to the application specific config file, but to the global KDE config file.
  | bNLS | If `bNLS` is true, the locale tag is added to the key when writing it back.

Definition at line 1048 of file kconfigbase.cpp.

Referenced by writePathEntry().

void KConfigBase::writePathEntry | ( | const char * | pKey,
|  | const QString & | path,
|  | bool | bPersistent = `true`,
|  | bool | bGlobal = `false`,
|  | bool | bNLS = `false`
| ) |

Writes a file path.

It is checked whether the path is located under $HOME. If so the path is written out with the user's home-directory replaced with $HOME. The path should be read back with readPathEntry()

Parameters:

  | pKey | The key to write.
  | path | The path to write.
  | bPersistent | If `bPersistent` is false, the entry's dirty flag will not be set and thus the entry will not be written to disk at deletion time.
  | bGlobal | If `bGlobal` is true, the pair is not saved to the application specific config file, but to the global KDE config file.
  | bNLS | If `bNLS` is true, the locale tag is added to the key when writing it back.

Definition at line 1117 of file kconfigbase.cpp.

void KConfigBase::writePathEntry | ( | const QString & | pKey,
|  | const QStringList & | rValue,
|  | char | sep = `','`,
|  | bool | bPersistent = `true`,
|  | bool | bGlobal = `false`,
|  | bool | bNLS = `false`
| ) |

writePathEntry() overridden to accept a list of paths (strings).

It is checked whether the paths are located under $HOME. If so each of the paths are written out with the user's home-directory replaced with $HOME. The paths should be read back with readPathListEntry()

Parameters:

  | pKey | The key to write
  | rValue | The list to write
  | sep | The list separator (default is ",").
  | bPersistent | If `bPersistent` is false, the entry's dirty flag will not be set and thus the entry will not be written to disk at deletion time.
  | bGlobal | If `bGlobal` is true, the pair is not saved to the application specific config file, but to the global KDE config file.
  | bNLS | If `bNLS` is true, the locale tag is added to the key when writing it back.

See also:
  writePathEntry()

  readPathListEntry()

Since:
  3.1.3

Definition at line 1124 of file kconfigbase.cpp.

References writePathEntry().

void KConfigBase::writePathEntry | ( | const char * | pKey,
|  | const QStringList & | rValue,
|  | char | sep = `','`,
|  | bool | bPersistent = `true`,
|  | bool | bGlobal = `false`,
|  | bool | bNLS = `false`
| ) |

writePathEntry() overridden to accept a list of paths (strings).

It is checked whether the paths are located under $HOME. If so each of the paths are written out with the user's home-directory replaced with $HOME. The paths should be read back with readPathListEntry()

Parameters:

  | pKey | The key to write
  | rValue | The list to write
  | sep | The list separator (default is ",").
  | bPersistent | If `bPersistent` is false, the entry's dirty flag will not be set and thus the entry will not be written to disk at deletion time.
  | bGlobal | If `bGlobal` is true, the pair is not saved to the application specific config file, but to the global KDE config file.
  | bNLS | If `bNLS` is true, the locale tag is added to the key when writing it back.

See also:
  writePathEntry()

  readPathListEntry()

Since:
  3.1.3

Definition at line 1131 of file kconfigbase.cpp.

References writeEntry().

void KConfigBase::deleteEntry | ( | const QString & | pKey,
|  | bool | bNLS = `false`,
|  | bool | bGlobal = `false`
| ) |

Deletes the entry specified by `pKey` in the current group.

Parameters:

  | pKey | The key to delete.
  | bGlobal | If `bGlobal` is true, the pair is not removed from the application specific config file, but to the global KDE config file.
  | bNLS | If `bNLS` is true, the key with the locale tag is removed.

Definition at line 1150 of file kconfigbase.cpp.

void KConfigBase::deleteEntry | ( | const char * | pKey,
|  | bool | bNLS = `false`,
|  | bool | bGlobal = `false`
| ) |

Deletes the entry specified by `pKey` in the current group.

Parameters:

  | pKey | The key to delete.
  | bGlobal | If `bGlobal` is true, the pair is not removed from the application specific config file, but from the global KDE config file.
  | bNLS | If `bNLS` is true, the key with the locale tag is removed.

Definition at line 1157 of file kconfigbase.cpp.

References KEntry::bDeleted, KEntry::bDirty, KEntry::bGlobal, KEntry::bNLS, mGroup, putData(), setDirty(), and setLocale().

bool KConfigBase::deleteGroup | ( | const QString & | group,
|  | bool | bDeep = `true`,
|  | bool | bGlobal = `false`
| ) |

Deletes a configuration entry group.

If the group is not empty and bDeep is false, nothing gets deleted and false is returned. If this group is the current group and it is deleted, the current group is undefined and should be set with setGroup() before the next operation on the configuration object.

Parameters:

  | group | The name of the group
  | bDeep | Specify whether non-empty groups should be completely deleted (including their entries).
  | bGlobal | If `bGlobal` is true, the group is not removed from the application specific config file, but from the global KDE config file.

Returns:
  If the group is not empty and bDeep is false, deleteGroup returns false.

Definition at line 1183 of file kconfigbase.cpp.

References KEntry::bDeleted, KEntry::bDirty, KEntry::bGlobal, group(), internalEntryMap(), KEntry::mValue, putData(), and setDirty().

Referenced by KConfigGroup::deleteGroup(), and KShortcutList::writeSettings().

void KConfigBase::setDollarExpansion | ( | bool | _bExpand = `true` | ) | `[inline]`

Turns on or off "dollar expansion" (see KConfigBase introduction) when reading config entries.

Dollar sign expansion is initially OFF.

Parameters:

  | _bExpand | Tf true, dollar expansion is turned on.

Definition at line 1678 of file kconfigbase.h.

bool KConfigBase::isDollarExpansion | ( |  | ) | const`[inline]`

Returns whether dollar expansion is on or off.

It is initially OFF.

Returns:
  true if dollar expansion is on.

Definition at line 1685 of file kconfigbase.h.

void KConfigBase::rollback | ( | bool | bDeep = `true` | ) | `[virtual]`

Mark the config object as "clean," i.e.

don't write dirty entries at destruction time. If `bDeep` is false, only the global dirty flag of the KConfig object gets cleared. If you then call writeEntry() again, the global dirty flag is set again and all dirty entries will be written at a subsequent sync() call.

Classes that derive from KConfigBase should override this method and implement storage-specific behavior, as well as calling the KConfigBase::rollback() explicitly in the initializer.

Parameters:

  | bDeep | If true, the dirty flags of all entries are cleared, as well as the global dirty flag.

Reimplemented in KConfig.

Definition at line 1690 of file kconfigbase.cpp.

References bDirty.

Referenced by KConfig::rollback(), and sync().

void KConfigBase::sync | ( |  | ) | `[virtual]`

Flushes all changes that currently reside only in memory back to disk / permanent storage.

Dirty configuration entries are written to the most specific file available.

Asks the back end to flush out all pending writes, and then calls rollback(). No changes are made if the object has `readOnly` status.

You should call this from your destructor in derivative classes.

See also:
  rollback(), isReadOnly()

Reimplemented in KConfigGroup, and KSimpleConfig.

Definition at line 1673 of file kconfigbase.cpp.

References backEnd, bDirty, isReadOnly(), rollback(), and KConfigBackEnd::sync().

Referenced by KConfigGroup::sync(), and KConfig::~KConfig().

bool KConfigBase::isDirty | ( |  | ) | const`[inline]`

Checks whether the config file has any dirty (modified) entries.

Returns:
  true if the config file has any dirty (modified) entries.

Definition at line 1722 of file kconfigbase.h.

Referenced by KSimpleConfig::sync(), and KConfigINIBackEnd::sync().

virtual void KConfigBase::setReadOnly | ( | bool | _ro | ) | `[inline, virtual]`

Sets the config object's read-only status.

Parameters:

  | _ro | If true, the config object will not write out any changes to disk even if it is destroyed or sync() is called.

Definition at line 1731 of file kconfigbase.h.

Referenced by KConfig::KConfig(), KDesktopFile::KDesktopFile(), and KSimpleConfig::KSimpleConfig().

bool KConfigBase::isReadOnly | ( |  | ) | const`[inline]`

Returns the read-only status of the config object.

Returns:
  The read-only status.

Definition at line 1738 of file kconfigbase.h.

Referenced by KConfigINIBackEnd::parseConfigFiles(), KConfig::reparseConfiguration(), KSimpleConfig::sync(), sync(), and KConfigINIBackEnd::writeConfigFile().

bool KConfigBase::hasKey | ( | const QString & | key | ) | const

Checks whether the key has an entry in the currently active group.

Use this to determine whether a key is not specified for the current group (hasKey() returns false). Keys with null data are considered nonexistent.

Parameters:

  | key | The key to search for.

Returns:
  If true, the key is available.

Definition at line 109 of file kconfigbase.cpp.

Referenced by KLocale::languagesTwoAlpha(), readDateTimeEntry(), KDesktopFile::readDocPath(), readListEntry(), and readPropertyEntry().

virtual QMap<QString, QString> KConfigBase::entryMap | ( | const QString & | group | ) | const`[pure 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:

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

See also:
  QMap

Implemented in KConfig.

virtual void KConfigBase::reparseConfiguration | ( |  | ) | `[pure virtual]`

Reparses all configuration files.

This is useful for programs that use stand alone graphical configuration tools. The base method implemented here only clears the group list and then appends the default group.

Derivative classes should clear any internal data structures and then simply call parseConfigFiles() when implementing this method.

See also:
  parseConfigFiles()

Implemented in KConfig.

bool KConfigBase::isImmutable | ( |  | ) | const

Checks whether this configuration file can be modified.

Returns:
  whether changes may be made to this configuration file.

Definition at line 149 of file kconfigbase.cpp.

References getConfigState().

bool KConfigBase::groupIsImmutable | ( | const QString & | group | ) | const

Checks whether it is possible to change the given group.

Parameters:

  | group | the group to check

Returns:
  whether changes may be made to `group` in this configuration file.

Definition at line 154 of file kconfigbase.cpp.

References KEntry::bImmutable, getConfigState(), group(), lookupData(), and QString::utf8().

Referenced by KConfigGroup::groupIsImmutable().

bool KConfigBase::entryIsImmutable | ( | const QString & | key | ) | const

Checks whether it is possible to change the given entry.

Parameters:

  | key | the key to check

Returns:
  whether the entry `key` may be changed in the current group in this configuration file.

Definition at line 164 of file kconfigbase.cpp.

References KEntry::bImmutable, KEntryKey::bLocal, KEntryKey::c_key, getConfigState(), lookupData(), and mGroup.

KConfigBase::ConfigState KConfigBase::getConfigState | ( |  | ) | const

Returns the state of the app-config object.

Possible return values are NoAccess (the application-specific config file could not be opened neither read-write nor read-only), ReadOnly (the application-specific config file is opened read-only, but not read-write) and ReadWrite (the application-specific config file is opened read-write).

See also:
  ConfigState()

Returns:
  the state of the app-config object

Definition at line 1684 of file kconfigbase.cpp.

References backEnd, and KConfigBackEnd::getConfigState().

Referenced by entryIsImmutable(), groupIsImmutable(), and isImmutable().

bool KConfigBase::checkConfigFilesWritable | ( | bool | warnUser | ) |

Check whether the config files are writable.

Parameters:

  | warnUser | Warn the user if the configuration files are not writable.

Returns:
  Indicates that all of the configuration files used are writable.

Since:
  3.2

Definition at line 1839 of file kconfigbase.cpp.

References backEnd, and KConfigBackEnd::checkConfigFilesWritable().

void KConfigBase::setReadDefaults | ( | bool | b | ) |

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

This is off by default.

Since:
  3.2

Definition at line 1696 of file kconfigbase.cpp.

Referenced by KConfigGroup::KConfigGroup().

bool KConfigBase::readDefaults | ( |  | ) | const

Returns:
  true if all readEntry and readXXXEntry calls return the system wide (default) values instead of the user's preference.

Since:
  3.2

Definition at line 1707 of file kconfigbase.cpp.

Referenced by KConfigGroup::KConfigGroup(), and readEntry().

void KConfigBase::revertToDefault | ( | const QString & | key | ) |

Reverts the entry with key `key` in the current group in the application specific config file to either the system wide (default) value or the value specified in the global KDE config file.

To revert entries in the global KDE config file, the global KDE config file should be opened explicitly in a separate config object.

Parameters:

  | key | The key of the entry to revert.

Since:
  3.2

Definition at line 1712 of file kconfigbase.cpp.

References KEntry::bDeleted, KEntry::bDirty, QCString::isNull(), locale(), lookupData(), mGroup, KEntry::mValue, putData(), and setDirty().

bool KConfigBase::hasDefault | ( | const QString & | key | ) | const

Returns whether a default is specified for an entry in either the system wide configuration file or the global KDE config file.

If an application computes a default value at runtime for a certain entry, e.g. like:

     QColor computedDefault = kapp->palette().color(QPalette::Active, QColorGroup::Text)
     QColor color = config->readEntry(key, computedDefault);
     \encode

     Then it may wish to make the following check before
     writing back changes:
     \code
     if ( (value == computedDefault) && !config->hasDefault(key) )
        config->revertToDefault(key)
     else
        config->writeEntry(key, value)

This ensures that as long as the entry is not modified to differ from the computed default, the application will keep using the computed default and will follow changes the computed default makes over time.

Parameters:

  | key | The key of the entry to check.

Since:
  3.2

Definition at line 1739 of file kconfigbase.cpp.

References QCString::isNull(), locale(), lookupData(), mGroup, and KEntry::mValue.

void KConfigBase::setLocale | ( |  | ) | `[protected]`

Reads the locale and put in the configuration data struct.

Note that this should be done in the constructor, but this is not possible due to some mutual dependencies in KApplication::init()

Definition at line 62 of file kconfigbase.cpp.

References aLocaleString, backEnd, KLocale::defaultLanguage(), KLocale::language(), KGlobal::locale(), KConfigBackEnd::setLocaleString(), and QString::utf8().

Referenced by deleteEntry(), parseConfigFiles(), readEntry(), and writeEntry().

virtual void KConfigBase::setDirty | ( | bool | _bDirty = `true` | ) | `[inline, protected, virtual]`

Sets the global dirty flag of the config object.

Parameters:

  | _bDirty | How to mark the object's dirty status

Reimplemented in KConfigGroup.

Definition at line 1898 of file kconfigbase.h.

Referenced by deleteEntry(), deleteGroup(), revertToDefault(), KConfigGroup::setDirty(), and writeEntry().

void KConfigBase::parseConfigFiles | ( |  | ) | `[protected, virtual]`

| Parses all configuration files for a configuration object. The actual parsing is done by the associated KConfigBackEnd. Definition at line 1661 of file kconfigbase.cpp. References backEnd, KConfigBackEnd::getConfigState(), KConfigBackEnd::parseConfigFiles(), and setLocale(). Referenced by KConfig::reparseConfiguration().

virtual KEntryMap KConfigBase::internalEntryMap | ( | const QString & | pGroup | ) | const`[protected, pure virtual]`

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

This may or may not return all entries that belong to the config object. The only guarantee that you are given is that any entries that are dirty (i.e. modified and not yet written back to the disk) will be contained in the map. Some derivative classes may choose to return everything.

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.

Implemented in KConfig.

virtual KEntryMap KConfigBase::internalEntryMap | ( |  | ) | const`[protected, pure virtual]`

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

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

Returns:
  A map of the entries in the tree.

Implemented in KConfig.

Referenced by deleteGroup().

virtual void KConfigBase::putData | ( | const KEntryKey & | _key,
|  | const KEntry & | _data,
|  | bool | _checkGroup = `true`
| ) | `[protected, pure virtual]`

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

Classes that derive from KConfigBase will need to implement this method in a storage-specific manner.

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

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.

Implemented in KConfig, and KConfigGroup.

Referenced by deleteEntry(), deleteGroup(), KConfigINIBackEnd::parseSingleConfigFile(), KConfigGroup::putData(), revertToDefault(), and writeEntry().

virtual KEntry KConfigBase::lookupData | ( | const KEntryKey & | _key | ) | const`[protected, pure virtual]`

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

Classes that derive from KConfigBase will need to implement this method in a storage-specific manner.

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

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.

Implemented in KConfig, and KConfigGroup.

Referenced by entryIsImmutable(), groupIsImmutable(), hasDefault(), KConfigGroup::lookupData(), KConfigINIBackEnd::parseSingleConfigFile(), readEntry(), and revertToDefault().

void KConfigBase::setGroup | ( | const QCString & | pGroup | ) |

| Overloaded public methods:. Definition at line 92 of file kconfigbase.cpp. References group(), QString::isEmpty(), and mGroup.

## Member Data Documentation

KConfigBackEnd* KConfigBase::backEnd `[protected]`

| A back end for loading/saving to disk in a particular format. Definition at line 1975 of file kconfigbase.h. Referenced by checkConfigFilesWritable(), KConfig::copyTo(), getConfigState(), KConfigBase(), KConfigGroup::KConfigGroup(), parseConfigFiles(), setLocale(), and sync().

QCString KConfigBase::mGroup `[protected]`

| The currently selected group. Definition at line 1991 of file kconfigbase.h. Referenced by deleteEntry(), entryIsImmutable(), group(), hasDefault(), readEntry(), revertToDefault(), setDesktopGroup(), setGroup(), and writeEntry().

QCString KConfigBase::aLocaleString `[protected]`

| The locale to retrieve keys under if possible, i.e en_US or fr. Definition at line 1995 of file kconfigbase.h. Referenced by KConfigGroup::KConfigGroup(), locale(), and setLocale().

bool KConfigBase::bDirty `[protected]`

| Indicates whether there are any dirty entries in the config object that need to be written back to disk. Definition at line 2000 of file kconfigbase.h. Referenced by KConfigBase(), rollback(), and sync().

The documentation for this class was generated from the following files:

- kconfigbase.h
- kconfigbase.cpp

This file is part of the documentation for kdecore Library Version 3.4.1.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Sat Jun 11 20:18:28 2005 by doxygen 1.4.1 written by Dimitri van Heesch, © 1997-2003