KConfigBase Class Reference

Abstract base class for KDE configuration entries. KDE Configuration Management abstract base class. More...

#include <kconfigbase.h>

Inheritance diagram for KConfigBase:

[legend]Collaboration diagram for KConfigBase:


Public Types
enum	ConfigState { NoAccess, ReadOnly, ReadWrite }
	Possible return values for getConfigState(). More...
Public Member Functions
	KConfigBase ()
	Construct a KConfigBase object.
virtual	~KConfigBase ()
	Destructs the KConfigBase object.
void	setGroup (const QString &group)
	Specifies the group in which keys will be read and written.
void	setDesktopGroup ()
	Sets the group to the "Desktop Entry" group used for desktop configuration files for applications, mime types, etc.
QString	group () const
	Returns the name of the group in which we are searching for keys and from which we are retrieving entries.
bool	hasGroup (const QString &group) const
	Returns true if the specified group is known about.
virtual QStringList	groupList () const =0
	Returns a list of groups that are known about.
QString	locale () const
	Returns a the current locale.
QString	readEntry (const QString &pKey, const QString &aDefault=QString::null) const
	Reads the value of an entry specified by `pKey` in the current group.
QString	readEntry (const char *pKey, const QString &aDefault=QString::null) const
	Reads the value of an entry specified by `pKey` in the current group.
QVariant	readPropertyEntry (const QString &pKey, QVariant::Type) const
	Reads the value of an entry specified by `pKey` in the current group.
QVariant	readPropertyEntry (const char *pKey, QVariant::Type) const
	Reads the value of an entry specified by `pKey` in the current group.
QVariant	readPropertyEntry (const QString &pKey, const QVariant &adefault) const
	Reads the value of an entry specified by `pKey` in the current group.
QVariant	readPropertyEntry (const char *pKey, const QVariant &aDefault) const
	Reads the value of an entry specified by `pKey` in the current group.
int	readListEntry (const QString &pKey, QStrList &list, char sep= ',') const
	Reads a list of strings.
int	readListEntry (const char *pKey, QStrList &list, char sep= ',') const
	Reads a list of strings.
QStringList	readListEntry (const QString &pKey, char sep= ',') const
	Reads a list of strings.
QStringList	readListEntry (const char *pKey, char sep= ',') const
	Reads a list of strings.
QValueList< int >	readIntListEntry (const QString &pKey) const
	Reads a list of Integers.
QValueList< int >	readIntListEntry (const char *pKey) const
	Reads a list of Integers.
QString	readPathEntry (const QString &pKey, const QString &aDefault=QString::null) const
	Reads a path.
QString	readPathEntry (const char *pKey, const QString &aDefault=QString::null) const
	Reads a path.
QStringList	readPathListEntry (const QString &pKey, char sep= ',') const
	Reads a list of string paths.
QStringList	readPathListEntry (const char *pKey, char sep= ',') const
	Reads a list of string paths.
int	readNumEntry (const QString &pKey, int nDefault=0) const
	Reads a numerical value.
int	readNumEntry (const char *pKey, int nDefault=0) const
	Reads a numerical value.
unsigned int	readUnsignedNumEntry (const QString &pKey, unsigned int nDefault=0) const
	Reads an unsigned numerical value.
unsigned int	readUnsignedNumEntry (const char *pKey, unsigned int nDefault=0) const
	Reads an unsigned numerical value.
long	readLongNumEntry (const QString &pKey, long nDefault=0) const
	Reads a numerical value.
long	readLongNumEntry (const char *pKey, long nDefault=0) const
	Reads a numerical value.
unsigned long	readUnsignedLongNumEntry (const QString &pKey, unsigned long nDefault=0) const
	Read an unsigned numerical value.
unsigned long	readUnsignedLongNumEntry (const char *pKey, unsigned long nDefault=0) const
	Read an unsigned numerical value.
double	readDoubleNumEntry (const QString &pKey, double nDefault=0.0) const
	Reads a floating point value.
double	readDoubleNumEntry (const char *pKey, double nDefault=0.0) const
	Reads a floating point value.
QFont	readFontEntry (const QString &pKey, const QFont *pDefault=0L) const
	Reads a QFont value.
QFont	readFontEntry (const char pKey, const QFont pDefault=0L) const
	Reads a QFont value.
bool	readBoolEntry (const QString &pKey, const bool bDefault=false) const
	Reads a boolean entry.
