/usr/share/gtk-doc/html/pygnomevfs/class-gnomevfs-uri.html

<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>gnomevfs.URI</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-handle.html" title="gnomevfs.Handle"><link rel="next" href="class-gnomevfs-volume.html" title="gnomevfs.Volume"></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.URI</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="class-gnomevfs-handle.html">Prev</a> </td><th width="60%" align="center">The gnomevfs class reference</th><td width="20%" align="right"> <a accesskey="n" href="class-gnomevfs-volume.html">Next</a></td></tr></table><hr></div><div class="refentry" title="gnomevfs.URI"><a name="class-gnomevfs-uri"></a><div class="titlepage"></div><div class="refnamediv"><h2>gnomevfs.URI</h2><p>gnomevfs.URI — Object encapsulating a URI</p></div><div class="refsect1" title="Synopsis"><a name="id450373"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">gnomevfs.URI</span></span>:
<code class="constructorsynopsis">    <span class="methodname"><a class="link" href="class-gnomevfs-uri.html#constructor-gnomevfs-uri">gnomevfs.URI</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>text_uri</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gnomevfs-uri.html#method-gnomevfs-uri--append_file_name" title="gnomevfs.URI.append_file_name">append_file_name</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>file_name</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gnomevfs-uri.html#method-gnomevfs-uri--append_path" title="gnomevfs.URI.append_path">append_path</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>path</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gnomevfs-uri.html#method-gnomevfs-uri--append_string" title="gnomevfs.URI.append_string">append_string</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>path</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gnomevfs-uri.html#method-gnomevfs-uri--copy" title="gnomevfs.URI.copy">copy</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gnomevfs-uri.html#method-gnomevfs-uri--is_parent" title="gnomevfs.URI.is_parent">is_parent</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>item</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>recursive</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gnomevfs-uri.html#method-gnomevfs-uri--resolve_relative" title="gnomevfs.URI.resolve_relative">resolve_relative</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>relative_reference</code></strong></span></span>)</code><br></pre></td></tr></table></div><div class="refsect1" title="Description"><a name="id478035"></a><h2>Description</h2><p></p></div><div class="refsect1" title="Attributes"><a name="id478044"></a><h2>Attributes</h2><div class="blockquote"><table width="100%" border="0" bgcolor="#E0E0E0"><tr><td valign="top"><div class="informaltable"><table width="100%" border="0"><colgroup><col width="1in"><col width="1in"><col width="3.5in"></colgroup><tbody><tr valign="top"><td valign="top">dirname</td><td valign="top">Read/Write</td><td valign="top">The name of the directory in which the file pointed to by this URI is located.</td></tr><tr valign="top"><td valign="top">fragment_identifier</td><td valign="top">Read/Write</td><td valign="top"> </td></tr><tr valign="top"><td valign="top">host_name</td><td valign="top">Read</td><td valign="top">Server hostname (for remote schemes).</td></tr><tr valign="top"><td valign="top">host_port</td><td valign="top">Read</td><td valign="top">Server port (for remote schemes).</td></tr><tr valign="top"><td valign="top">is_local</td><td valign="top">Read/Write</td><td valign="top">Whether the URI is a local filesystem.</td></tr><tr valign="top"><td valign="top">parent</td><td valign="top">Read/Write</td><td valign="top">The parent URI.</td></tr><tr valign="top"><td valign="top">password</td><td valign="top">Read</td><td valign="top">Password (for schemes which require authorization).</td></tr><tr valign="top"><td valign="top">path</td><td valign="top">Read/Write</td><td valign="top">The full path name.</td></tr><tr valign="top"><td valign="top">scheme</td><td valign="top">Read/Write</td><td valign="top">The URI scheme (`gzip', `tar', `http', etc).</td></tr><tr valign="top"><td valign="top">short_name</td><td valign="top">Read/Write</td><td valign="top">The base name for the file referred to by this URI.  This matches the XPG definition of a basename.  This is useful when you want the name of the URI target, but don't care whether the URI points to a file or directory.  If the URI points to the root of a domain, this is the host name.</td></tr><tr valign="top"><td valign="top">short_path_name</td><td valign="top">Read/Write</td><td valign="top">Same as short_name, but if the URI points to the root of a domain, this is equal to /</td></tr><tr valign="top"><td valign="top">toplevel</td><td valign="top">Read/Write</td><td valign="top">The toplevel URI</td></tr><tr valign="top"><td valign="top">user_name</td><td valign="top">Read</td><td valign="top">User name (for schemes which require authorization).</td></tr></tbody></table></div></td></tr></table></div></div><div class="refsect1" title="Constructor"><a name="id482770"></a><h2>Constructor</h2><div class="refsect2"><a name="constructor-gnomevfs-uri"></a><pre class="programlisting">
        <code class="constructorsynopsis">    <span class="methodname">gnomevfs.URI</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>text_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>text_uri</code></strong>:</span></p></td><td>A string representing the URI.</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></p></td><td>the new <a class="link" href="class-gnomevfs-uri.html" title="gnomevfs.URI">gnomevfs.URI</a></td></tr></tbody></table><p></p></div></div><div class="refsect1" title="Methods"><a name="id482858"></a><h2>Methods</h2><div class="refsect2" title="gnomevfs.URI.append_file_name"><a name="method-gnomevfs-uri--append_file_name"></a><h3>gnomevfs.URI.append_file_name</h3><pre class="programlisting">
        <code class="methodsynopsis">    def <span class="methodname">append_file_name</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>file_name</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>file_name</code></strong>:</span></p></td><td>The file name to append.</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></p></td><td>The new URI.</td></tr></tbody></table><p>Create a new URI by appending <strong class="parameter"><code>file_name</code></strong>.  This will add the appropriate directory separator if necessary.</p></div><div class="refsect2" title="gnomevfs.URI.append_path"><a name="method-gnomevfs-uri--append_path"></a><h3>gnomevfs.URI.append_path</h3><pre class="programlisting">
        <code class="methodsynopsis">    def <span class="methodname">append_path</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>path</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>path</code></strong>:</span></p></td><td>The path to append (unescaped)</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></p></td><td>The new URI.</td></tr></tbody></table><p>Create a new URI by appending <strong class="parameter"><code>path</code></strong>.  This will add the appropriate directory separator if necessary.</p></div><div class="refsect2" title="gnomevfs.URI.append_string"><a name="method-gnomevfs-uri--append_string"></a><h3>gnomevfs.URI.append_string</h3><pre class="programlisting">
        <code class="methodsynopsis">    def <span class="methodname">append_string</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>path</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>path</code></strong>:</span></p></td><td>The path to append (fully escaped)</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></p></td><td>The new URI.</td></tr></tbody></table><p>Create a new URI by appending <strong class="parameter"><code>path</code></strong>.  This will add the appropriate directory separator if necessary.</p></div><div class="refsect2" title="gnomevfs.URI.copy"><a name="method-gnomevfs-uri--copy"></a><h3>gnomevfs.URI.copy</h3><pre class="programlisting">
        <code class="methodsynopsis">    def <span class="methodname">copy</span>(<span class="methodparam"></span>)</code>
      </pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></p></td><td>A copy of this URI.</td></tr></tbody></table><p>Create a copy of this URI.</p></div><div class="refsect2" title="gnomevfs.URI.is_parent"><a name="method-gnomevfs-uri--is_parent"></a><h3>gnomevfs.URI.is_parent</h3><pre class="programlisting">
        <code class="methodsynopsis">    def <span class="methodname">is_parent</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>item</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>recursive</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>item</code></strong>:</span></p></td><td>The item to search for.</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>recursive</code></strong>:</span></p></td><td>Whether to check the entire hierarchy.</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></p></td><td>True if <strong class="parameter"><code>item</code></strong> is a child of self.</td></tr></tbody></table><p>Check if this URI is a parent of <strong class="parameter"><code>item</code></strong>.  If <strong class="parameter"><code>recursive</code></strong> is True, check the entire hierarchy.</p></div><div class="refsect2" title="gnomevfs.URI.resolve_relative"><a name="method-gnomevfs-uri--resolve_relative"></a><h3>gnomevfs.URI.resolve_relative</h3><pre class="programlisting">
        <code class="methodsynopsis">    def <span class="methodname">resolve_relative</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>relative_reference</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>relative_reference</code></strong>:</span></p></td><td>A string representing the (possibly) relative URI.</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></p></td><td>The new URI.</td></tr></tbody></table><p>Create a new URI from <strong class="parameter"><code>relative_reference</code></strong> relative to self.  The resolution algorithm follows RFC 2396. For details, see section 5.2 of http://www.ietf.org/rfc/rfc2396.txt .</p><p>In short, if the base uri ends in '/', relative_reference is appended to base, otherwise it replaces the part of base after the last '/'.</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-handle.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="class-gnomevfs-volume.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">gnomevfs.Handle </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> gnomevfs.Volume</td></tr></table></div></body></html>
python-gnome2-doc 2.28.1+dfsg-1ubuntu2 / usr / share / gtk-doc / html / pygnomevfs / class-gnomevfs-uri.html
