KDECore

KConfigGroup Class Reference

#include <kconfiggroup.h>

Inheritance diagram for KConfigGroup:

Detailed Description

A class for one specific group in a KConfig object.

If you want to access the top-level entries of a KConfig object, which are not associated with any group, use an empty group name. A KConfigGroup can be read-only if it is constructed from a const config object or from another read-only group.

Definition at line 51 of file kconfiggroup.h.


Public Member Functions
	KConfigGroup ()
	KConfigGroup (KConfigBase *master, const QString &group)
	KConfigGroup (KConfigBase master, const char group)
	KConfigGroup (const KConfigBase *master, const QString &group)
	KConfigGroup (const KConfigBase master, const char group)
	KConfigGroup (const KSharedConfigPtr &master, const QString &group)
	KConfigGroup (const KSharedConfigPtr &master, const char *group)
	KConfigGroup (const KConfigGroup &)
KConfigGroup &	operator= (const KConfigGroup &)
	~KConfigGroup ()
bool	isValid () const
QString	name () const
bool	exists () const
void	sync ()
void	markAsClean ()
AccessMode	accessMode () const
KConfig *	config ()
const KConfig *	config () const
void	changeGroup (const QString &group)
void	changeGroup (const char *group)
QStringList	groupList () const
QStringList	keyList () const
void	deleteGroup (WriteConfigFlags pFlags=Normal)
template<typename T>
T	readEntry (const QString &key, const T &aDefault) const
template<typename T>
T	readEntry (const char *key, const T &aDefault) const
QVariant	readEntry (const QString &key, const QVariant &aDefault) const
QVariant	readEntry (const char *key, const QVariant &aDefault) const
QString	readEntry (const char *key, const QString &aDefault) const
QString	readEntry (const QString &key, const QString &aDefault) const
QString	readEntry (const QString &key, const char *aDefault=0) const
QString	readEntry (const char key, const char aDefault=0) const
QVariantList	readEntry (const QString &key, const QVariantList &aDefault) const
QVariantList	readEntry (const char *key, const QVariantList &aDefault) const
QStringList	readEntry (const QString &key, const QStringList &aDefault) const
QStringList	readEntry (const char *key, const QStringList &aDefault) const
template<typename T>
QList< T >	readEntry (const QString &key, const QList< T > &aDefault) const
template<typename T>
QList< T >	readEntry (const char *key, const QList< T > &aDefault) const
QStringList	readXdgListEntry (const QString &pKey, const QStringList &aDefault=QStringList()) const
QStringList	readXdgListEntry (const char *pKey, const QStringList &aDefault=QStringList()) const
QString	readPathEntry (const QString &pKey, const QString &aDefault) const
QString	readPathEntry (const char *key, const QString &aDefault) const
QStringList	readPathEntry (const QString &pKey, const QStringList &aDefault) const
QStringList	readPathEntry (const char *key, const QStringList &aDefault) const
QString	readEntryUntranslated (const QString &pKey, const QString &aDefault=QString()) const
QString	readEntryUntranslated (const char *key, const QString &aDefault=QString()) const
void	writeEntry (const QString &key, const QVariant &value, WriteConfigFlags pFlags=Normal)
void	writeEntry (const char *key, const QVariant &value, WriteConfigFlags pFlags=Normal)
void	writeEntry (const QString &key, const QString &value, WriteConfigFlags pFlags=Normal)
void	writeEntry (const char *key, const QString &value, WriteConfigFlags pFlags=Normal)
void	writeEntry (const QString &key, const QByteArray &value, WriteConfigFlags pFlags=Normal)
void	writeEntry (const char *key, const QByteArray &value, WriteConfigFlags pFlags=Normal)
void	writeEntry (const QString &key, const char *value, WriteConfigFlags pFlags=Normal)
void	writeEntry (const char key, const char value, WriteConfigFlags pFlags=Normal)
template<typename T>
void	writeEntry (const char *key, const T &value, WriteConfigFlags pFlags=Normal)
template<typename T>
void	writeEntry (const QString &key, const T &value, WriteConfigFlags pFlags=Normal)
void	writeEntry (const QString &key, const QStringList &value, WriteConfigFlags pFlags=Normal)
void	writeEntry (const char *key, const QStringList &value, WriteConfigFlags pFlags=Normal)
void	writeEntry (const QString &key, const QVariantList &value, WriteConfigFlags pFlags=Normal)
void	writeEntry (const char *key, const QVariantList &value, WriteConfigFlags pFlags=Normal)
template<typename T>
void	writeEntry (const QString &key, const QList< T > &value, WriteConfigFlags pFlags=Normal)
template<typename T>
void	writeEntry (const char *key, const QList< T > &value, WriteConfigFlags pFlags=Normal)
void	writeXdgListEntry (const QString &pKey, const QStringList &value, WriteConfigFlags pFlags=Normal)
void	writeXdgListEntry (const char *pKey, const QStringList &value, WriteConfigFlags pFlags=Normal)
void	writePathEntry (const QString &pKey, const QString &path, WriteConfigFlags pFlags=Normal)
void	writePathEntry (const char *pKey, const QString &path, WriteConfigFlags pFlags=Normal)
void	writePathEntry (const QString &pKey, const QStringList &value, WriteConfigFlags pFlags=Normal)
void	writePathEntry (const char *pKey, const QStringList &value, WriteConfigFlags pFlags=Normal)
void	deleteEntry (const QString &pKey, WriteConfigFlags pFlags=Normal)
void	deleteEntry (const char *pKey, WriteConfigFlags pFlags=Normal)
bool	hasKey (const QString &key) const
bool	hasKey (const char *key) const
bool	isImmutable () const
bool	isEntryImmutable (const QString &key) const
bool	isEntryImmutable (const char *key) const
void	revertToDefault (const QString &key)
void	revertToDefault (const char *key)
bool	hasDefault (const QString &key) const
bool	hasDefault (const char *key) const
QMap< QString, QString >	entryMap () const
Protected Member Functions
bool	hasGroupImpl (const QByteArray &group) const
KConfigGroup	groupImpl (const QByteArray &b)
const KConfigGroup	groupImpl (const QByteArray &b) const
void	deleteGroupImpl (const QByteArray &group, WriteConfigFlags flags)
bool	isGroupImmutableImpl (const QByteArray &aGroup) const
Friends
class	KConfigGroupPrivate
class	KServicePrivate

