Plasma::ConfigLoader Class Reference

#include <configloader.h>

Inheritance diagram for Plasma::ConfigLoader:

[legend]

List of all members.

Public Member Functions
	ConfigLoader (const KConfigGroup *config, QIODevice *xml, QObject *parent=0)
	ConfigLoader (KSharedConfigPtr config, QIODevice *xml, QObject *parent=0)
	ConfigLoader (const QString &configFile, QIODevice *xml, QObject *parent=0)
	~ConfigLoader ()
KConfigSkeletonItem *	findItem (const QString &group, const QString &key)
KConfigSkeletonItem *	findItemByName (const QString &name)
QStringList	groupList () const
bool	hasGroup (const QString &group) const
QVariant	property (const QString &name)
Protected Member Functions
void	usrWriteConfig ()

---

Detailed Description

Definition at line 75 of file configloader.h.

---

Constructor & Destructor Documentation

ConfigLoader::ConfigLoader	(	const QString &	configFile,
		QIODevice *	xml,
		QObject *	parent = 0
	)

Creates a KConfigSkeleton populated using the definition found in the XML data passed in.

Parameters:

	configFile	path to the configuration file to use
	xml	the xml data; must be valid KConfigXT data
	parent	optional QObject parent

Definition at line 356 of file configloader.cpp.

ConfigLoader::ConfigLoader	(	KSharedConfigPtr	config,
		QIODevice *	xml,
		QObject *	parent = 0
	)

Creates a KConfigSkeleton populated using the definition found in the XML data passed in.

Parameters:

	config	the configuration object to use
	xml	the xml data; must be valid KConfigXT data
	parent	optional QObject parent

Definition at line 363 of file configloader.cpp.

ConfigLoader::ConfigLoader	(	const KConfigGroup *	config,
		QIODevice *	xml,
		QObject *	parent = 0
	)

Creates a KConfigSkeleton populated using the definition found in the XML data passed in.

Parameters:

	config	the group to use as the root for configuration items
	xml	the xml data; must be valid KConfigXT data
	parent	optional QObject parent

Definition at line 373 of file configloader.cpp.

ConfigLoader::~ConfigLoader

(

)

Definition at line 386 of file configloader.cpp.

---

Member Function Documentation

KConfigSkeletonItem * ConfigLoader::findItem	(	const QString &	group,
		const QString &	key
	)

Finds the item for the given group and key.

• group the group in the config file to look in
• key the configuration key to find

  Returns:

  the associated KConfigSkeletonItem, or 0 if none

Definition at line 391 of file configloader.cpp.

KConfigSkeletonItem * ConfigLoader::findItemByName

(

const QString &

name

)

Finds an item by its name.

Definition at line 396 of file configloader.cpp.

QStringList ConfigLoader::groupList

(

)

const

Returns:

the list of groups defined by the XML

Definition at line 417 of file configloader.cpp.

bool ConfigLoader::hasGroup

(

const QString &

group

)

const

Check to see if a group exists.

Parameters:

group

the name of the group to check for

Returns:

true if the group exists, or false if it does not

Definition at line 412 of file configloader.cpp.

QVariant ConfigLoader::property

(

const QString &

name

)

Returns the property (variantized value) of the named item.

Definition at line 401 of file configloader.cpp.

void ConfigLoader::usrWriteConfig

(

)

[protected]

Hack used to force writing when no default exists in config file.

Definition at line 422 of file configloader.cpp.

---

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

• configloader.h
• configloader.cpp