<?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>Nepomuk.Query.FileQuery</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>FileQuery Class Reference</h1> <code>from PyKDE4.nepomuk import *</code> <p> Inherits: <a href="../nepomuk/Nepomuk.Query.Query.html">Nepomuk.Query.Query</a><br /> Namespace: <a href="../nepomuk/Nepomuk.Query.html">Nepomuk.Query</a><br /> <h2>Detailed Description</h2> <p>\class FileQuery filequery.h Nepomuk/Query/FileQuery </p> <p> A Nepomuk desktop query specialized for file searches. </p> <p> FileQuery is an extension to Query which adds some syntactic sugar for dealing with file queries. This includes a restriction of the results to files and the possibility to restrict the search to specific folders via setIncludeFolders() and setExcludeFolders(). </p> <p> <dl class="warning" compact><dt><b>Warning:</b></dt><dd> %FileQuery does only return files and folders as results. </dd></dl> </p> <p> <dl class="author" compact><dt><b>Author:</b></dt><dd> Sebastian Trueg <trueg@kde.org> </dd></dl> </p> <p> <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.4 </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="#FileModeFlags">FileModeFlags</a> </td><td class="memItemRight" valign="bottom">{ QueryFiles, QueryFolders, QueryFilesAndFolders }</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="#FileQuery">__init__</a> (self)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#FileQuery">__init__</a> (self, <a href="../nepomuk/Nepomuk.Query.Query.html">Nepomuk.Query.Query</a> query)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#FileQuery">__init__</a> (self, <a href="../nepomuk/Nepomuk.Query.Term.html">Nepomuk.Query.Term</a> term)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#addExcludeFolder">addExcludeFolder</a> (self, <a href="../kdecore/KUrl.html">KUrl</a> folder)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#addIncludeFolder">addIncludeFolder</a> (self, <a href="../kdecore/KUrl.html">KUrl</a> folder)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#addIncludeFolder">addIncludeFolder</a> (self, <a href="../kdecore/KUrl.html">KUrl</a> folder, bool recursive)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">{<a href="../kdecore/KUrl.html">KUrl</a>:bool} </td><td class="memItemRight" valign="bottom"><a class="el" href="#allIncludeFolders">allIncludeFolders</a> (self)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kdecore/KUrl.List.html">KUrl.List</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#excludeFolders">excludeFolders</a> (self)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../nepomuk/Nepomuk.Query.FileQuery.html">Nepomuk.Query.FileQuery.FileMode</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#fileMode">fileMode</a> (self)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kdecore/KUrl.List.html">KUrl.List</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#includeFolders">includeFolders</a> (self)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setExcludeFolders">setExcludeFolders</a> (self, <a href="../kdecore/KUrl.List.html">KUrl.List</a> folders)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setFileMode">setFileMode</a> (self, <a href="../nepomuk/Nepomuk.Query.FileQuery.html">Nepomuk.Query.FileQuery.FileMode</a> mode)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setIncludeFolders">setIncludeFolders</a> (self, <a href="../kdecore/KUrl.List.html">KUrl.List</a> folders)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setIncludeFolders">setIncludeFolders</a> (self, {<a href="../kdecore/KUrl.html">KUrl</a>:bool} folders)</td></tr> </table> <hr><h2>Method Documentation</h2><a class="anchor" name="FileQuery"></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>Create an empty invalid file query object. </p></div></div><a class="anchor" name="FileQuery"></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="../nepomuk/Nepomuk.Query.Query.html">Nepomuk.Query.Query</a> </td> <td class="paramname"><em>query</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>Copy constructor. </p></div></div><a class="anchor" name="FileQuery"></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="../nepomuk/Nepomuk.Query.Term.html">Nepomuk.Query.Term</a> </td> <td class="paramname"><em>term</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>Create a file query with root term <b>term.</b> </p> <p> <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.6 </dd></dl> </p></div></div><a class="anchor" name="addExcludeFolder"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"> addExcludeFolder</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="../kdecore/KUrl.html">KUrl</a> </td> <td class="paramname"><em>folder</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>Add a folder to exclude from the search. If exclude folders are set the query will be restricted to files that are not in that folder and its subfolders. </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>folder</em> </td><td> The folder to exclude from the search. </td></tr> </table></dl> <p> \sa setExcludeFolders, excludeFolders, addIncludeFolder </p></div></div><a class="anchor" name="addIncludeFolder"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"> addIncludeFolder</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="../kdecore/KUrl.html">KUrl</a> </td> <td class="paramname"><em>folder</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>Add a folder to include in the search path. If include folders are set the query will be restricted to files from that folders and optionally their subfolders. </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>folder</em> </td><td> The folder to include in the search. </td></tr> </table></dl> <p> </p><dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td></td><td valign="top"><em>recursive</em> </td><td> If <b>true</b> subfolders of <b>folder</b> will be searched, too. </td></tr> </table></dl> <p> \sa setIncludeFolders, includeFolders, addExcludeFolder </p> <p> <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.6 </dd></dl> </p></div></div><a class="anchor" name="addIncludeFolder"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"> addIncludeFolder</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="../kdecore/KUrl.html">KUrl</a> </td> <td class="paramname"><em>folder</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype">bool </td> <td class="paramname"><em>recursive</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>Add a folder to include in the search path. If include folders are set the query will be restricted to files from that folders and optionally their subfolders. </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>folder</em> </td><td> The folder to include in the search. </td></tr> </table></dl> <p> </p><dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td></td><td valign="top"><em>recursive</em> </td><td> If <b>true</b> subfolders of <b>folder</b> will be searched, too. </td></tr> </table></dl> <p> \sa setIncludeFolders, includeFolders, addExcludeFolder </p> <p> <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.6 </dd></dl> </p></div></div><a class="anchor" name="allIncludeFolders"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">{<a href="../kdecore/KUrl.html">KUrl</a>:bool} allIncludeFolders</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>The hash of include folders set via addIncludeFolder() and setIncludeFolders() including their recursive flag. </p> <p> \sa includeFolders, addIncludeFolder, setIncludeFolders, excludeFolders </p> <p> <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.6 </dd></dl> </p></div></div><a class="anchor" name="excludeFolders"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"><a href="../kdecore/KUrl.List.html">KUrl.List</a> excludeFolders</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>The list of exclude folders set via addExcludeFolder() and setExcludeFolders(). </p> <p> \sa addExcludeFolder, setExcludeFolders, includeFolders </p></div></div><a class="anchor" name="fileMode"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"><a href="../nepomuk/Nepomuk.Query.FileQuery.html">Nepomuk.Query.FileQuery.FileMode</a> fileMode</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><dl class="return" compact><dt><b>Returns:</b></dt><dd> The file mode set in setFileMode() </dd></dl> </p> <p> <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.5 </dd></dl> </p></div></div><a class="anchor" name="includeFolders"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"><a href="../kdecore/KUrl.List.html">KUrl.List</a> includeFolders</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>The list of include folders set via addIncludeFolder() and setIncludeFolders(). </p> <p> \sa allIncludeFolders, addIncludeFolder, setIncludeFolders, excludeFolders </p></div></div><a class="anchor" name="setExcludeFolders"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"> setExcludeFolders</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="../kdecore/KUrl.List.html">KUrl.List</a> </td> <td class="paramname"><em>folders</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p> </p><dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td></td><td valign="top"><em>folders</em> </td><td> The folders to exclude from the search. </td></tr> </table></dl> <p> \sa addExcludeFolder, excludeFolders, setIncludeFolders </p></div></div><a class="anchor" name="setFileMode"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"> setFileMode</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="../nepomuk/Nepomuk.Query.FileQuery.html">Nepomuk.Query.FileQuery.FileMode</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>Set the file mode, i.e. wether the query should return files and folders or only files or only folders. By default both files and folders are returned. </p> <p> \sa fileMode() </p> <p> <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.5 </dd></dl> </p></div></div><a class="anchor" name="setIncludeFolders"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"> setIncludeFolders</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="../kdecore/KUrl.List.html">KUrl.List</a> </td> <td class="paramname"><em>folders</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p> </p><dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td></td><td valign="top"><em>folders</em> </td><td> A hash of the folders to include in the search and their recursive flag. </td></tr> </table></dl> <p> <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.6 </dd></dl> </p></div></div><a class="anchor" name="setIncludeFolders"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"> setIncludeFolders</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="../kdecore/KUrl.html">KUrl</a>:bool} </td> <td class="paramname"><em>folders</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p> </p><dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td></td><td valign="top"><em>folders</em> </td><td> A hash of the folders to include in the search and their recursive flag. </td></tr> </table></dl> <p> <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.6 </dd></dl> </p></div></div><hr><h2>Enumeration Documentation</h2><a class="anchor" name="FileModeFlags"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr><td class="memname">FileModeFlags</td> </tr> </table> </div> <div class="memdoc"><p>An enumeration used in setFileMode() to state wether the query should return files and folders or only files or only folders. </p> <p> <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.5 </dd></dl> </p><dl compact><dt><b>Enumerator: </b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"><tr><td valign="top"><em>QueryFiles</em> = 0x1</td><td><tr><td valign="top"><em>QueryFolders</em> = 0x2</td><td><tr><td valign="top"><em>QueryFilesAndFolders</em> = QueryFiles|QueryFolders</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>