1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
|
/*
This file is part of the KDE libraries
SPDX-FileCopyrightText: 2006, 2007 Thomas Braxton <kde.braxton@gmail.com>
SPDX-FileCopyrightText: 2001 Waldo Bastian <bastian@kde.org>
SPDX-FileCopyrightText: 1999 Preston Brown <pbrown@kde.org>
SPDX-FileCopyrightText: 1997 Matthias Kalle Dalheimer <kalle@kde.org>
SPDX-License-Identifier: LGPL-2.0-or-later
*/
#ifndef KCONFIGBASE_H
#define KCONFIGBASE_H
#include <kconfigcore_export.h>
#include <QStringList>
#include <QtGlobal>
class KConfigGroup;
class KConfigBasePrivate;
/**
* \class KConfigBase kconfigbase.h <KConfigBase>
* \brief Interface to interact with configuration.
*
* KConfigBase allows a component of an application to persists its configuration
* without the component knowing if it is storing the configuration into a top
* level KConfig or a KConfigGroup inside a KConfig instance.
*/
class KCONFIGCORE_EXPORT KConfigBase
{
public:
/**
* Flags to control write entry
* @see WriteConfigFlags
*/
enum WriteConfigFlag {
Persistent = 0x01,
/**<
* Save this entry when saving the config object.
*/
Global = 0x02,
/**<
* Save the entry to the global %KDE config file instead of the
* application specific config file.
*/
Localized = 0x04,
/**<
* Add the locale tag to the key when writing it.
*/
Notify = 0x08 | Persistent,
/**<
* Notify remote KConfigWatchers of changes (requires DBus support)
* Implied persistent
* @since 5.51
*/
Normal = Persistent
/**<
* Save the entry to the application specific config file without
* a locale tag. This is the default.
*/
};
/**
* Stores a combination of #WriteConfigFlag values.
*/
Q_DECLARE_FLAGS(WriteConfigFlags, WriteConfigFlag)
/**
* Destructs the KConfigBase object.
*/
virtual ~KConfigBase();
/**
* Returns a list of groups that are known about.
*
* @return The list of groups.
**/
virtual QStringList groupList() const = 0;
/**
* Returns true if the specified group is known about.
*
* @param group name of group to search for
* @return true if the group exists.
*/
bool hasGroup(const QString &group) const;
/**
* Overload for hasGroup(const QString&) const
*
* @param group name of group to search for, encoded in UTF-8
*/
bool hasGroup(const char *group) const;
/**
* Overload for hasGroup(const QString&) const
*
* @param group name of group to search for, encoded in UTF-8
*/
bool hasGroup(const QByteArray &group) const;
/**
* Returns an object for the named subgroup.
*
* @param group the group to open. Pass an empty string here to the KConfig
* object to obtain a handle on the root group.
* @return config group object for the given group name.
*/
KConfigGroup group(const QString &group);
/**
* Overload for group(const QString&)
*
* @param group name of group, encoded in UTF-8
*/
KConfigGroup group(const QByteArray &group);
/**
* Overload for group(const QString&)
*
* @param group name of group, encoded in UTF-8
*/
KConfigGroup group(const char *group);
/**
* Const overload for group(const QString&)
*/
const KConfigGroup group(const QString &group) const;
/**
* Const overload for group(const QString&)
*
* @param group name of group, encoded in UTF-8
*/
const KConfigGroup group(const QByteArray &group) const;
/**
* Const overload for group(const QString&)
*
* @param group name of group, encoded in UTF-8
*/
const KConfigGroup group(const char *group) const;
/**
* Delete @p group.
* This marks @p group as @em deleted in the config object. This effectively
* removes any cascaded values from config files earlier in the stack.
*/
void deleteGroup(const QString &group, WriteConfigFlags flags = Normal);
/**
* Overload for deleteGroup(const QString&, WriteConfigFlags)
*
* @param group name of group to delete, encoded in UTF-8
*/
void deleteGroup(const QByteArray &group, WriteConfigFlags flags = Normal);
/**
* Overload for deleteGroup(const QString&, WriteConfigFlags)
*
* @param group name of group to delete, encoded in UTF-8
*/
void deleteGroup(const char *group, WriteConfigFlags flags = Normal);
/**
* Syncs the configuration object that this group belongs to.
* Unrelated concurrent changes to the same file are merged and thus
* not overwritten. Note however, that this object is @em not automatically
* updated with those changes.
*/
virtual bool sync() = 0;
/**
* Reset the dirty flags of all entries in the entry map, so the
* values will not be written to disk on a later call to sync().
*/
virtual void markAsClean() = 0;
/**
* Possible return values for accessMode().
*/
enum AccessMode { NoAccess, ReadOnly, ReadWrite };
/**
* Returns the access mode of the app-config object.
*
* Possible return values
* are NoAccess (the application-specific config file could not be
* opened neither read-write nor read-only), ReadOnly (the
* application-specific config file is opened read-only, but not
* read-write) and ReadWrite (the application-specific config
* file is opened read-write).
*
* @return the access mode of the app-config object
*/
virtual AccessMode accessMode() const = 0;
/**
* Checks whether this configuration object can be modified.
* @return whether changes may be made to this configuration object.
*/
virtual bool isImmutable() const = 0;
/**
* Can changes be made to the entries in @p group?
*
* @param group The group to check for immutability.
* @return @c false if the entries in @p group can be modified, otherwise @c true
*/
bool isGroupImmutable(const QString &group) const;
/**
* Overload for isGroupImmutable(const QString&) const
*
* @param group name of group, encoded in UTF-8
*/
bool isGroupImmutable(const QByteArray &group) const;
/**
* Overload for isGroupImmutable(const QString&) const
*
* @param group name of group, encoded in UTF-8
*/
bool isGroupImmutable(const char *group) const;
protected:
KConfigBase();
/// @param group name of group, encoded in UTF-8
virtual bool hasGroupImpl(const QByteArray &group) const = 0;
/// @param group name of group, encoded in UTF-8
virtual KConfigGroup groupImpl(const QByteArray &group) = 0;
/// @param group name of group, encoded in UTF-8
virtual const KConfigGroup groupImpl(const QByteArray &group) const = 0;
/// @param group name of group, encoded in UTF-8
virtual void deleteGroupImpl(const QByteArray &group, WriteConfigFlags flags = Normal) = 0;
/// @param group name of group, encoded in UTF-8
virtual bool isGroupImmutableImpl(const QByteArray &group) const = 0;
/** Virtual hook, used to add new "virtual" functions while maintaining
* binary compatibility. Unused in this class.
*/
virtual void virtual_hook(int id, void *data);
};
Q_DECLARE_OPERATORS_FOR_FLAGS(KConfigBase::WriteConfigFlags)
#endif // KCONFIG_H
|
