<?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>KFile</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>KFile Class Reference</h1> <code>from PyKDE4.kio import *</code> <p> <h2>Detailed Description</h2> <p>KFile is a class which provides a namespace for some enumerated values associated with the kfile library. You will never need to construct a KFile object itself. </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="#FileView">FileView</a> </td><td class="memItemRight" valign="bottom">{ Default, Simple, Detail, SeparateDirs, PreviewContents, PreviewInfo, Tree, DetailTree, FileViewMax }</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="#Mode">Mode</a> </td><td class="memItemRight" valign="bottom">{ File, Directory, Files, ExistingOnly, LocalOnly, ModeMax }</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="#SelectionMode">SelectionMode</a> </td><td class="memItemRight" valign="bottom">{ Single, Multi, Extended, NoSelection }</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="#KFile">__init__</a> (self)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#isDefaultView">isDefaultView</a> (self, <a href="../kio/KFile.html#FileView">KFile.FileView</a> view)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#isDetailTreeView">isDetailTreeView</a> (self, <a href="../kio/KFile.html#FileView">KFile.FileView</a> view)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#isDetailView">isDetailView</a> (self, <a href="../kio/KFile.html#FileView">KFile.FileView</a> view)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#isPreviewContents">isPreviewContents</a> (self, <a href="../kio/KFile.html#FileView">KFile.FileView</a> view)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#isPreviewInfo">isPreviewInfo</a> (self, <a href="../kio/KFile.html#FileView">KFile.FileView</a> view)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#isSeparateDirs">isSeparateDirs</a> (self, <a href="../kio/KFile.html#FileView">KFile.FileView</a> view)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#isSimpleView">isSimpleView</a> (self, <a href="../kio/KFile.html#FileView">KFile.FileView</a> view)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#isSortByDate">isSortByDate</a> (self, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qdir::sortflags.html">QDir.SortFlags</a> sort)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#isSortByName">isSortByName</a> (self, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qdir::sortflags.html">QDir.SortFlags</a> sort)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#isSortBySize">isSortBySize</a> (self, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qdir::sortflags.html">QDir.SortFlags</a> sort)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#isSortByType">isSortByType</a> (self, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qdir::sortflags.html">QDir.SortFlags</a> sort)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#isSortCaseInsensitive">isSortCaseInsensitive</a> (self, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qdir::sortflags.html">QDir.SortFlags</a> sort)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#isSortDirsFirst">isSortDirsFirst</a> (self, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qdir::sortflags.html">QDir.SortFlags</a> sort)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#isTreeView">isTreeView</a> (self, <a href="../kio/KFile.html#FileView">KFile.FileView</a> view)</td></tr> </table> <hr><h2>Method Documentation</h2><a class="anchor" name="KFile"></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"></div></div><a class="anchor" name="isDefaultView"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">bool isDefaultView</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/KFile.html#FileView">KFile.FileView</a> </td> <td class="paramname"><em>view</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="isDetailTreeView"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">bool isDetailTreeView</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/KFile.html#FileView">KFile.FileView</a> </td> <td class="paramname"><em>view</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="isDetailView"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">bool isDetailView</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/KFile.html#FileView">KFile.FileView</a> </td> <td class="paramname"><em>view</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="isPreviewContents"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">bool isPreviewContents</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/KFile.html#FileView">KFile.FileView</a> </td> <td class="paramname"><em>view</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="isPreviewInfo"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">bool isPreviewInfo</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/KFile.html#FileView">KFile.FileView</a> </td> <td class="paramname"><em>view</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="isSeparateDirs"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">bool isSeparateDirs</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/KFile.html#FileView">KFile.FileView</a> </td> <td class="paramname"><em>view</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="isSimpleView"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">bool isSimpleView</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/KFile.html#FileView">KFile.FileView</a> </td> <td class="paramname"><em>view</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="isSortByDate"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">bool isSortByDate</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/qdir::sortflags.html">QDir.SortFlags</a> </td> <td class="paramname"><em>sort</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="isSortByName"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">bool isSortByName</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/qdir::sortflags.html">QDir.SortFlags</a> </td> <td class="paramname"><em>sort</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="isSortBySize"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">bool isSortBySize</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/qdir::sortflags.html">QDir.SortFlags</a> </td> <td class="paramname"><em>sort</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="isSortByType"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">bool isSortByType</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/qdir::sortflags.html">QDir.SortFlags</a> </td> <td class="paramname"><em>sort</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="isSortCaseInsensitive"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">bool isSortCaseInsensitive</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/qdir::sortflags.html">QDir.SortFlags</a> </td> <td class="paramname"><em>sort</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="isSortDirsFirst"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">bool isSortDirsFirst</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/qdir::sortflags.html">QDir.SortFlags</a> </td> <td class="paramname"><em>sort</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="isTreeView"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">bool isTreeView</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/KFile.html#FileView">KFile.FileView</a> </td> <td class="paramname"><em>view</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"></div></div><hr><h2>Enumeration Documentation</h2><a class="anchor" name="FileView"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr><td class="memname">FileView</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>Default</em> = 0</td><td><tr><td valign="top"><em>Simple</em> = 1</td><td><tr><td valign="top"><em>Detail</em> = 2</td><td><tr><td valign="top"><em>SeparateDirs</em> = 4</td><td><tr><td valign="top"><em>PreviewContents</em> = 8</td><td><tr><td valign="top"><em>PreviewInfo</em> = 16</td><td><tr><td valign="top"><em>Tree</em> = 32</td><td><tr><td valign="top"><em>DetailTree</em> = 64</td><td><tr><td valign="top"><em>FileViewMax</em> = 65536</td><td></table> </dl> </div></div><p><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>Modes of operation for the dialog. <li> <b>File</b> - Get a single file name from the user. </li> <li> <b>Directory</b> - Get a directory name from the user. </li> <li> <b>Files</b> - Get multiple file names from the user. </li> <li> <b>ExistingOnly</b> - Never return a filename which does not exist yet </li> <li> <b>LocalOnly</b> - Don't return remote filenames </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><a class="anchor" name="SelectionMode"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr><td class="memname">SelectionMode</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>Single</em> = 1</td><td><tr><td valign="top"><em>Multi</em> = 2</td><td><tr><td valign="top"><em>Extended</em> = 4</td><td><tr><td valign="top"><em>NoSelection</em> = 8</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>