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
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
|
<?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>KScanDialog</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>KScanDialog Class Reference</h1>
<code>from PyKDE4.kio import *</code>
<p>
Inherits: <a href="../kdeui/KPageDialog.html">KPageDialog</a> → <a href="../kdeui/KDialog.html">KDialog</a> → QDialog → QWidget → QObject<br />
<h2>Detailed Description</h2>
<p>This is a base class for scanning dialogs. You can derive from this class
and implement your own dialog. An implementation is available in
kdegraphics/libkscan.
</p>
<p>
Application developers that wish to add scanning support to their program
can use the static method <b>KScanDialog.getScanDialog()</b> to get an instance
of the user's preferred scanning dialog.
</p>
<p>
Typical usage looks like this (e.g. in a slotShowScanDialog() method):
</p>
<p>
<pre class="fragment">
if ( !m_scanDialog ) {
m_scanDialog = KScanDialog.getScanDialog( this );
if ( !m_scanDialog ) // no scanning support installed?
return;
connect( m_scanDialog, SIGNAL( finalImage( const QImage&, int )),
SLOT( slotScanned( const QImage&, int ) ));
}
if ( m_scanDialog->setup() ) // only if scanner configured/available
m_scanDialog->show();
</pre>
</p>
<p>
This will create and show a non-modal scanning dialog. Connect to more
signals if you like.
</p>
<p>
A baseclass and accessor for Scanning Dialogs
<dl class="author" compact><dt><b>Author:</b></dt><dd> Carsten Pfeiffer <pfeiffer@kde.org> </dd></dl>
</p>
<table border="0" cellpadding="0" cellspacing="0"><tr><td colspan="2"><br><h2>Signals</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#finalImage">finalImage</a> (QImage img, int id)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#preview">preview</a> (QImage img, int id)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#textRecognized">textRecognized</a> (QString text, int id)</td></tr>
<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="#KScanDialog">__init__</a> (self, int dialogFace=Tabbed, int buttonMask=Close|Help, QWidget parent=0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#id">id</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#nextId">nextId</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#setup">setup</a> (self)</td></tr>
<tr><td colspan="2"><br><h2>Static Methods</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kio/KScanDialog.html">KScanDialog</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#getScanDialog">getScanDialog</a> (QWidget parent=0)</td></tr>
</table>
<hr><h2>Signal Documentation</h2><a class="anchor" name="finalImage"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> finalImage</td>
<td>(</td>
<td class="paramtype">QImage </td>
<td class="paramname"><em>img</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>id</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Informs you that an image has scanned. <b>id</b> is the same as in the
<b>preview()</b> signal, if this image had been previewed before.
</p>
<p>
Note, that those id's may not be properly implemented in the current
libkscan.
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>img</em> </td><td> the image
<tr><td></td><td valign="top"><em>id</em> </td><td> the image's id
</td></tr>
</table></dl>
<p>
</p><dl compact><dt><b>Signal syntax:</b></dt><dd><code>QObject.connect(source, SIGNAL("finalImage(const QImage&, int)"), target_slot)</code></dd></dl></div></div><a class="anchor" name="preview"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> preview</td>
<td>(</td>
<td class="paramtype">QImage </td>
<td class="paramname"><em>img</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>id</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Informs you that an image has been previewed.
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>img</em> </td><td> the image
<tr><td></td><td valign="top"><em>id</em> </td><td> the image's id
</td></tr>
</table></dl>
<p>
</p><dl compact><dt><b>Signal syntax:</b></dt><dd><code>QObject.connect(source, SIGNAL("preview(const QImage&, int)"), target_slot)</code></dd></dl></div></div><a class="anchor" name="textRecognized"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> textRecognized</td>
<td>(</td>
<td class="paramtype">QString </td>
<td class="paramname"><em>text</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>id</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Informs you that the image with the id <b>id</b> has been run through
text-recognition. The text is in the QString parameter. In the future,
a compound document, using rich text will be used instead.
</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>text</em> </td><td> the text that has been recognized
<tr><td></td><td valign="top"><em>id</em> </td><td> the id of the image
</td></tr>
</table></dl>
<p>
</p><dl compact><dt><b>Signal syntax:</b></dt><dd><code>QObject.connect(source, SIGNAL("textRecognized(const QString&, int)"), target_slot)</code></dd></dl></div></div><hr><h2>Method Documentation</h2><a class="anchor" name="KScanDialog"></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">int </td>
<td class="paramname"><em>dialogFace=Tabbed</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>buttonMask=Close|Help</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QWidget </td>
<td class="paramname"><em>parent=0</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Constructs the scan dialog. If you implement an own dialog, you can
customize it with the usual KPageDialog flags.
</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>dialogFace</em> </td><td> The KPageDialog.FaceType
<tr><td></td><td valign="top"><em>buttonMask</em> </td><td> An ORed mask of all buttons (see
KDialog.ButtonCode)
<tr><td></td><td valign="top"><em>parent</em> </td><td> The QWidget's parent, or 0
</td></tr> </table></dl>
<p> <dl class="see" compact><dt><b>See also:</b></dt><dd> KPageDialog
</dd></dl>
</p></div></div><a class="anchor" name="id"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">int id</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>Returns the current id for an image. You can use that in your subclass
for the signals. The id is used in the signals to let people know
which preview and which text-recognition belongs to which scan.
</p>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> the current id for the image
</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> nextId
</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> finalImage
</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> preview
</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> textRecognized
</dd></dl>
</p></div></div><a class="anchor" name="nextId"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">int nextId</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>Returns the id for the next image. You can use that in your subclass
for the signals.
</p>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> the id for the next image
</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> id
</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> finalImage
</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> preview
</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> textRecognized
</dd></dl>
</p></div></div><a class="anchor" name="setup"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool setup</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>Reimplement this if you need to set up some things, before showing the
dialog, e.g. to ask the user for the scanner device to use. If you
return false (e.g. there is no device available or the user aborted
device selection), the dialog will not be shown.
</p>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> true by default.
</dd></dl>
</p></div></div><hr><h2>Static Method Documentation</h2><a class="anchor" name="getScanDialog"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../kio/KScanDialog.html">KScanDialog</a> getScanDialog</td>
<td>(</td>
<td class="paramtype">QWidget </td>
<td class="paramname"><em>parent=0</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Creates the user's preferred scanning dialog and returns it,
or 0L if no scan-support
is available. Pass a suitable <b>parent</b> widget, if you like. If you
don't you have to 'delete' the returned pointer yourself.
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>parent</em> </td><td> the QWidget's parent, or 0
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> the KScanDialog, or 0 if the function failed
</dd></dl>
</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>
|
