<?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.4 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> → <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qdialog.html">QDialog</a> → <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qwidget.html">QWidget</a> → <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qobject.html">QObject</a><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> (, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qimage.html">QImage</a> 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> (, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qimage.html">QImage</a> 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> (, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> 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, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qwidget.html">QWidget</a> parent=0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#finalImage">finalImage</a> (self, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qimage.html">QImage</a> img, int id)</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> (self, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qwidget.html">QWidget</a> 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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#preview">preview</a> (self, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qimage.html">QImage</a> img, int id)</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 class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#textRecognized">textRecognized</a> (self, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> text, int id)</td></tr>
</table>
<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"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qwidget.html">QWidget</a> </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="finalImage"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> finalImage</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="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qimage.html">QImage</a> </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="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"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qwidget.html">QWidget</a> </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><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="preview"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> preview</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="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qimage.html">QImage</a> </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="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><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"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> </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>
</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>
distrib
>
Mandriva
>
current
>
i586
>
media
>
main-updates
>
by-pkgid
>
b77dda48f87d4eda8cc559e40c49a652
>
files
>
857
