<?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>KOCRDialog</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>KOCRDialog 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>Base class for OCR Dialogs. </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="#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="#KOCRDialog">__init__</a> (self, int dialogFace=Tabbed, int buttonMask=Close|Help, QWidget parent=0, bool modal=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 colspan="2"><br><h2>Static Methods</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kio/KOCRDialog.html">KOCRDialog</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#getOCRDialog">getOCRDialog</a> (QWidget parent=0)</td></tr> </table> <hr><h2>Signal Documentation</h2><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="KOCRDialog"></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 class="memname"></td> <td></td> <td class="paramtype">bool </td> <td class="paramname"><em>modal=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 OCR 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> a 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 <tr><td></td><td valign="top"><em>modal</em> </td><td> if true the dialog is model </td></tr> </table></dl> <p> </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 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> 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> textRecognized </dd></dl> </p></div></div><hr><h2>Static Method Documentation</h2><a class="anchor" name="getOCRDialog"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"><a href="../kio/KOCRDialog.html">KOCRDialog</a> getOCRDialog</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 OCR dialog and returns it, or 0L if no OCR-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 KOCRDialog, 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>