File: class-gnomevfs-context.html

package info (click to toggle)
gnome-python 2.22.0-1
links: PTS, VCS
area: main
in suites: lenny
size: 3,420 kB
ctags: 933
sloc: sh: 9,060; ansic: 7,997; xml: 2,464; python: 1,925; makefile: 377
file content (5 lines) | stat: -rw-r--r-- 4,516 bytes
<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>gnomevfs.Context</title><meta name="generator" content="DocBook XSL Stylesheets V1.73.2"><link rel="start" 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="gnomevfs-class-reference.html" title="The gnomevfs class reference"><link rel="next" href="class-gnomevfs-directoryhandle.html" title="gnomevfs.DirectoryHandle"></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.Context</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="gnomevfs-class-reference.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-directoryhandle.html">Next</a></td></tr></table><hr></div><div class="refentry" lang="en"><a name="class-gnomevfs-context"></a><div class="titlepage"></div><div class="refnamediv"><h2>gnomevfs.Context</h2><p>gnomevfs.Context — Thread tracking and cancellation object</p></div><div class="refsect1" lang="en"><a name="id364165"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">gnomevfs.Context</span></span>:
<code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gnomevfs-context.html#method-gnomevfs-context--get_cancellation" title="gnomevfs.Context.get_cancellation">get_cancellation</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gnomevfs-context.html#method-gnomevfs-context--check_cancellation" title="gnomevfs.Context.check_cancellation">check_cancellation</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gnomevfs-context.html#method-gnomevfs-context--cancel" title="gnomevfs.Context.cancel">cancel</a></span>(<span class="methodparam"></span>)</code><br></pre></td></tr></table></div><div class="refsect1" lang="en"><a name="id316626"></a><h2>Description</h2><p></p></div><div class="refsect1" lang="en"><a name="id316635"></a><h2>Methods</h2><div class="refsect2" lang="en"><a name="method-gnomevfs-context--get_cancellation"></a><h3>gnomevfs.Context.get_cancellation</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">get_cancellation</span>(<span class="methodparam"></span>)</code>
      </pre><p>As far as I can tell, the python binding for this is incomplete.</p></div><div class="refsect2" lang="en"><a name="method-gnomevfs-context--check_cancellation"></a><h3>gnomevfs.Context.check_cancellation</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">check_cancellation</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><code class="literal">TRUE</code> if the context has been cancelled</td></tr></tbody></table><p>Checks to see if this operation represented by this context has been cancelled.</p></div><div class="refsect2" lang="en"><a name="method-gnomevfs-context--cancel"></a><h3>gnomevfs.Context.cancel</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">cancel</span>(<span class="methodparam"></span>)</code>
      </pre><p>Cancel the operation represented by this context.</p></div></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="gnomevfs-class-reference.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-directoryhandle.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">The gnomevfs class reference </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> gnomevfs.DirectoryHandle</td></tr></table></div></body></html>