bool	readBoolEntry (const char *pKey, const bool bDefault=false) const
	Reads a boolean entry.
QRect	readRectEntry (const QString &pKey, const QRect *pDefault=0L) const
	Reads a QRect entry.
QRect	readRectEntry (const char pKey, const QRect pDefault=0L) const
	Reads a QRect entry.
QPoint	readPointEntry (const QString &pKey, const QPoint *pDefault=0L) const
	Reads a QPoint entry.
QPoint	readPointEntry (const char pKey, const QPoint pDefault=0L) const
	Reads a QPoint entry.
QSize	readSizeEntry (const QString &pKey, const QSize *pDefault=0L) const
	Reads a QSize entry.
QSize	readSizeEntry (const char pKey, const QSize pDefault=0L) const
	Reads a QSize entry.
QColor	readColorEntry (const QString &pKey, const QColor *pDefault=0L) const
	Reads a QColor entry.
QColor	readColorEntry (const char pKey, const QColor pDefault=0L) const
	Reads a QColor entry.
QDateTime	readDateTimeEntry (const QString &pKey, const QDateTime *pDefault=0L) const
	Reads a QDateTime entry.
QDateTime	readDateTimeEntry (const char pKey, const QDateTime pDefault=0L) const
	Reads a QDateTime entry.
QString	readEntryUntranslated (const QString &pKey, const QString &aDefault=QString::null) const
	Reads the value of an entry specified by `pKey` in the current group.
QString	readEntryUntranslated (const char *pKey, const QString &aDefault=QString::null) const
	Reads the value of an entry specified by `pKey` in the current group.
void	writeEntry (const QString &pKey, const QString &pValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)
	Writes a key/value pair.
void	writeEntry (const char *pKey, const QString &pValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)
	Writes a key/value pair.
void	writeEntry (const QString &pKey, const QVariant &rValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)
	writeEntry() Overridden to accept a property.
void	writeEntry (const char *pKey, const QVariant &rValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)
	writeEntry() Overridden to accept a property.
void	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.
void	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.
void	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.
void	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.
void	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.
void	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.
void	writeEntry (const QString &pKey, const char *pValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)
	Write a (key/value) pair.
void	writeEntry (const char pKey, const char pValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)
	Write a (key/value) pair.
void	writeEntry (const QString &pKey, int nValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)
	Write a (key/value) pair.
void	writeEntry (const char *pKey, int nValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)
	Write a (key/value) pair.
void	writeEntry (const QString &pKey, unsigned int nValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)
	Writes a (key/value) pair.
void	writeEntry (const char *pKey, unsigned int nValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)
	Writes a (key/value) pair.
void	writeEntry (const QString &pKey, long nValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)
	Writes a (key/value) pair.
void	writeEntry (const char *pKey, long nValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)
	Writes a (key/value) pair.
void	writeEntry (const QString &pKey, unsigned long nValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)
	Writes a (key/value) pair.
void	writeEntry (const char *pKey, unsigned long nValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)
	Writes a (key/value) pair.
void	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.
void	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.
void	writeEntry (const QString &pKey, bool bValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)
	Writes a (key/value) pair.
void	writeEntry (const char *pKey, bool bValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)
	Writes a (key/value) pair.
void	writeEntry (const QString &pKey, const QFont &rFont, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)
	Writes a (key/value) pair.
void	writeEntry (const char *pKey, const QFont &rFont, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)
	Writes a (key/value) pair.
void	writeEntry (const QString &pKey, const QColor &rColor, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)
	Writes a (key/value) pair.
void	writeEntry (const char *pKey, const QColor &rColor, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)
	Writes a (key/value) pair.
void	writeEntry (const QString &pKey, const QDateTime &rDateTime, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)
	Writes a (key/value) pair.
void	writeEntry (const char *pKey, const QDateTime &rDateTime, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)
	Writes a (key/value) pair.
void	writeEntry (const QString &pKey, const QRect &rValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)
	Writes a (key/value) pair.
void	writeEntry (const char *pKey, const QRect &rValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)
	Writes a (key/value) pair.
void	writeEntry (const QString &pKey, const QPoint &rValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)
	Writes a (key/value) pair.
void	writeEntry (const char *pKey, const QPoint &rValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)
	Writes a (key/value) pair.
void	writeEntry (const QString &pKey, const QSize &rValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)
	Writes a (key/value) pair.
