summaryrefslogtreecommitdiffabout
path: root/microkde/kdecore/kconfigbase.h
Unidiff
Diffstat (limited to 'microkde/kdecore/kconfigbase.h') (more/less context) (show whitespace changes)
-rw-r--r--microkde/kdecore/kconfigbase.h4
1 files changed, 3 insertions, 1 deletions
diff --git a/microkde/kdecore/kconfigbase.h b/microkde/kdecore/kconfigbase.h
index 7e56d11..1ef6a04 100644
--- a/microkde/kdecore/kconfigbase.h
+++ b/microkde/kdecore/kconfigbase.h
@@ -5,48 +5,50 @@
5 Copyright (c) 2001 Waldo Bastian <bastian@kde.org> 5 Copyright (c) 2001 Waldo Bastian <bastian@kde.org>
6 6
7 This library is free software; you can redistribute it and/or 7 This library is free software; you can redistribute it and/or
8 modify it under the terms of the GNU Library General Public 8 modify it under the terms of the GNU Library General Public
9 License as published by the Free Software Foundation; either 9 License as published by the Free Software Foundation; either
10 version 2 of the License, or (at your option) any later version. 10 version 2 of the License, or (at your option) any later version.
11 11
12 This library is distributed in the hope that it will be useful, 12 This library is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of 13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 Library General Public License for more details. 15 Library General Public License for more details.
16 16
17 You should have received a copy of the GNU Library General Public License 17 You should have received a copy of the GNU Library General Public License
18 along with this library; see the file COPYING.LIB. If not, write to 18 along with this library; see the file COPYING.LIB. If not, write to
19 the Free Software Foundation, Inc., 59 Temple Place - Suite 330, 19 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20 Boston, MA 02111-1307, USA. 20 Boston, MA 02111-1307, USA.
21*/ 21*/
22 22
23// $Id$ 23// $Id$
24 24
25#ifndef _KCONFIGBASE_H 25#ifndef _KCONFIGBASE_H
26#define _KCONFIGBASE_H 26#define _KCONFIGBASE_H
27 27
28#include "kconfig.h" 28#include "kconfig.h"
29//Added by qt3to4:
30#include <Q3CString>
29 31
30/** 32/**
31 * Helper class to facilitate working with @ref KConfig / @ref KSimpleConfig 33 * Helper class to facilitate working with @ref KConfig / @ref KSimpleConfig
32 * groups. 34 * groups.
33 * 35 *
34 * Careful programmers always set the group of a 36 * Careful programmers always set the group of a
35 * @ref KConfig @ref KSimpleConfig object to the group they want to read from 37 * @ref KConfig @ref KSimpleConfig object to the group they want to read from
36 * and set it back to the old one of afterwards. This is usually 38 * and set it back to the old one of afterwards. This is usually
37 * written as: 39 * written as:
38 * <pre> 40 * <pre>
39 * 41 *
40 * QString oldgroup config->group(); 42 * QString oldgroup config->group();
41 * config->setGroup( "TheGroupThatIWant" ); 43 * config->setGroup( "TheGroupThatIWant" );
42 * ... 44 * ...
43 * config->writeEntry( "Blah", "Blubb" ); 45 * config->writeEntry( "Blah", "Blubb" );
44 * 46 *
45 * config->setGroup( oldgroup ); 47 * config->setGroup( oldgroup );
46 * </pre> 48 * </pre>
47 * 49 *
48 * In order to facilitate this task, you can use 50 * In order to facilitate this task, you can use
49 * KConfigGroupSaver. Simply construct such an object ON THE STACK 51 * KConfigGroupSaver. Simply construct such an object ON THE STACK
50 * when you want to switch to a new group. Then, when the object goes 52 * when you want to switch to a new group. Then, when the object goes
51 * out of scope, the group will automatically be restored. If you 53 * out of scope, the group will automatically be restored. If you
52 * want to use several different groups within a function or method, 54 * want to use several different groups within a function or method,
@@ -61,42 +63,42 @@
61 */ 63 */
62//US I converted the class in a way that it can be used with KConfig objects of microkde 64//US I converted the class in a way that it can be used with KConfig objects of microkde
63 65
64class KConfigGroupSaver 66class KConfigGroupSaver
65{ 67{
66public: 68public:
67 /** 69 /**
68 * Constructor. You pass a pointer to the KConfigBase-derived 70 * Constructor. You pass a pointer to the KConfigBase-derived
69 * object you want to work with and a string indicating the _new_ 71 * object you want to work with and a string indicating the _new_
70 * group. 72 * group.
71 * 73 *
72 * @param config The KConfigBase-derived object this 74 * @param config The KConfigBase-derived object this
73 * KConfigGroupSaver works on. 75 * KConfigGroupSaver works on.
74 * @param group The new group that the config object should switch to. 76 * @param group The new group that the config object should switch to.
75 */ 77 */
76 KConfigGroupSaver( KConfig* config, QString group ) 78 KConfigGroupSaver( KConfig* config, QString group )
77 /* KDE 4 : make the second parameter const QString & */ 79 /* KDE 4 : make the second parameter const QString & */
78 : _config(config), _oldgroup(config->group()) 80 : _config(config), _oldgroup(config->group())
79 { _config->setGroup( group ); } 81 { _config->setGroup( group ); }
80 82
81 KConfigGroupSaver( KConfig* config, const char *group ) 83 KConfigGroupSaver( KConfig* config, const char *group )
82 : _config(config), _oldgroup(config->group()) 84 : _config(config), _oldgroup(config->group())
83 { _config->setGroup( group ); } 85 { _config->setGroup( group ); }
84 86
85 KConfigGroupSaver( KConfig* config, const QCString &group ) 87 KConfigGroupSaver( KConfig* config, const Q3CString &group )
86 : _config(config), _oldgroup(config->group()) 88 : _config(config), _oldgroup(config->group())
87 { _config->setGroup( group ); } 89 { _config->setGroup( group ); }
88 90
89 ~KConfigGroupSaver() { _config->setGroup( _oldgroup ); } 91 ~KConfigGroupSaver() { _config->setGroup( _oldgroup ); }
90 92
91 KConfig* config() { return _config; }; 93 KConfig* config() { return _config; };
92 94
93private: 95private:
94 KConfig* _config; 96 KConfig* _config;
95 QString _oldgroup; 97 QString _oldgroup;
96 98
97 KConfigGroupSaver(const KConfigGroupSaver&); 99 KConfigGroupSaver(const KConfigGroupSaver&);
98 KConfigGroupSaver& operator=(const KConfigGroupSaver&); 100 KConfigGroupSaver& operator=(const KConfigGroupSaver&);
99 101
100}; 102};
101 103
102#endif 104#endif