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
|
<?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>ThumbCreator</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>ThumbCreator Class Reference</h1>
<code>from PyKDE4.kio import *</code>
<p>
<h2>Detailed Description</h2>
<p>This is the baseclass for "thumbnail-plugins" in KDE. Using the class
KIO.PreviewJob allows you to generate small images (thumbnails)
for any kind of file, where a "ThumbCreator" is available. Have a look
at kdebase/kioslave/thumbnail/ for existing ThumbCreators. Use ThumbCreatorV2
if the thumbnail-plugin should be configurable by the user.
</p>
<p>
What you need to do to create and register a ThumbCreator:
<li> Inherit from this class and reimplement the create() method to </li>
generate a thumbnail for the given file-path.
<li> Provide a factory method in your implementation file to instantiate </li>
your plugin, e.g.:
<pre class="fragment">
extern "C"
{
KDE_EXPORT ThumbCreator *new_creator()
{
return new YourThumbCreator();
}
};
</pre>
</p>
<p>
Compile your ThumbCreator as a module. The contents of CMakeLists.txt
should look something like this, with "filetype" replaced by the type of
file this plugin creates thumbnails for:
<pre class="fragment">
project(filetypethumbcreator)
find_package(KDE4 REQUIRED)
include (KDE4Defaults)
include(MacroOptionalAddSubdirectory)
set(filetypethumbnail_SRCS filetypethumbnail.cpp)
kde4_add_ui_files(filetypethumbnail_SRCS config.ui )
kde4_add_plugin(filetypethumbnail ${filetypethumbnail_SRCS})
target_link_libraries(filetypethumbnail ${KDE4_KIO_LIBS})
install(TARGETS filetypethumbnail DESTINATION ${PLUGIN_INSTALL_DIR})
install(FILES filetypethumbcreator.desktop DESTINATION ${SERVICES_INSTALL_DIR})
</pre>
</p>
<p>
<li> Create a file filetypethumbcreator.desktop with the following contents: </li>
<pre class="fragment">
[Desktop Entry]
Encoding=UTF-8
Type=Service
Name=Name of the type of files your ThumbCreator supports
ServiceTypes=ThumbCreator
MimeType=application/x-somemimetype;
CacheThumbnail=true
X-KDE-Library=yourthumbcreator
</pre>
</p>
<p>
You can supply a comma-separated list of mimetypes to the MimeTypes entry,
naming all mimetypes your ThumbCreator supports. You can also use simple
wildcards, like (where you see [slash], put a /)
<pre class="fragment">
text[slash]* or image[slash]*.
</pre>
</p>
<p>
If your plugin is rather inexpensive (e.g. like the text preview ThumbCreator),
you can set CacheThumbnail=false to prevent your thumbnails from being cached
on disk.
</p>
<p>
The following optional property can also be added to the .desktop file:
<pre class="fragment">
ThumbnailerVersion=N
</pre>
where N is some nonnegative integer. If a cached thumbnail has been created with a
previous version of the thumbnailer, then the cached thumbnail will be discarded and
a new one will be regenerated. Increase (or define) the version number if and only if
old thumbnails need to be regenerated.
If no version number is provided, then the version is assumed to be <0.
</p>
<p>
Baseclass for thumbnail-generating plugins.
</p>
<table border="0" cellpadding="0" cellspacing="0"><tr><td colspan="2"><br><h2>Enumerations</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="#Flags">Flags</a> </td><td class="memItemRight" valign="bottom">{ None, DrawFrame, BlendIcon }</td></tr>
<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="#create">create</a> (self, QString path, int width, int height, QImage img)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kio/ThumbCreator.html#Flags">ThumbCreator.Flags</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#flags">flags</a> (self)</td></tr>
</table>
<hr><h2>Method Documentation</h2><a class="anchor" name="create"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool create</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">QString </td>
<td class="paramname"><em>path</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>width</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>height</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QImage </td>
<td class="paramname"><em>img</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>Creates a thumbnail
Note that the width and height parameters should not be used
for scaling. Only plugins that create an image "from scratch",
like the TextCreator should directly use the specified size.
If the resulting preview is larger than width x height, it will be
scaled down.
</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>path</em> </td><td> the (always local) file path to create a preview for
<tr><td></td><td valign="top"><em>width</em> </td><td> maximum width for the preview
<tr><td></td><td valign="top"><em>height</em> </td><td> maximum height for the preview
<tr><td></td><td valign="top"><em>img</em> </td><td> this image will contain the preview on success
</td></tr>
</table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> true if preview generation succeeded
</dd></dl>
</p></div></div><a class="anchor" name="flags"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../kio/ThumbCreator.html#Flags">ThumbCreator.Flags</a> flags</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>The flags of this plugin:
<li> None nothing special </li>
<li> DrawFrame a frame should be painted around the preview </li>
<li> BlendIcon the mimetype icon should be blended over the preview </li>
</p>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> flags for this plugin
</dd></dl>
</p></div></div><hr><h2>Enumeration Documentation</h2><a class="anchor" name="Flags"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr><td class="memname">Flags</td>
</tr>
</table>
</div>
<div class="memdoc"><p>The flags of this plugin.
<dl class="see" compact><dt><b>See also:</b></dt><dd> flags()
</dd></dl>
</p><dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0"><tr><td valign="top"><em>None</em> = 0</td><td><tr><td valign="top"><em>DrawFrame</em> = 1</td><td><tr><td valign="top"><em>BlendIcon</em> = 2</td><td></table>
</dl>
</div></div><p>
</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>
|