void	writeEntry (const char *pKey, const QSize &rValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)
	Writes a (key/value) pair.
void	writePathEntry (const QString &pKey, const QString &path, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)
	Writes a file path.
void	writePathEntry (const char *pKey, const QString &path, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)
	Writes a file path.
void	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).
void	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).
void	deleteEntry (const QString &pKey, bool bNLS=false, bool bGlobal=false)
	Deletes the entry specified by `pKey` in the current group.
void	deleteEntry (const char *pKey, bool bNLS=false, bool bGlobal=false)
	Deletes the entry specified by `pKey` in the current group.
bool	deleteGroup (const QString &group, bool bDeep=true, bool bGlobal=false)
	Deletes a configuration entry group.
void	setDollarExpansion (bool _bExpand=true)
	Turns on or off "dollar expansion" (see KConfigBase introduction) when reading config entries.
bool	isDollarExpansion () const
	Returns whether dollar expansion is on or off.
virtual void	rollback (bool bDeep=true)
	Mark the config object as "clean," i.e.
virtual void	sync ()
	Flushes all changes that currently reside only in memory back to disk / permanent storage.
bool	isDirty () const
	Checks whether the config file has any dirty (modified) entries.
virtual void	setReadOnly (bool _ro)
	Sets the config object's read-only status.
bool	isReadOnly () const
	Returns the read-only status of the config object.
bool	hasKey (const QString &key) const
	Checks whether the key has an entry in the currently active group.
virtual QMap< QString, QString >	entryMap (const QString &group) const =0
	Returns a map (tree) of entries for all entries in a particular group.
virtual void	reparseConfiguration ()=0
	Reparses all configuration files.
bool	isImmutable () const
	Checks whether this configuration file can be modified.
bool	groupIsImmutable (const QString &group) const
	Checks whether it is possible to change the given group.
bool	entryIsImmutable (const QString &key) const
	Checks whether it is possible to change the given entry.
ConfigState	getConfigState () const
	Returns the state of the app-config object.
void	setGroup (const QCString &pGroup)
	Overloaded public methods:.
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 ()
	Reads the locale and put in the configuration data struct.
virtual void	setDirty (bool _bDirty=true)
	Sets the global dirty flag of the config object.
virtual void	parseConfigFiles ()
	Parses all configuration files for a configuration object.
virtual KEntryMap	internalEntryMap (const QString &pGroup) const =0
	Returns a map (tree) of the entries in the specified group.
virtual KEntryMap	internalEntryMap () const =0
	Returns a map (tree) of the entries in the tree.
virtual void	putData (const KEntryKey &_key, const KEntry &_data, bool _checkGroup=true)=0
	Inserts a (key/value) pair into the internal storage mechanism of the configuration object.
virtual KEntry	lookupData (const KEntryKey &_key) const =0
	Looks up an entry in the config object's internal structure.
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
	A back end for loading/saving to disk in a particular format.
QCString	mGroup
	The currently selected group.
QCString	aLocaleString
	The locale to retrieve keys under if possible, i.e en_US or fr.
bool	bDirty
	Indicates whether there are any dirty entries in the config object that need to be written back to disk.
bool	bLocaleInitialized
bool	bReadOnly
bool	bExpand
Friends
class	KConfigINIBackEnd
class	KConfigGroup

Detailed Description

Abstract base class for KDE configuration entries. 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 group name.

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

Version:

Id: kconfigbase.h,v 1.83.2.1 2003/06/22 21:39:31 deller Exp

See also:: KGlobal::config() KConfig KSimpleConfig

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 1661 of file kconfigbase.h.
Referenced by getConfigState(), and KConfigBackEnd::getConfigState().

Constructor & Destructor Documentation

KConfigBase::KConfigBase ( )

Construct a KConfigBase object.

Definition at line 123 of file kconfigbase.cpp.
References setGroup().

KConfigBase::~KConfigBase ( ) [virtual]

Destructs the KConfigBase object.

Definition at line 130 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 aplied 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 151 of file kconfigbase.cpp.
References mGroup.
Referenced by KStandardDirs::addCustomized(), KConfig::checkUpdate(), KInstance::config(), KNotifyClient::getDefaultFile(), KNotifyClient::getDefaultPresentation(), KNotifyClient::getFile(), KNotifyClient::getPresentation(), KIconEffect::init(), KApplication::invokeMailer(), KConfigBase(), KConfigGroupSaver::KConfigGroupSaver(), KIconTheme::KIconTheme(), KLocale::languagesTwoAlpha(), KDesktopFile::setActionGroup(), and KLocale::twoAlphaToCountryName().