Constructor & Destructor Documentation

KConfigGroup::KConfigGroup ( )

Constructs a null group.

A null group is invalid.

See also:: isValid

Definition at line 511 of file kconfiggroup.cpp.

KConfigGroup::KConfigGroup	(	KConfigBase *	master,
		const QString &	group
	)

Construct a config group corresponding to group in master.

This allows to create subgroups, by passing an existing group as master.

group is the group name encoded in UTF-8.

Definition at line 537 of file kconfiggroup.cpp.

KConfigGroup::KConfigGroup	(	KConfigBase *	master,
		const char *	group
	)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Definition at line 542 of file kconfiggroup.cpp.

KConfigGroup::KConfigGroup	(	const KConfigBase *	master,
		const QString &	group
	)

Construct a read-only config group.

A read-only group will silently ignore any attempts to write to it.

This allows to create subgroups, by passing an existing group as master.

Definition at line 547 of file kconfiggroup.cpp.

KConfigGroup::KConfigGroup	(	const KConfigBase *	master,
		const char *	group
	)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Definition at line 552 of file kconfiggroup.cpp.

KConfigGroup::KConfigGroup	(	const KSharedConfigPtr &	master,
		const QString &	group
	)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Definition at line 557 of file kconfiggroup.cpp.

KConfigGroup::KConfigGroup	(	const KSharedConfigPtr &	master,
		const char *	group
	)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Definition at line 562 of file kconfiggroup.cpp.

