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
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
|
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<title>KSharedConfig</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta http-equiv="Content-Style-Type" content="text/css" />
<link rel="stylesheet" type="text/css" href="../common/doxygen.css" />
<link rel="stylesheet" media="screen" type="text/css" title="KDE Colors" href="../common/kde.css" />
</head>
<body>
<div id="container">
<div id="header">
<div id="header_top">
<div>
<div>
<img alt ="" src="../common/top-kde.jpg"/>
KDE 4.7 PyKDE API Reference
</div>
</div>
</div>
<div id="header_bottom">
<div id="location">
<ul>
<li>KDE's Python API</li>
</ul>
</div>
<div id="menu">
<ul>
<li><a href="../modules.html">Overview</a></li>
<li><a href="http://techbase.kde.org/Development/Languages/Python">PyKDE Home</a></li>
<li><a href="http://kde.org/family/">Sitemap</a></li>
<li><a href="http://kde.org/contact/">Contact Us</a></li>
</ul>
</div>
</div>
</div>
<div id="body_wrapper">
<div id="body">
<div id="right">
<div class="content">
<div id="main">
<div class="clearer"> </div>
<h1>KSharedConfig Class Reference</h1>
<code>from PyKDE4.kdecore import *</code>
<p>
Inherits: <a href="../kdecore/KConfig.html">KConfig</a> → <a href="../kdecore/KConfigBase.html">KConfigBase</a><br />
<h2>Detailed Description</h2>
<p>\class KSharedConfig ksharedconfig.h <KSharedConfig>
</p>
<p>
KConfig variant using shared memory
</p>
<p>
KSharedConfig provides a reference counted, shared memory variant
of KConfig. This allows you to use manipulate the same configuration
files from different places in your code without worrying about
accidentally overwriting changes.
</p>
<p>
Note that, as with most of kdelibs, this is <b>NOT</b> threadsafe.
</p>
<table border="0" cellpadding="0" cellspacing="0"><tr><td colspan="2"><br><h2>Methods</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#KSharedConfig">__init__</a> (self, <a href="../kdecore/KComponentData.html">KComponentData</a> componentData, QString file, <a href="../kdecore/KConfig.html">KConfig.OpenFlags</a> mode, QString resourceType)</td></tr>
<tr><td colspan="2"><br><h2>Static Methods</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">KSharedPtr<KSharedConfig> </td><td class="memItemRight" valign="bottom"><a class="el" href="#openConfig">openConfig</a> (QString fileName=QString(), <a href="../kdecore/KConfig.html">KConfig.OpenFlags</a> mode=KConfig.FullConfig, QString resourceType="config")</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">KSharedPtr<KSharedConfig> </td><td class="memItemRight" valign="bottom"><a class="el" href="#openConfig">openConfig</a> (<a href="../kdecore/KComponentData.html">KComponentData</a> componentData, QString fileName=QString(), <a href="../kdecore/KConfig.html">KConfig.OpenFlags</a> mode=KConfig.FullConfig, QString resourceType="config")</td></tr>
</table>
<hr><h2>Method Documentation</h2><a class="anchor" name="KSharedConfig"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">__init__</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kdecore/KComponentData.html">KComponentData</a> </td>
<td class="paramname"><em>componentData</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString </td>
<td class="paramname"><em>file</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kdecore/KConfig.html">KConfig.OpenFlags</a> </td>
<td class="paramname"><em>mode</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString </td>
<td class="paramname"><em>resourceType</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"></div></div><hr><h2>Static Method Documentation</h2><a class="anchor" name="openConfig"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">KSharedPtr<KSharedConfig> openConfig</td>
<td>(</td>
<td class="paramtype">QString </td>
<td class="paramname"><em>fileName=QString()</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kdecore/KConfig.html">KConfig.OpenFlags</a> </td>
<td class="paramname"><em>mode=KConfig.FullConfig</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString </td>
<td class="paramname"><em>resourceType="config"</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Constructs a KSharedConfig object.
</p>
<p>
If an absolute path is specified for <b>fileName,</b> that file will be used
as the store for the configuration settings. If a non-absolute path
is provided, the file will be looked for in the standard directory
specified by resourceType. If no path is provided, a default
configuration file will be used based on the component's name.
</p>
<p>
<b>mode</b> determines whether the user or global settings will be allowed
to influence the values returned by this object. See KConfig.OpenFlags for
more details.
</p>
<p>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>componentData</em> </td><td> the component that you wish to load a configuration
file for
<tr><td></td><td valign="top"><em>fileName</em> </td><td> the configuration file to open
<tr><td></td><td valign="top"><em>mode</em> </td><td> how global settings should affect the configuration
options exposed by this KConfig object
<tr><td></td><td valign="top"><em>resourceType</em> </td><td> The standard directory to look for the configuration
file in (see KStandardDirs)
</td></tr>
</table></dl>
<p> @sa KConfig.KConfig(const KComponentData&, const QString&, OpenFlags, const char*)
</p></div></div><a class="anchor" name="openConfig"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">KSharedPtr<KSharedConfig> openConfig</td>
<td>(</td>
<td class="paramtype"><a href="../kdecore/KComponentData.html">KComponentData</a> </td>
<td class="paramname"><em>componentData</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString </td>
<td class="paramname"><em>fileName=QString()</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kdecore/KConfig.html">KConfig.OpenFlags</a> </td>
<td class="paramname"><em>mode=KConfig.FullConfig</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString </td>
<td class="paramname"><em>resourceType="config"</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Constructs a KSharedConfig object.
</p>
<p>
If an absolute path is specified for <b>fileName,</b> that file will be used
as the store for the configuration settings. If a non-absolute path
is provided, the file will be looked for in the standard directory
specified by resourceType. If no path is provided, a default
configuration file will be used based on the component's name.
</p>
<p>
<b>mode</b> determines whether the user or global settings will be allowed
to influence the values returned by this object. See KConfig.OpenFlags for
more details.
</p>
<p>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>componentData</em> </td><td> the component that you wish to load a configuration
file for
<tr><td></td><td valign="top"><em>fileName</em> </td><td> the configuration file to open
<tr><td></td><td valign="top"><em>mode</em> </td><td> how global settings should affect the configuration
options exposed by this KConfig object
<tr><td></td><td valign="top"><em>resourceType</em> </td><td> The standard directory to look for the configuration
file in (see KStandardDirs)
</td></tr>
</table></dl>
<p> @sa KConfig.KConfig(const KComponentData&, const QString&, OpenFlags, const char*)
</p></div></div>
</div>
</div>
</div>
<div id="left">
<div class="menu_box">
<div class="nav_list">
<ul>
<li><a href="../allclasses.html">Full Index</a></li>
</ul>
</div>
<a name="cp-menu" /><div class="menutitle"><div>
<h2 id="cp-menu-project">Modules</h2>
</div></div>
<div class="nav_list">
<ul><li><a href="../akonadi/index.html">akonadi</a></li>
<li><a href="../dnssd/index.html">dnssd</a></li>
<li><a href="../kdecore/index.html">kdecore</a></li>
<li><a href="../kdeui/index.html">kdeui</a></li>
<li><a href="../khtml/index.html">khtml</a></li>
<li><a href="../kio/index.html">kio</a></li>
<li><a href="../knewstuff/index.html">knewstuff</a></li>
<li><a href="../kparts/index.html">kparts</a></li>
<li><a href="../kutils/index.html">kutils</a></li>
<li><a href="../nepomuk/index.html">nepomuk</a></li>
<li><a href="../phonon/index.html">phonon</a></li>
<li><a href="../plasma/index.html">plasma</a></li>
<li><a href="../polkitqt/index.html">polkitqt</a></li>
<li><a href="../solid/index.html">solid</a></li>
<li><a href="../soprano/index.html">soprano</a></li>
</ul></div></div>
</div>
</div>
<div class="clearer"/>
</div>
<div id="end_body"></div>
</div>
<div id="footer"><div id="footer_text">
This documentation is maintained by <a href="mailto:simon@simonzone.com">Simon Edwards</a>.<br />
KDE<sup>®</sup> and <a href="../images/kde_gear_black.png">the K Desktop Environment<sup>®</sup> logo</a> are registered trademarks of <a href="http://ev.kde.org/" title="Homepage of the KDE non-profit Organization">KDE e.V.</a> |
<a href="http://www.kde.org/contact/impressum.php">Legal</a>
</div></div>
</body>
</html>
|
