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
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
|
<?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>Akonadi.ItemSerializerPlugin</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.9 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>ItemSerializerPlugin Class Reference</h1>
<code>from PyKDE4.akonadi import *</code>
<p>
Subclasses: <a href="../akonadi/Akonadi.ItemSerializerPluginV2.html">Akonadi.ItemSerializerPluginV2</a><br />
Namespace: <a href="../akonadi/Akonadi.html">Akonadi</a><br />
<h2>Detailed Description</h2>
<dl class="abstract" compact><dt><b>Abstract class:</b></dt>
<dd>This class can be used as a base class for new classes, but can not be instantiated directly.</dd></dl>
<p>The base class for item type serializer plugins.
</p>
<p>
Serializer plugins convert between the payload of Akonadi.Item objects and
a textual or binary representation of the actual content data.
This allows to easily add support for new types to Akonadi.
</p>
<p>
The following example shows how to implement a serializer plugin for
a new data type PimNote.
</p>
<p>
The PimNote data structure:
<pre class="fragment">
typedef struct {
QString author;
QDateTime dateTime;
QString text;
} PimNote;
</pre>
</p>
<p>
The serializer plugin code:
<pre class="fragment">
#include <QtCore/qplugin.h>
class SerializerPluginPimNote : public QObject, public Akonadi.ItemSerializerPlugin
{
Q_OBJECT
Q_INTERFACES( Akonadi.ItemSerializerPlugin )
public:
bool deserialize( Akonadi.Item& item, const QByteArray& label, QIODevice& data, int version )
{
// we don't handle versions in this example
Q_UNUSED( version );
// we work only on full payload
if ( label != Akonadi.Item.FullPayload )
return false;
QDataStream stream( &data );
PimNote note;
stream >> note.author;
stream >> note.dateTime;
stream >> note.text;
item.setPayload<PimNote>( note );
return true;
}
void serialize( const Akonadi.Item& item, const QByteArray& label, QIODevice& data, int &version )
{
// we don't handle versions in this example
Q_UNUSED( version );
if ( label != Akonadi.Item.FullPayload || !item.hasPayload<PimNote>() )
return;
QDataStream stream( &data );
PimNote note = item.payload<PimNote>();
stream << note.author;
stream << note.dateTime;
stream << note.text;
}
};
Q_EXPORT_PLUGIN2( akonadi_serializer_pimnote, SerializerPluginPimNote )
</pre>
</p>
<p>
The desktop file:
<pre class="fragment">
[Misc]
Name=Pim Note Serializer
Comment=An Akonadi serializer plugin for note objects
[Plugin]
Type=application/x-pimnote
X-KDE-Library=akonadi_serializer_pimnote
</pre>
</p>
<p>
<dl class="author" compact><dt><b>Author:</b></dt><dd> Till Adam <adam@kde.org>, Volker Krause <vkrause@kde.org> </dd></dl>
</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">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#deserialize">deserialize</a> (self, <a href="../akonadi/Akonadi.Item.html">Akonadi.Item</a> item, QByteArray label, QIODevice data, int version)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QSet<QByteArray> </td><td class="memItemRight" valign="bottom"><a class="el" href="#parts">parts</a> (self, <a href="../akonadi/Akonadi.Item.html">Akonadi.Item</a> item)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#serialize">serialize</a> (self, <a href="../akonadi/Akonadi.Item.html">Akonadi.Item</a> item, QByteArray label, QIODevice data, int version)</td></tr>
</table>
<hr><h2>Method Documentation</h2><a class="anchor" name="deserialize"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool deserialize</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="../akonadi/Akonadi.Item.html">Akonadi.Item</a> </td>
<td class="paramname"><em>item</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QByteArray </td>
<td class="paramname"><em>label</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QIODevice </td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>version</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><dl compact><dt><b>Abstract method:</b></dt><dd>This method is abstract and can be overridden but not called directly.</dd></dl><p>Converts serialized item data provided in <b>data</b> into payload for <b>item.</b>
</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>item</em> </td><td> The item to which the payload should be added.
It is guaranteed to have a mime type matching one of the supported
mime types of this plugin.
However it might contain a unsuited payload added manually
by the application developer.
Verifying the payload type in case a payload is already available
is recommended therefore.
<tr><td></td><td valign="top"><em>label</em> </td><td> The part identifier of the part to deserialize.
<b>label</b> might be an unsupported item part, return false if this is the case.
<tr><td></td><td valign="top"><em>data</em> </td><td> A QIODevice providing access to the serialized data.
The QIODevice is opened in read-only mode and positioned at the beginning.
The QIODevice is guaranteed to be valid.
<tr><td></td><td valign="top"><em>version</em> </td><td> The version of the data format as set by the user in serialize() or 0 (default).
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> false if the specified part is not supported by this plugin, true if the part
could be de-serialized successfully.
</dd></dl>
</p></div></div><a class="anchor" name="parts"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QSet<QByteArray> parts</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="../akonadi/Akonadi.Item.html">Akonadi.Item</a> </td>
<td class="paramname"><em>item</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Returns a list of available parts for the given item payload.
The default implementation returns Item.FullPayload if a payload is set.
</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>item</em> </td><td> The item.
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="serialize"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> serialize</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="../akonadi/Akonadi.Item.html">Akonadi.Item</a> </td>
<td class="paramname"><em>item</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QByteArray </td>
<td class="paramname"><em>label</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QIODevice </td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>version</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><dl compact><dt><b>Abstract method:</b></dt><dd>This method is abstract and can be overridden but not called directly.</dd></dl><p>Convert the payload object provided in <b>item</b> into its serialzed form into <b>data.</b>
</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>item</em> </td><td> The item which contains the payload.
It is guaranteed to have a mimetype matching one of the supported
mimetypes of this plugin as well as the existence of a payload object.
However it might contain an unsupported payload added manually by
the application developer.
Verifying the payload type is recommended therefore.
<tr><td></td><td valign="top"><em>label</em> </td><td> The part identifier of the part to serialize.
<b>label</b> will be one of the item parts returned by parts().
<tr><td></td><td valign="top"><em>data</em> </td><td> The QIODevice where the serialized data should be written to.
The QIODevice is opened in write-only mode and positioned at the beginning.
The QIODevice is guaranteed to be valid.
<tr><td></td><td valign="top"><em>version</em> </td><td> The version of the data format. Can be set by the user to handle different
versions.
</td></tr>
</table></dl>
<p>
</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>
|
