/usr/share/gtk-doc/html/pygnomevfs/gnomevfs-functions.html is in python-gnome2-doc 2.28.1+dfsg-1ubuntu2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 | <html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>gnomevfs Functions</title><meta name="generator" content="DocBook XSL Stylesheets V1.75.1"><link rel="home" href="index.html" title="Python gnomevfs Reference Manual"><link rel="up" href="gnomevfs-class-reference.html" title="The gnomevfs class reference"><link rel="prev" href="class-gnomevfs-volume.html" title="gnomevfs.Volume"><link rel="next" href="gnomevfs-constants.html" title="gnomevfs Constants"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">gnomevfs Functions</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="class-gnomevfs-volume.html">Prev</a> </td><th width="60%" align="center">The gnomevfs class reference</th><td width="20%" align="right"> <a accesskey="n" href="gnomevfs-constants.html">Next</a></td></tr></table><hr></div><div class="refentry" title="gnomevfs Functions"><a name="gnomevfs-functions"></a><div class="titlepage"></div><div class="refnamediv"><h2>gnomevfs Functions</h2><p>gnomevfs Functions — Additional functions which are not part of a class.</p></div><div class="refsect1" title="Synopsis"><a name="id472812"></a><h2>Synopsis</h2><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="gnomevfs-functions.html#function-gnomevfs--create" title="gnomevfs.create">gnomevfs.create</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>uri</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>open_mode</code></strong></span><span class="initializer">=gnomevfs.OPEN_NONE</span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>exclusive</code></strong></span><span class="initializer">=False</span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>perm</code></strong></span><span class="initializer">=0666</span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="gnomevfs-functions.html#function-gnomevfs--get_file_info" title="gnomevfs.get_file_info">gnomevfs.get_file_info</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>uri</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>options</code></strong></span><span class="initializer">=gnomevfs.FILE_INFO_DEFAULT</span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="gnomevfs-functions.html#function-gnomevfs--set_file_info" title="gnomevfs.set_file_info">gnomevfs.set_file_info</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>uri</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>info</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>mask</code></strong></span><span class="initializer">=gnomevfs.SET_FILE_INFO_NONE</span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="gnomevfs-functions.html#function-gnomevfs--truncate" title="gnomevfs.truncate">gnomevfs.truncate</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>uri</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>length</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="gnomevfs-functions.html#function-gnomevfs--make_directory" title="gnomevfs.make_directory">gnomevfs.make_directory</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>uri</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>perm</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="gnomevfs-functions.html#function-gnomevfs--remove_directory" title="gnomevfs.remove_directory">gnomevfs.remove_directory</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>uri</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="gnomevfs-functions.html#function-gnomevfs--unlink" title="gnomevfs.unlink">gnomevfs.unlink</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>uri</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="gnomevfs-functions.html#function-gnomevfs--exists" title="gnomevfs.exists">gnomevfs.exists</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>uri</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="gnomevfs-functions.html#function-gnomevfs--format_file_size_for_display" title="gnomevfs.format_file_size_for_display">gnomevfs.format_file_size_for_display</a></span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>size</code></em></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="gnomevfs-functions.html#function-gnomevfs--get_mime_type" title="gnomevfs.get_mime_type">gnomevfs.get_mime_type</a></span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>uri</code></em></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="gnomevfs-functions.html#function-gnomevfs--get_mime_type_for_data" title="gnomevfs.get_mime_type_for_data">gnomevfs.get_mime_type_for_data</a></span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>data</code></em></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="gnomevfs-functions.html#function-gnomevfs--mime_get_icon" title="gnomevfs.mime_get_icon">gnomevfs.mime_get_icon</a></span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>mime_type</code></em></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname">gnomevfs.mime_set_icon</span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="gnomevfs-functions.html#function-gnomevfs--mime_get_description" title="gnomevfs.mime_get_description">gnomevfs.mime_get_description</a></span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>mime_type</code></em></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname">gnomevfs.mime_set_description</span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="gnomevfs-functions.html#function-gnomevfs--mime_can_be_executable" title="gnomevfs.mime_can_be_executable">gnomevfs.mime_can_be_executable</a></span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>mime_type</code></em></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname">gnomevfs.mime_set_can_be_executable</span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="gnomevfs-functions.html#function-gnomevfs--monitor_add" title="gnomevfs.monitor_add">gnomevfs.monitor_add</a></span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>text_uri</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>monitor_type</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>callback</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_data</code></em></span><span class="initializer">=None</span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="gnomevfs-functions.html#function-gnomevfs--monitor_cancel" title="gnomevfs.monitor_cancel">gnomevfs.monitor_cancel</a></span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>id</code></em></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="gnomevfs-functions.html#function-gnomevfs--read_entire_file" title="gnomevfs.read_entire_file">gnomevfs.read_entire_file</a></span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>text_uri</code></em></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="gnomevfs-functions.html#function-gnomevfs--mime_get_default_application" title="gnomevfs.mime_get_default_application">gnomevfs.mime_get_default_application</a></span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>mime_type</code></em></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname">gnomevfs.xfer_uri</span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname">gnomevfs.xfer_uri_list</span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname">gnomevfs.xfer_delete_list</span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname">gnomevfs.mime_get_default_action_type</span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname">gnomevfs.mime_get_default_action</span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname">gnomevfs.mime_get_default_component</span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname">gnomevfs.mime_get_short_list_components</span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname">gnomevfs.mime_get_short_list_applications</span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname">gnomevfs.mime_get_all_applications</span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname">gnomevfs.mime_get_all_components</span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname">gnomevfs.mime_set_default_action_type</span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname">gnomevfs.mime_set_default_application</span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname">gnomevfs.mime_set_default_component</span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname">gnomevfs.mime_set_short_list_applications</span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname">gnomevfs.mime_set_short_list_components</span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname">gnomevfs.mime_add_application_to_short_list</span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname">gnomevfs.mime_remove_application_from_short_list</span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname">gnomevfs.mime_add_component_to_short_list</span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname">gnomevfs.mime_remove_component_from_short_list</span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname">gnomevfs.mime_add_extension</span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname">gnomevfs.mime_remove_extension</span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname">gnomevfs.mime_extend_all_applications</span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname">gnomevfs.mime_remove_from_all_applications</span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname">gnomevfs.mime_application_new_from_id</span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname">gnomevfs.connect_to_server</span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname">gnomevfs.escape_string</span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname">gnomevfs.escape_path_string</span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname">gnomevfs.escape_host_and_path_string</span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname">gnomevfs.escape_slashes</span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname">gnomevfs.escape_set</span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname">gnomevfs.unescape_string</span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname">gnomevfs.make_uri_canonical</span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname">gnomevfs.make_path_name_canonical</span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname">gnomevfs.unescape_string_for_display</span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname">gnomevfs.get_local_path_from_uri</span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname">gnomevfs.get_uri_from_local_path</span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname">gnomevfs.is_executable_command_string</span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname">gnomevfs.get_volume_free_space</span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname">gnomevfs.icon_path_from_filename</span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname">gnomevfs.open_fd</span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname">gnomevfs.is_primary_thread</span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname">gnomevfs.format_uri_for_display</span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname">gnomevfs.make_uri_from_input</span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname">gnomevfs.make_uri_from_input_with_dirs</span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname">gnomevfs.make_uri_canonical_strip_fragment</span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname">gnomevfs.uris_match</span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname">gnomevfs.get_uri_scheme</span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname">gnomevfs.make_uri_from_shell_arg</span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname">gnomevfs.url_show</span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname">gnomevfs.resolve</span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname">gnomevfs.dns_sd_browse_sync</span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname">gnomevfs.dns_sd_resolve_sync</span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname">gnomevfs.dns_sd_list_browse_domains_sync</span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname">gnomevfs.get_default_browse_domains</span>(<span class="methodparam"></span>)</code>
</pre></div><div class="refsect1" title="Description"><a name="id487081"></a><h2>Description</h2><p>These functions are part of the gnomevfs module but are not associated with a specific class.</p></div><div class="refsect1" title="Functions"><a name="id487093"></a><h2>Functions</h2><div class="refsect2" title="gnomevfs.create"><a name="function-gnomevfs--create"></a><h3>gnomevfs.create</h3><pre class="programlisting">
<code class="methodsynopsis"> def <span class="methodname">gnomevfs.create</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>uri</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>open_mode</code></strong></span><span class="initializer">=gnomevfs.OPEN_NONE</span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>exclusive</code></strong></span><span class="initializer">=False</span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>perm</code></strong></span><span class="initializer">=0666</span></span>)</code>
</pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>uri</code></strong>:</span></p></td><td>The URI to create.</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>open_mode</code></strong>:</span></p></td><td>Mode to leave the file in after creation (or gnomevfs.OPEN_MODE_NONE to leave the file closed).</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>exclusive</code></strong>:</span></p></td><td>Whether the file should be created in "exclusive" mode. i.e. if this flag is nonzero, The operation will fail if a file with the same name already exists.</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>perm</code></strong>:</span></p></td><td>Or'd set of <a class="link" href="gnomevfs-constants.html#gnomevfs-constants-file-permissions" title="gnomevfs File Permissions">file permissions flags</a></td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></p></td><td>A <a class="link" href="class-gnomevfs-handle.html" title="gnomevfs.Handle">gnomevfs.Handle</a>.</td></tr></tbody></table><p>Create and open <strong class="parameter"><code>uri</code></strong> according to <strong class="parameter"><code>open_mode</code></strong>.</p></div><div class="refsect2" title="gnomevfs.get_file_info"><a name="function-gnomevfs--get_file_info"></a><h3>gnomevfs.get_file_info</h3><pre class="programlisting">
<code class="methodsynopsis"> def <span class="methodname">gnomevfs.get_file_info</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>uri</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>options</code></strong></span><span class="initializer">=gnomevfs.FILE_INFO_DEFAULT</span></span>)</code>
</pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>uri</code></strong>:</span></p></td><td>The URI to retrieve information for.</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>options</code></strong>:</span></p></td><td>Or'd set of file info options.</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></p></td><td>A <a class="link" href="class-gnomevfs-fileinfo.html" title="gnomevfs.FileInfo">gnomevfs.FileInfo</a></td></tr></tbody></table><p>Retrieve information about <strong class="parameter"><code>uri</code></strong>.</p></div><div class="refsect2" title="gnomevfs.set_file_info"><a name="function-gnomevfs--set_file_info"></a><h3>gnomevfs.set_file_info</h3><pre class="programlisting">
<code class="methodsynopsis"> def <span class="methodname">gnomevfs.set_file_info</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>uri</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>info</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>mask</code></strong></span><span class="initializer">=gnomevfs.SET_FILE_INFO_NONE</span></span>)</code>
</pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>uri</code></strong>:</span></p></td><td>The URI to set information on.</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>info</code></strong>:</span></p></td><td><a class="link" href="class-gnomevfs-fileinfo.html" title="gnomevfs.FileInfo">gnomevfs.FileInfo</a> with the information to set.</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>mask</code></strong>:</span></p></td><td>Or'd set of <a class="link" href="gnomevfs-constants.html#gnomevfs-constants-fileinfo-setmask" title="gnomevfs FileInfo Set Mask">file info set flags</a>.</td></tr></tbody></table><p>Set file information for <strong class="parameter"><code>uri</code></strong>. Only the information for which the corresponding bit in <strong class="parameter"><code>mask</code></strong> is set is actually modified.</p></div><div class="refsect2" title="gnomevfs.truncate"><a name="function-gnomevfs--truncate"></a><h3>gnomevfs.truncate</h3><pre class="programlisting">
<code class="methodsynopsis"> def <span class="methodname">gnomevfs.truncate</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>uri</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>length</code></strong></span></span>)</code>
</pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>uri</code></strong>:</span></p></td><td>The URI of the file to truncate.</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>length</code></strong>:</span></p></td><td>The length to truncate to.</td></tr></tbody></table><p>Truncate a file to a specific length.</p></div><div class="refsect2" title="gnomevfs.make_directory"><a name="function-gnomevfs--make_directory"></a><h3>gnomevfs.make_directory</h3><pre class="programlisting">
<code class="methodsynopsis"> def <span class="methodname">gnomevfs.make_directory</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>uri</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>perm</code></strong></span></span>)</code>
</pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>uri</code></strong>:</span></p></td><td>The URI of the directory to create.</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>perm</code></strong>:</span></p></td><td>Or'd set of <a class="link" href="gnomevfs-constants.html#gnomevfs-constants-file-permissions" title="gnomevfs File Permissions">file permissions flags</a>.</td></tr></tbody></table><p>Create a directory with the given name and permissions.</p></div><div class="refsect2" title="gnomevfs.remove_directory"><a name="function-gnomevfs--remove_directory"></a><h3>gnomevfs.remove_directory</h3><pre class="programlisting">
<code class="methodsynopsis"> def <span class="methodname">gnomevfs.remove_directory</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>uri</code></strong></span></span>)</code>
</pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>uri</code></strong>:</span></p></td><td>The URI of the directory to remove.</td></tr></tbody></table><p>Remove a directory.</p></div><div class="refsect2" title="gnomevfs.unlink"><a name="function-gnomevfs--unlink"></a><h3>gnomevfs.unlink</h3><pre class="programlisting">
<code class="methodsynopsis"> def <span class="methodname">gnomevfs.unlink</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>uri</code></strong></span></span>)</code>
</pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>uri</code></strong>:</span></p></td><td>The URI of the file to unlink</td></tr></tbody></table><p>Unlink (delete) a URI.</p></div><div class="refsect2" title="gnomevfs.exists"><a name="function-gnomevfs--exists"></a><h3>gnomevfs.exists</h3><pre class="programlisting">
<code class="methodsynopsis"> def <span class="methodname">gnomevfs.exists</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>uri</code></strong></span></span>)</code>
</pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>uri</code></strong>:</span></p></td><td>The URI to check.</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></p></td><td>True if the URI exists.</td></tr></tbody></table><p>Check if a given URI exists.</p></div><div class="refsect2" title="gnomevfs.format_file_size_for_display"><a name="function-gnomevfs--format_file_size_for_display"></a><h3>gnomevfs.format_file_size_for_display</h3><pre class="programlisting">
<code class="methodsynopsis"> def <span class="methodname">gnomevfs.format_file_size_for_display</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>size</code></em></span></span>)</code>
</pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><em class="parameter"><code>size</code></em>:</span></p></td><td>The size of the file in bytes</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></p></td><td>A string with the printable size</td></tr></tbody></table><p>Formats <em class="parameter"><code>size</code></em> in a way that is easy for the user to read. Gives the size in bytes, kilobytes, megabytes or gigabytes, choosing whatever is appropriate.</p></div><div class="refsect2" title="gnomevfs.get_mime_type"><a name="function-gnomevfs--get_mime_type"></a><h3>gnomevfs.get_mime_type</h3><pre class="programlisting">
<code class="methodsynopsis"> def <span class="methodname">gnomevfs.get_mime_type</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>uri</code></em></span></span>)</code>
</pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><em class="parameter"><code>uri</code></em>:</span></p></td><td>The URI to retrieve the mime type for.</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></p></td><td>A string containing the mime type.</td></tr></tbody></table><p>Determine the mime type of <em class="parameter"><code>uri</code></em>. The mime type is determined in the same way as by <a class="link" href="gnomevfs-functions.html#function-gnomevfs--get_file_info" title="gnomevfs.get_file_info">gnomevfs.get_file_info</a>.</p></div><div class="refsect2" title="gnomevfs.get_mime_type_for_data"><a name="function-gnomevfs--get_mime_type_for_data"></a><h3>gnomevfs.get_mime_type_for_data</h3><pre class="programlisting">
</pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><em class="parameter"><code>data</code></em>:</span></p></td><td>A string containing the data.</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></p></td><td>A string containing the mime type.</td></tr></tbody></table><p>Tries to guess the mime type of the data in <em class="parameter"><code>data</code></em> using magic patterns.</p></div><div class="refsect2" title="gnomevfs.mime_get_icon"><a name="function-gnomevfs--mime_get_icon"></a><h3>gnomevfs.mime_get_icon</h3><pre class="programlisting">
<code class="methodsynopsis"> def <span class="methodname">gnomevfs.mime_get_icon</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>mime_type</code></em></span></span>)</code>
</pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><em class="parameter"><code>mime_type</code></em>:</span></p></td><td>A string with the mime type.</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></p></td><td>A string with an icon name.</td></tr></tbody></table><p>Query the MIME database for an icon representing <em class="parameter"><code>mime_type</code></em>. It usually returns a filename without path information, e.g. "i-chardev.png", and sometimes does not have an extension, e.g. "i-regular" if the icon is supposed to be image type agnostic between icon themes. Icons are generic and not theme specific. These will not necessarily match with the icons a user sees in Nautilus, you have been warned.</p></div><div class="refsect2" title="gnomevfs.mime_get_description"><a name="function-gnomevfs--mime_get_description"></a><h3>gnomevfs.mime_get_description</h3><pre class="programlisting">
<code class="methodsynopsis"> def <span class="methodname">gnomevfs.mime_get_description</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>mime_type</code></em></span></span>)</code>
</pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><em class="parameter"><code>mime_type</code></em>:</span></p></td><td>The mime type to query.</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></p></td><td>A description of the mime type.</td></tr></tbody></table><p>Query the MIME database for a description of <em class="parameter"><code>mime_type</code></em>.</p></div><div class="refsect2" title="gnomevfs.mime_can_be_executable"><a name="function-gnomevfs--mime_can_be_executable"></a><h3>gnomevfs.mime_can_be_executable</h3><pre class="programlisting">
<code class="methodsynopsis"> def <span class="methodname">gnomevfs.mime_can_be_executable</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>mime_type</code></em></span></span>)</code>
</pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><em class="parameter"><code>mime_type</code></em>:</span></p></td><td>The mime type to query.</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></p></td><td>True if files of <em class="parameter"><code>mime_type</code></em> can be executable, False otherwise.</td></tr></tbody></table><p>Check whether files of <em class="parameter"><code>mime_type</code></em> might conceivably be executable. Default for known types is False. Default for unknown types is True.</p></div><div class="refsect2" title="gnomevfs.monitor_add"><a name="function-gnomevfs--monitor_add"></a><h3>gnomevfs.monitor_add</h3><pre class="programlisting">
<code class="methodsynopsis"> def <span class="methodname">gnomevfs.monitor_add</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>text_uri</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>monitor_type</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>callback</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>extra</code></em></span><span class="initializer">=None</span></span>)</code>
</pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><em class="parameter"><code>text_uri</code></em>:</span></p></td><td>String representing the URI to monitor.</td></tr><tr><td><p><span class="term"><em class="parameter"><code>monitor_type</code></em>:</span></p></td><td>A <a class="link" href="gnomevfs-constants.html#gnomevfs-constants-monitortype" title="gnomevfs Monitor Type Constants">monitor type</a> signifying the type of the URI.</td></tr><tr><td><p><span class="term"><em class="parameter"><code>callback</code></em>:</span></p></td><td>Function to call when the monitor is tripped.</td></tr><tr><td><p><span class="term"><em class="parameter"><code>user_data</code></em>:</span></p></td><td>Data to pass to <em class="parameter"><code>callback</code></em></td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></p></td><td>An identifier representing this monitor.</td></tr></tbody></table><p>Watch the file or directory at <em class="parameter"><code>text_uri</code></em> for changes (or the creation/deletion of the file) and call <em class="parameter"><code>callback</code></em> when there is a change. If a directory monitor is added, <em class="parameter"><code>callback</code></em> is notified when any file in the directory changes.</p></div><div class="refsect2" title="gnomevfs.monitor_cancel"><a name="function-gnomevfs--monitor_cancel"></a><h3>gnomevfs.monitor_cancel</h3><pre class="programlisting">
<code class="methodsynopsis"> def <span class="methodname">gnomevfs.monitor_cancel</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>id</code></em></span></span>)</code>
</pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><em class="parameter"><code>id</code></em>:</span></p></td><td>Identifier which was given by <a class="link" href="gnomevfs-functions.html#function-gnomevfs--monitor_add" title="gnomevfs.monitor_add">monitor_add</a></td></tr></tbody></table><p>Cancel the monitor pointed to by <em class="parameter"><code>id</code></em></p></div><div class="refsect2" title="gnomevfs.read_entire_file"><a name="function-gnomevfs--read_entire_file"></a><h3>gnomevfs.read_entire_file</h3><pre class="programlisting">
<code class="methodsynopsis"> def <span class="methodname">gnomevfs.read_entire_file</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>text_uri</code></em></span></span>)</code>
</pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><em class="parameter"><code>text_uri</code></em>:</span></p></td><td>String containing the URI of the file to read.</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></p></td><td>String containing the data in the file.</td></tr></tbody></table><p>Reads an entire file into memory for convenience. Beware of accidentally loading large files into memory with this function.</p></div><div class="refsect2" title="gnomevfs.mime_get_default_application"><a name="function-gnomevfs--mime_get_default_application"></a><h3>gnomevfs.mime_get_default_application</h3><pre class="programlisting">
<code class="methodsynopsis"> def <span class="methodname">gnomevfs.mime_get_default_application</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>mime_type</code></em></span></span>)</code>
</pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><em class="parameter"><code>mime_type</code></em>:</span></p></td><td>Mime type to query.</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></p></td><td>Information about the application configured as the default handler for <em class="parameter"><code>mime_type</code></em>.</td></tr></tbody></table><p>Query the MIME database for the default Bonobo component to be activated to view files of MIME type <em class="parameter"><code>mime_type</code></em></p></div></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="class-gnomevfs-volume.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="gnomevfs-class-reference.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="gnomevfs-constants.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">gnomevfs.Volume </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> gnomevfs Constants</td></tr></table></div></body></html>
|