KConfigGroup::KConfigGroup ( const KConfigGroup & rhs )

Definition at line 573 of file kconfiggroup.cpp.

KConfigGroup::~KConfigGroup ( )

Definition at line 578 of file kconfiggroup.cpp.

Member Function Documentation

KConfigGroup & KConfigGroup::operator= ( const KConfigGroup & rhs )

Definition at line 567 of file kconfiggroup.cpp.

bool KConfigGroup::isValid ( ) const

Returns true if the group is valid; otherwise returns false.

A group is invalid if it was constructed without arguments.

You should not call any functions on an invalid group.

Definition at line 515 of file kconfiggroup.cpp.

QString KConfigGroup::name ( ) const

The name of this group.

The root group is named "<default>".

Definition at line 632 of file kconfiggroup.cpp.

bool KConfigGroup::exists ( ) const

Check whether the containing KConfig object acutally contains a group with this name.

Definition at line 639 of file kconfiggroup.cpp.

void KConfigGroup::sync ( ) [virtual]

Reimplemented from superclass.

Implements KConfigBase.

Definition at line 646 of file kconfiggroup.cpp.

void KConfigGroup::markAsClean ( ) [virtual]

Reimplemented from superclass.

Implements KConfigBase.

Definition at line 1235 of file kconfiggroup.cpp.

KConfigGroup::AccessMode KConfigGroup::accessMode ( ) const [virtual]

Reimplemented from superclass.

Implements KConfigBase.

Definition at line 1242 of file kconfiggroup.cpp.

KConfig * KConfigGroup::config ( )

Return the config object that this group belongs to.

Definition at line 661 of file kconfiggroup.cpp.

const KConfig * KConfigGroup::config ( ) const

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Definition at line 668 of file kconfiggroup.cpp.

void KConfigGroup::changeGroup ( const QString & group )

Changes the group of the object.

This is a convenience function and should not be overused. Prefer another object for another group to avoid mixture of groups. A subgroup can only change to another subgroup of the parent.

Definition at line 618 of file kconfiggroup.cpp.

void KConfigGroup::changeGroup ( const char * group )

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Definition at line 623 of file kconfiggroup.cpp.

QStringList KConfigGroup::groupList ( ) const [virtual]

Reimplemented from superclass.

Implements KConfigBase.

Definition at line 1221 of file kconfiggroup.cpp.

QStringList KConfigGroup::keyList ( ) const

Returns a list of keys this group contains.

Definition at line 1228 of file kconfiggroup.cpp.

void KConfigGroup::deleteGroup ( WriteConfigFlags pFlags = Normal )

Delete all entries in the entire group.

Parameters:

pFlags

flags passed to KConfig::deleteGroup

Definition at line 610 of file kconfiggroup.cpp.

template<typename T>

T KConfigGroup::readEntry	(	const QString &	key,
		const T &	aDefault
	)			const `[inline]`

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

This template method makes it possible to write QString foo = readEntry("...", QString("default")); and the same with all other types supported by QVariant. The return type of the method is simply the same as the type of the default value.

Note:: readEntry("...", Qt::white) cannot compile because Qt::white is an enum. You must turn it into readEntry("...", QColor(Qt::white)).
Only the following QVariant types are allowed : String, StringList, List, Font, Point, Rect, Size, Color, Int, UInt, Bool, Double, LongLong, ULongLong, DateTime and Date.

Parameters:

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

Returns:: The value for this key, or aDefault.

Definition at line 186 of file kconfiggroup.h.

template<typename T>

T KConfigGroup::readEntry	(	const char *	key,
		const T &	aDefault
	)			const `[inline]`

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Definition at line 192 of file kconfiggroup.h.

QVariant KConfigGroup::readEntry	(	const QString &	key,
		const QVariant &	aDefault
	)			const

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

Parameters:

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

Returns:: The value for this key.

Note:: The return value will always have the same QVariant::Type as aDefault. This implies that the only possible return value for aDefault == QVariant() is QVariant().

