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
|
/* This file is part of the KDE libraries
Copyright (C) 1997 Mark Donohoe (donohoe@kde.org)
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Library General Public
License as published by the Free Software Foundation; either
version 2 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Library General Public License for more details.
You should have received a copy of the GNU Library General Public License
along with this library; see the file COPYING.LIB. If not, write to
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.
*/
#ifndef _KROOTPROP_H
#define _KROOTPROP_H
typedef unsigned long Atom;
#include <qcolor.h>
#include <qfont.h>
#include <qmap.h>
#include <qstringlist.h>
#include <kdelibs_export.h>
class KRootPropPrivate;
/**
* Access KDE desktop resources stored on the root window.
*
* A companion to the KConfig class.
*
* The KRootProp class is used for reading and writing configuration entries
* to properties on the root window.
*
* All configuration entries are of the form "key=value".
*
* @see KConfig::KConfig
* @author Mark Donohoe (donohe@kde.org)
*/
class KDECORE_EXPORT KRootProp
{
private:
Atom atom;
QMap<QString,QString> propDict;
QString property_;
bool dirty;
KRootPropPrivate *d;
public:
/**
* Constructs a KRootProp object for the property @p rProp.
* @param rProp the property that will be searched, null to
* do nothing
* @see setProp()
**/
KRootProp( const QString& rProp = QString::null );
/**
* Destructs the KRootProp object.
*
* Writes back any dirty configuration entries.
**/
~KRootProp();
/**
* Sets the property in which keys will be searched.
* @param rProp the property that will be searched
**/
void setProp(const QString& rProp=QString());
/**
* Returns the name of the property under which keys are searched.
* @return the property that will be searched
**/
QString prop() const;
/**
* Destroys the property completely.
*
* I.e. all entries will be cleared
* and the property will be removed from the root window.
**/
void destroy();
/**
* Reads the value of an entry specified by @p rKey in the current property.
*
* @param rKey The key to search for.
* @param pDefault A default value returned if the key was not found.
* @return The value for this key or the default if no value
* was found.
**/
QString readEntry( const QString& rKey,
const QString& pDefault = QString::null ) const ;
/**
* Reads a numerical value.
*
* Reads the value of an entry specified by @p rKey in the current property
* and interprets it numerically.
*
* @param rKey The key to search for.
* @param nDefault A default value returned if the key was not found.
* @return The value for this key or the default if no value was found.
*/
int readNumEntry( const QString& rKey, int nDefault = 0 ) const;
/**
* Reads a QFont value.
*
* Reads the value of an entry specified by @p rKey in the current property
* and interpret it as a font object.
*
* @param rKey The key to search for.
* @param pDefault A default value returned if the key was not found.
* @return The value for this key or a default font if no value was found.
*/
QFont readFontEntry( const QString& rKey,
const QFont* pDefault = 0 ) const;
/**
* Reads a QColor.
*
* Reads the value of an entry specified by @p rKey in the current property
* and interprets it as a color.
*
* @param rKey The key to search for.
* @param pDefault A default value returned if the key was not found.
* @return The value for this key or a default color if no value
* was found.
*/
QColor readColorEntry( const QString& rKey,
const QColor* pDefault = 0 ) const;
/**
* Writes a (key/value) pair.
*
* This is stored to the current property when destroying the
* config object or when calling sync().
*
* @param rKey The key to write.
* @param rValue The value to write.
* @return The old value for this key. If this key did not exist,
* a null string is returned.
*
**/
QString writeEntry( const QString& rKey, const QString& rValue );
/**
* Writes the (key/value) pair.
* Same as above, but writes a numerical value.
* @param rKey The key to write.
* @param nValue The value to write.
* @return The old value for this key. If this key did not
* exist, a null string is returned.
**/
QString writeEntry( const QString& rKey, int nValue );
/**
* Writes the (key/value) pair.
* Same as above, but writes a font.
* @param rKey The key to write.
* @param rFont The font to write.
* @return The old value for this key. If this key did not
* exist, a null string is returned.
**/
QString writeEntry( const QString& rKey, const QFont& rFont );
/**
* Writes the (key/value) pair.
* Same as above, but writes a color.
* @param rKey The key to write.
* @param rColor The color to write.
* @return The old value for this key. If this key did not
* exist, a null string is returned.
**/
QString writeEntry( const QString& rKey, const QColor& rColor );
/**
* Removes an entry.
* @param rKey The key to remove.
* @return The old value for this key. If this key did not
* exist, a null string is returned.
**/
QString removeEntry(const QString& rKey);
/**
* Returns a list of all keys.
* @return A QStringList containing all the keys.
**/
QStringList listEntries() const;
/**
* Flushes the entry cache.
* Writes back dirty configuration entries to the current property,
* This is called automatically from the destructor.
**/
void sync();
};
#endif
|
