<?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>KParts.TextExtension</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>TextExtension Class Reference</h1> <code>from PyKDE4.kparts import *</code> <p> Inherits: QObject<br /> Namespace: <a href="../kparts/KParts.html">KParts</a><br /> <h2>Detailed Description</h2> <p>an extension for KParts that allows to retrieve text from the part. </p> <p> For instance, the text-to-speech plugin uses this to speak the whole text from the part or the selected text. The translation plugin uses it for translating the selected text, and so on. </p> <p> <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.6 </dd></dl> </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="#Format">Format</a> </td><td class="memItemRight" valign="bottom">{ PlainText, HTML }</td></tr> <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="#selectionChanged">selectionChanged</a> ()</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="#TextExtension">__init__</a> (self, <a href="../kparts/KParts.ReadOnlyPart.html">KParts.ReadOnlyPart</a> parent)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#completeText">completeText</a> (self, <a href="../kparts/KParts.TextExtension.html#Format">KParts.TextExtension.Format</a> format)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#currentPage">currentPage</a> (self)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#findText">findText</a> (self, QString string, <a href="../kdeui/KFind.html">KFind.SearchOptions</a> options)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#hasSelection">hasSelection</a> (self)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#pageCount">pageCount</a> (self)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#pageText">pageText</a> (self, <a href="../kparts/KParts.TextExtension.html#Format">KParts.TextExtension.Format</a> format)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#selectedText">selectedText</a> (self, <a href="../kparts/KParts.TextExtension.html#Format">KParts.TextExtension.Format</a> format)</td></tr> <tr><td colspan="2"><br><h2>Static Methods</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kparts/KParts.TextExtension.html">KParts.TextExtension</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#childObject">childObject</a> (QObject obj)</td></tr> </table> <hr><h2>Signal Documentation</h2><a class="anchor" name="selectionChanged"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"> selectionChanged</td> <td>(</td> <td class="paramtype"> </td> <td class="paramname">)</td> <td width="100%"> </td> </tr> </table> </div> <div class="memdoc"><p>This signal is emitted when the selection changes. </p><dl compact><dt><b>Signal syntax:</b></dt><dd><code>QObject.connect(source, SIGNAL("selectionChanged()"), target_slot)</code></dd></dl></div></div><hr><h2>Method Documentation</h2><a class="anchor" name="TextExtension"></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"><a href="../kparts/KParts.ReadOnlyPart.html">KParts.ReadOnlyPart</a> </td> <td class="paramname"><em>parent</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"></div></div><a class="anchor" name="completeText"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">QString completeText</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="../kparts/KParts.TextExtension.html#Format">KParts.TextExtension.Format</a> </td> <td class="paramname"><em>format</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>Returns the complete text shown in the part, in the requested format. If the format is not supported, the part must return an empty string. </p></div></div><a class="anchor" name="currentPage"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">int currentPage</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 page (between 0 and pageCount()-1), for parts who support the concept of pages. Otherwise returns 0. </p></div></div><a class="anchor" name="findText"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">bool findText</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>string</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype"><a href="../kdeui/KFind.html">KFind.SearchOptions</a> </td> <td class="paramname"><em>options</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>Returns true if <b>string</b> is found using the given <b>options.</b> </p> <p> If any text matches <b>string,</b> then it will be selected/highlighted. To find the next matching text, simply call this function again with the same search text until it returns false. </p> <p> To clear a selection, just pass an empty string. </p> <p> Note that parts that implement this extension might not support all the options available in KFind.SearchOptions. </p></div></div><a class="anchor" name="hasSelection"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">bool hasSelection</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 true if the user selected text in the part. </p></div></div><a class="anchor" name="pageCount"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">int pageCount</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 number of pages, for parts who support the concept of pages. Otherwise returns 0. </p></div></div><a class="anchor" name="pageText"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">QString pageText</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="../kparts/KParts.TextExtension.html#Format">KParts.TextExtension.Format</a> </td> <td class="paramname"><em>format</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>Returns the text in a given page, in the requested format. </p></div></div><a class="anchor" name="selectedText"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">QString selectedText</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="../kparts/KParts.TextExtension.html#Format">KParts.TextExtension.Format</a> </td> <td class="paramname"><em>format</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>Returns the selected text, in the requested format. If the format is not supported, the part must return an empty string. </p></div></div><hr><h2>Static Method Documentation</h2><a class="anchor" name="childObject"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"><a href="../kparts/KParts.TextExtension.html">KParts.TextExtension</a> childObject</td> <td>(</td> <td class="paramtype">QObject </td> <td class="paramname"><em>obj</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>Queries <b>obj</b> for a child object which inherits from this TextExtension class. </p></div></div><hr><h2>Enumeration Documentation</h2><a class="anchor" name="Format"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr><td class="memname">Format</td> </tr> </table> </div> <div class="memdoc"><dl compact><dt><b>Enumerator: </b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"><tr><td valign="top"><em>PlainText</em> </td><td><tr><td valign="top"><em>HTML</em> </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>