org.kde.koala

Class KConfigGroupSaver

public class KConfigGroupSaver extends Object implements QtSupport

Helper class to facilitate working with 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. KConfigGroup provides similar functionality in a more object oriented way.

Author: Matthias Kalle Dalheimer

See Also: KConfigBase KConfig KSimpleConfig KConfigGroup

UNKNOWN: Helper class for easier use of KConfig/KSimpleConfig groups.

Constructor Summary
protected KConfigGroupSaver(Class dummy)
KConfigGroupSaver(KConfigBase config, String group)
Constructor.
Method Summary
KConfigBaseconfig()
voiddispose()
Delete the wrapped C++ instance ahead of finalize()
protected voidfinalize()
Deletes the wrapped C++ instance
booleanisDisposed()
Has the wrapped C++ instance been deleted?

Constructor Detail

KConfigGroupSaver

protected KConfigGroupSaver(Class dummy)

KConfigGroupSaver

public KConfigGroupSaver(KConfigBase config, String group)
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.

UNKNOWN: Constructor.

Method Detail

config

public KConfigBase config()

dispose

public void dispose()
Delete the wrapped C++ instance ahead of finalize()

finalize

protected void finalize()
Deletes the wrapped C++ instance

isDisposed

public boolean isDisposed()
Has the wrapped C++ instance been deleted?