Definition at line 767 of file kconfiggroup.cpp.

QVariant KConfigGroup::readEntry	(	const char *	key,
		const QVariant &	aDefault
	)			const

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Definition at line 752 of file kconfiggroup.cpp.

QString KConfigGroup::readEntry	(	const char *	key,
		const QString &	aDefault
	)			const

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

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

Parameters:

	key	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() if aDefault is null.

Definition at line 713 of file kconfiggroup.cpp.

QString KConfigGroup::readEntry	(	const QString &	key,
		const QString &	aDefault
	)			const

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Definition at line 731 of file kconfiggroup.cpp.

QString KConfigGroup::readEntry	(	const QString &	key,
		const char *	aDefault = `0`
	)			const

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

Parameters:

	key	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() if aDefault is null.

Definition at line 708 of file kconfiggroup.cpp.

QString KConfigGroup::readEntry	(	const char *	key,
		const char *	aDefault = `0`
	)			const

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Definition at line 703 of file kconfiggroup.cpp.

QVariantList KConfigGroup::readEntry	(	const QString &	key,
		const QVariantList &	aDefault
	)			const

Reads a list from the config object.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Warning:: This function doesn't convert the items returned to any type. It's actually a list of QVariant::String's. If you want the items converted to a specific type use readEntry(const char*, const QList<T>&) const

Definition at line 787 of file kconfiggroup.cpp.

QVariantList KConfigGroup::readEntry	(	const char *	key,
		const QVariantList &	aDefault
	)			const

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Definition at line 772 of file kconfiggroup.cpp.

QStringList KConfigGroup::readEntry	(	const QString &	key,
		const QStringList &	aDefault
	)			const

Reads a list of strings from the config object.

Parameters:

	key	The key to search for.
	aDefault	The default value to use if the key does not exist.

Returns:: The list. Contains aDefault if key does not exist.

Definition at line 747 of file kconfiggroup.cpp.

QStringList KConfigGroup::readEntry	(	const char *	key,
		const QStringList &	aDefault
	)			const

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Definition at line 736 of file kconfiggroup.cpp.

template<typename T>

QList<T> KConfigGroup::readEntry	(	const QString &	key,
		const QList< T > &	aDefault
	)			const `[inline]`

Reads a list of values from the config object.

Parameters:

	key	The key to search for.
	aDefault	The default value to use if the key does not exist.

Returns:: The list. Contains aDefault if key does not exist.

Definition at line 274 of file kconfiggroup.h.

template<typename T>

QList<T> KConfigGroup::readEntry	(	const char *	key,
		const QList< T > &	aDefault
	)			const `[inline]`

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Definition at line 280 of file kconfiggroup.h.

QStringList KConfigGroup::readXdgListEntry	(	const QString &	pKey,
		const QStringList &	aDefault = `QStringList()`
	)			const

Reads a list of strings from the config object, following XDG desktop entry spec separator semantics.

Parameters:

	pKey	The key to search for.
	aDefault	The default value to use if the key does not exist.

Returns:: The list. Contains aDefault if pKey does not exist.

Definition at line 792 of file kconfiggroup.cpp.

QStringList KConfigGroup::readXdgListEntry	(	const char *	pKey,
		const QStringList &	aDefault = `QStringList()`
	)			const

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Definition at line 797 of file kconfiggroup.cpp.

QString KConfigGroup::readPathEntry	(	const QString &	pKey,
		const QString &	aDefault
	)			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() if aDefault is null.

Definition at line 832 of file kconfiggroup.cpp.

QString KConfigGroup::readPathEntry	(	const char *	key,
		const QString &	aDefault
	)			const

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Definition at line 837 of file kconfiggroup.cpp.

QStringList KConfigGroup::readPathEntry	(	const QString &	pKey,
		const QStringList &	aDefault
	)			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.
	aDefault	A default value returned if the key was not found.

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

Definition at line 851 of file kconfiggroup.cpp.

