<?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>KUrlCompletion</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>KUrlCompletion Class Reference</h1> <code>from PyKDE4.kio import *</code> <p> Inherits: <a href="../kdeui/KCompletion.html">KCompletion</a> → QObject<br /> Subclasses: <a href="../kio/KShellCompletion.html">KShellCompletion</a><br /> <h2>Detailed Description</h2> <p>This class does completion of URLs including user directories (~user) and environment variables. Remote URLs are passed to KIO. </p> <p> Completion of a single URL <dl class="author" compact><dt><b>Author:</b></dt><dd> David Smith <dsmith@algonet.se> </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="#Mode">Mode</a> </td><td class="memItemRight" valign="bottom">{ ExeCompletion, FileCompletion, DirCompletion }</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="#KUrlCompletion">__init__</a> (self)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#KUrlCompletion">__init__</a> (self, <a href="../kio/KUrlCompletion.html#Mode">KUrlCompletion.Mode</a> a0)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#customEvent">customEvent</a> (self, QEvent e)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#dir">dir</a> (self)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#isRunning">isRunning</a> (self)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#makeCompletion">makeCompletion</a> (self, QString text)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kio/KUrlCompletion.html#Mode">KUrlCompletion.Mode</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#mode">mode</a> (self)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#postProcessMatch">postProcessMatch</a> (self, QString match)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#postProcessMatches">postProcessMatches</a> (self, QStringList matches)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#replaceEnv">replaceEnv</a> (self)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#replaceHome">replaceHome</a> (self)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#replacedPath">replacedPath</a> (self, QString text)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setDir">setDir</a> (self, QString dir)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setMode">setMode</a> (self, <a href="../kio/KUrlCompletion.html#Mode">KUrlCompletion.Mode</a> mode)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setReplaceEnv">setReplaceEnv</a> (self, bool replace)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setReplaceHome">setReplaceHome</a> (self, bool replace)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#stop">stop</a> (self)</td></tr> <tr><td colspan="2"><br><h2>Static Methods</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#replacedPath">replacedPath</a> (QString text, bool replaceHome, bool replaceEnv=1)</td></tr> </table> <hr><h2>Method Documentation</h2><a class="anchor" name="KUrlCompletion"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">__init__</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>This overloaded constructor allows you to set the Mode to ExeCompletion or FileCompletion without using setMode. Default is FileCompletion. </p></div></div><a class="anchor" name="KUrlCompletion"></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="../kio/KUrlCompletion.html#Mode">KUrlCompletion.Mode</a> </td> <td class="paramname"><em>a0</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>This overloaded constructor allows you to set the Mode to ExeCompletion or FileCompletion without using setMode. Default is FileCompletion. </p></div></div><a class="anchor" name="customEvent"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"> customEvent</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">QEvent </td> <td class="paramname"><em>e</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="dir"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">QString dir</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 directory, as it was given in setDir <dl class="return" compact><dt><b>Returns:</b></dt><dd> the current directory (path or URL) </dd></dl> </p></div></div><a class="anchor" name="isRunning"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">bool isRunning</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>Check whether asynchronous completion is in progress. <dl class="return" compact><dt><b>Returns:</b></dt><dd> true if asynchronous completion is in progress </dd></dl> </p></div></div><a class="anchor" name="makeCompletion"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">QString makeCompletion</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>text</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>Finds completions to the given text. </p> <p> Remote URLs are listed with KIO. For performance reasons, local files are listed with KIO only if KURLCOMPLETION_LOCAL_KIO is set. The completion is done asyncronously if KIO is used. </p> <p> Returns the first match for user, environment, and local dir completion and QString() for asynchronous completion (KIO or threaded). </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 to complete </td></tr> </table></dl> <p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> the first match, or QString() if not found </dd></dl> </p></div></div><a class="anchor" name="mode"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"><a href="../kio/KUrlCompletion.html#Mode">KUrlCompletion.Mode</a> mode</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 completion mode: exe or file completion (default FileCompletion). <dl class="return" compact><dt><b>Returns:</b></dt><dd> the completion mode </dd></dl> </p></div></div><a class="anchor" name="postProcessMatch"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"> postProcessMatch</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>match</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="postProcessMatches"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"> postProcessMatches</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">QStringList </td> <td class="paramname"><em>matches</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="replaceEnv"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">bool replaceEnv</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>Checks whether environment variables are completed and whether they are replaced internally while finding completions. Default is enabled. <dl class="return" compact><dt><b>Returns:</b></dt><dd> true if environment vvariables will be replaced </dd></dl> </p></div></div><a class="anchor" name="replaceHome"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">bool replaceHome</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 whether ~username is completed and whether ~username is replaced internally with the user's home directory while finding completions. Default is enabled. <dl class="return" compact><dt><b>Returns:</b></dt><dd> true to replace tilde with the home directory </dd></dl> </p></div></div><a class="anchor" name="replacedPath"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">QString replacedPath</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>text</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p><dl class="internal" compact><dt><b>Internal:</b></dt><dd> I'll let ossi add a real one to KShell :) </dd></dl> </p></div></div><a class="anchor" name="setDir"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"> setDir</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>dir</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>Sets the current directory (used as base for completion). Default = $HOME. </p><dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td></td><td valign="top"><em>dir</em> </td><td> the current directory, either as a path or URL </td></tr> </table></dl> <p> </p></div></div><a class="anchor" name="setMode"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"> setMode</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="../kio/KUrlCompletion.html#Mode">KUrlCompletion.Mode</a> </td> <td class="paramname"><em>mode</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>Changes the completion mode: exe or file completion </p><dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td></td><td valign="top"><em>mode</em> </td><td> the new completion mode </td></tr> </table></dl> <p> </p></div></div><a class="anchor" name="setReplaceEnv"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"> setReplaceEnv</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">bool </td> <td class="paramname"><em>replace</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>Enables/disables completion and replacement (internally) of environment variables in URLs. Default is enabled. </p><dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td></td><td valign="top"><em>replace</em> </td><td> true to replace environment variables </td></tr> </table></dl> <p> </p></div></div><a class="anchor" name="setReplaceHome"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"> setReplaceHome</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">bool </td> <td class="paramname"><em>replace</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>Enables/disables completion of ~username and replacement (internally) of ~username with the user's home directory. Default is enabled. </p><dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td></td><td valign="top"><em>replace</em> </td><td> true to replace tilde with the home directory </td></tr> </table></dl> <p> </p></div></div><a class="anchor" name="stop"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"> stop</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>Stops asynchronous completion. </p></div></div><hr><h2>Static Method Documentation</h2><a class="anchor" name="replacedPath"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">QString replacedPath</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">bool </td> <td class="paramname"><em>replaceHome</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype">bool </td> <td class="paramname"><em>replaceEnv=1</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p><dl class="internal" compact><dt><b>Internal:</b></dt><dd> I'll let ossi add a real one to KShell :) </dd></dl> </p></div></div><hr><h2>Enumeration Documentation</h2><a class="anchor" name="Mode"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr><td class="memname">Mode</td> </tr> </table> </div> <div class="memdoc"><p>Determines how completion is done. <li> ExeCompletion - executables in $PATH or with full path. </li> <li> FileCompletion - all files with full path or in dir(), URLs </li> are listed using KIO. <li> DirCompletion - Same as FileCompletion but only returns directories. </li> </p><dl compact><dt><b>Enumerator: </b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"><tr><td valign="top"><em>ExeCompletion</em> = 1</td><td><tr><td valign="top"><em>FileCompletion</em> </td><td><tr><td valign="top"><em>DirCompletion</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>