Main Page   Class Hierarchy   Compound List   File List   Compound Members  

config::KConfigGroupSaver Class Reference

Helper class to facilitate working with KConfig / KSimpleConfig groups. Helper class for easier use of KConfig/KSimpleConfig groups. More...

#include <kconfigbase.h>

List of all members.

Public Methods

 KConfigGroupSaver (KConfigBase *config, string group)
 Constructor. More...

 KConfigGroupSaver (KConfigBase *config, const char *group)
 KConfigGroupSaver (KConfigBase *config, const string &group)
 ~KConfigGroupSaver ()
KConfigBaseconfig ()


Detailed Description

Helper class to facilitate working with KConfig / KSimpleConfig groups. Helper class for easier use of KConfig/KSimpleConfig groups.

Careful programmers always set the group of a KConfig KSimpleConfig object to the group they want to read from and set it back to the old one of afterwards. This is usually written as:


 string oldgroup config->group();
 config->setGroup( "TheGroupThatIWant" );
 ...
 config->writeEntry( "Blah", "Blubb" );

 config->setGroup( oldgroup );
 

In order to facilitate this task, you can use KConfigGroupSaver. Simply construct such an object ON THE STACK when you want to switch to a new group. Then, when the object goes out of scope, the group will automatically be restored. If you want to use several different groups within a function or method, you can still use KConfigGroupSaver: Simply enclose all work with one group (including the creation of the KConfigGroupSaver object) in one block.

Author:
Matthias Kalle Dalheimer <kalle@kde.org>
Version:
Id:
kconfigbase.h,v 1.1.1.1 2002/12/01 04:08:23 zl Exp
See also:
KConfigBase, KConfig, KSimpleConfig


Constructor & Destructor Documentation

config::KConfigGroupSaver::KConfigGroupSaver KConfigBase   config,
string    group
[inline]
 

Constructor.

You pass a pointer to the KConfigBase-derived object you want to work with and a string indicating the _new_ group.

Parameters:
config  The KConfigBase-derived object this KConfigGroupSaver works on.
group  The new group that the config object should switch to.


The documentation for this class was generated from the following file:
Generated on Sat Dec 14 20:05:53 2002 for libconfig by doxygen1.2.14 written by Dimitri van Heesch, © 1997-2002