void KConfigBase::setDesktopGroup ( )

Sets the group to the "Desktop Entry" group used for desktop configuration files for applications, mime types, etc.

Definition at line 176 of file kconfigbase.cpp.
References mGroup.
Referenced by 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 172 of file kconfigbase.cpp.
References QString::fromUtf8(), and mGroup.
Referenced by KStandardDirs::addCustomized(), KConfig::checkUpdate(), and KConfig::groupList().

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

Returns true if the specified group is known about.

Parameters:

group The group to search for.

Returns:
Whether the group exists.

Definition at line 205 of file kconfigbase.cpp.
Referenced by KDesktopFile::hasActionGroup(), KShortcutList::readSettings(), and KShortcutList::writeSettings().

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 146 of file kconfigbase.cpp.
References aLocaleString, and QString::fromUtf8().

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.

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 it null.

Definition at line 274 of file kconfigbase.cpp.
References QString::utf8().
Referenced by KGlobalSettings::contextMenuKey(), KIconTheme::current(), KDesktopFile::hasApplicationType(), KDesktopFile::hasDeviceType(), KDesktopFile::hasLinkType(), KDesktopFile::hasMimeTypeType(), KIconEffect::init(), KIconTheme::KIconTheme(), KGlobalSettings::mouseSettings(), readColorEntry(), KDesktopFile::readComment(), KDesktopFile::readDevice(), readFontEntry(), KDesktopFile::readGenericName(), KDesktopFile::readIcon(), readListEntry(), KDesktopFile::readName(), readPathEntry(), readPropertyEntry(), KShortcutList::readSettings(), KDesktopFile::readType(), KDesktopFile::tryExec(), KLocale::twoAlphaToCountryName(), and KShortcutList::writeSettings().

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 it null.

Definition at line 280 of file kconfigbase.cpp.
References QString::ascii(), KEntry::bExpand, KEntryKey::bLocal, KEntryKey::c_key, QFile::encodeName(), QString::find(), QString::fromLocal8Bit(), QString::fromUtf8(), QString::isEmpty(), QString::isNull(), QCString::isNull(), QString::length(), lookupData(), mGroup, QString::mid(), KEntry::mValue, QTextStream::read(), 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. This class or method is obsolete, it is provided for compatibility only.

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 418 of file kconfigbase.cpp.
References QString::utf8().
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.
This class or method is obsolete, it is provided for compatibility only.

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 424 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 433 of file kconfigbase.cpp.
References readPropertyEntry(), and QString::utf8().

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 439 of file kconfigbase.cpp.
References QValueList::append(), QVariant::asColor(), QVariant::asDateTime(), QVariant::asFont(), QVariant::asPoint(), QVariant::asRect(), QVariant::asSize(), QDateTime::date(), KStdAccel::end(), hasKey(), readBoolEntry(), readColorEntry(), readDateTimeEntry(), readDoubleNumEntry(), readEntry(), readFontEntry(), readListEntry(), readNumEntry(), readPointEntry(), readRectEntry(), readSizeEntry(), readUnsignedNumEntry(), QVariant::toBool(), QVariant::toDouble(), QVariant::toInt(), QVariant::toString(), QVariant::toUInt(), and QVariant::type().

int KConfigBase::readListEntry ( const QString & pKey,

QStrList & list,

char sep = ','

) const

Reads a list of strings.
This class or method is obsolete, it is provided for compatibility only.

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 514 of file kconfigbase.cpp.
References QString::utf8().
Referenced by KStandardDirs::addCustomized(), 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.
This class or method is obsolete, it is provided for compatibility only.

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 520 of file kconfigbase.cpp.
References 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 558 of file kconfigbase.cpp.
References readListEntry(), and QString::utf8().

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 563 of file kconfigbase.cpp.
References hasKey(), QString::isEmpty(), QString::length(), readEntry(), and QString::truncate().

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 594 of file kconfigbase.cpp.
References QString::utf8().
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 599 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 611 of file kconfigbase.cpp.
References QString::utf8().
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 616 of file kconfigbase.cpp.
References readEntry().

kdecore Library API Documentation

KConfigBase Class Reference

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation