KSimpleConfig Class Reference

KDE Configuration entries. More...

#include <ksimpleconfig.h>

Inheritance diagram for KSimpleConfig:

[legend]

List of all members.

Public Member Functions
	KSimpleConfig (KConfigBackEnd *backEnd, bool bReadOnly=false)
	KSimpleConfig (const QString &fileName, bool bReadOnly=false)
virtual void	sync ()
virtual	~KSimpleConfig ()
Protected Member Functions
virtual void	virtual_hook (int id, void *data)

---

Detailed Description

KDE Configuration entries.

This is a trivial extension of KConfig for applications that need only one configuration file and no default system. A difference with KConfig is that when the data in memory is written back it is not merged with what is on disk. Whatever is in memory simply replaces what is on disk entirely.

Author:

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

See also:

KConfigBase KConfig KDE Configuration Management class with deletion ability

Definition at line 41 of file ksimpleconfig.h.

---

Constructor & Destructor Documentation

KSimpleConfig::KSimpleConfig	(	const QString &	fileName,
		bool	bReadOnly = false
	)

Construct a KSimpleConfig object and make it either read-write or read-only.

Parameters:

	fileName	The file used for saving the config data. Either a full path can be specified or just the filename. If only a filename is specified, the default directory for "config" files is used.
	bReadOnly	Whether the object should be read-only.

Definition at line 40 of file ksimpleconfig.cpp.

KSimpleConfig::KSimpleConfig	(	KConfigBackEnd *	backEnd,
		bool	bReadOnly = false
	)

Definition at line 55 of file ksimpleconfig.cpp.

KSimpleConfig::~KSimpleConfig

(

)

[virtual]

Destructor.

Writes back any dirty configuration entries.

Definition at line 59 of file ksimpleconfig.cpp.

---

Member Function Documentation

void KSimpleConfig::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 from KConfigBase.

Definition at line 68 of file ksimpleconfig.cpp.

void KSimpleConfig::virtual_hook	(	int	id,
		void *	data
	)			[protected, virtual]

Reimplemented from KConfig.

Definition at line 78 of file ksimpleconfig.cpp.

---

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

• ksimpleconfig.h
• ksimpleconfig.cpp