config

KConfigGroupSaver(3)        Library Functions Manual        KConfigGroupSaver(3)



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


SYNOPSIS
       #include <kconfigbase.h>

   Public Member Functions
       KConfigGroupSaver (KConfigBase *config, QString group)
           Constructor.
       KConfigGroupSaver (KConfigBase *config, const  char *group)
       KConfigGroupSaver (KConfigBase *config, const  QCString &group)
       KConfigBase * config ()

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:

        QString 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.RS 4
           kconfigbase.h,v 1.83.2.1 2003/06/22 21:39:31 deller Exp

       See also:
           KConfigBase, KConfig, KSimpleConfig

       Definition at line 1840 of file kconfigbase.h.

Constructor & Destructor Documentation
   KConfigGroupSaver::KConfigGroupSaver (KConfigBase * config, QString 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.

       Definition at line 1851 of file kconfigbase.h.

       References KConfigBase::setGroup().


Author
       Generated automatically by Doxygen for kdecore Library from the source
       code.




kdecore Library                    28 Jan 2004              KConfigGroupSaver(3)