QStringList KConfigGroup::readPathEntry	(	const char *	key,
		const QStringList &	aDefault
	)			const

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Definition at line 856 of file kconfiggroup.cpp.

QString KConfigGroup::readEntryUntranslated	(	const QString &	pKey,
		const QString &	aDefault = `QString()`
	)			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 688 of file kconfiggroup.cpp.

QString KConfigGroup::readEntryUntranslated	(	const char *	key,
		const QString &	aDefault = `QString()`
	)			const

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Definition at line 693 of file kconfiggroup.cpp.

void KConfigGroup::writeEntry	(	const QString &	key,
		const QVariant &	value,
		WriteConfigFlags	pFlags = `Normal`
	)

Writes a value to the config object.

Parameters:

	key	The key to write
	value	The value to write
	pFlags	The flags to use when writing this entry.

Definition at line 1088 of file kconfiggroup.cpp.

void KConfigGroup::writeEntry	(	const char *	key,
		const QVariant &	value,
		WriteConfigFlags	pFlags = `Normal`
	)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Definition at line 943 of file kconfiggroup.cpp.

void KConfigGroup::writeEntry	(	const QString &	key,
		const QString &	value,
		WriteConfigFlags	pFlags = `Normal`
	)

Writes a value to the config object.

Parameters:

	key	The key to write
	value	The value to write
	pFlags	The flags to use when writing this entry.

Definition at line 875 of file kconfiggroup.cpp.

void KConfigGroup::writeEntry	(	const char *	key,
		const QString &	value,
		WriteConfigFlags	pFlags = `Normal`
	)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Definition at line 867 of file kconfiggroup.cpp.

void KConfigGroup::writeEntry	(	const QString &	key,
		const QByteArray &	value,
		WriteConfigFlags	pFlags = `Normal`
	)

Writes a value to the config object.

Parameters:

	key	The key to write
	value	The value to write
	pFlags	The flags to use when writing this entry.

Definition at line 902 of file kconfiggroup.cpp.

void KConfigGroup::writeEntry	(	const char *	key,
		const QByteArray &	value,
		WriteConfigFlags	pFlags = `Normal`
	)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Definition at line 893 of file kconfiggroup.cpp.

void KConfigGroup::writeEntry	(	const QString &	key,
		const char *	value,
		WriteConfigFlags	pFlags = `Normal`
	)

Writes a value to the config object.

Parameters:

	key	The key to write
	value	The value to write
	pFlags	The flags to use when writing this entry.

Definition at line 880 of file kconfiggroup.cpp.

void KConfigGroup::writeEntry	(	const char *	key,
		const char *	value,
		WriteConfigFlags	pFlags = `Normal`
	)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Definition at line 888 of file kconfiggroup.cpp.

template<typename T>

void KConfigGroup::writeEntry	(	const char *	key,
		const T &	value,
		WriteConfigFlags	pFlags = `Normal`
	)			`[inline]`

Writes a value to the config object.

Parameters:

	key	The key to write
	value	The value to write
	pFlags	The flags to use when writing this entry.

Definition at line 412 of file kconfiggroup.h.

template<typename T>

void KConfigGroup::writeEntry	(	const QString &	key,
		const T &	value,
		WriteConfigFlags	pFlags = `Normal`
	)			`[inline]`

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Definition at line 419 of file kconfiggroup.h.

void KConfigGroup::writeEntry	(	const QString &	key,
		const QStringList &	value,
		WriteConfigFlags	pFlags = `Normal`
	)

writeEntry() overridden to accept a list of strings.

Parameters:

	key	The key to write
	value	The list to write
	pFlags	The flags to use when writing this entry.

See also:: writeEntry()

Definition at line 921 of file kconfiggroup.cpp.

void KConfigGroup::writeEntry ( const char *

KDECore

KConfigGroup Class Reference

Detailed Description

Public Member Functions

Protected Member Functions

Friends

Constructor & Destructor Documentation

Member Function Documentation