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 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74
|
<?xml version="1.0" standalone="no"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="class-gnomevfs-context">
<refnamediv>
<refname>gnomevfs.Context</refname>
<refpurpose>Thread tracking and cancellation object</refpurpose>
</refnamediv>
<refsect1>
<title>Synopsis</title>
<classsynopsis language="python">
<ooclass><classname>gnomevfs.Context</classname></ooclass>
<methodsynopsis language="python">
<methodname><link linkend="method-gnomevfs-context--get_cancellation">get_cancellation</link></methodname>
<methodparam />
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gnomevfs-context--check_cancellation">check_cancellation</link></methodname>
<methodparam />
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gnomevfs-context--cancel">cancel</link></methodname>
<methodparam />
</methodsynopsis>
</classsynopsis>
</refsect1>
<refsect1>
<title>Description</title>
<para></para>
</refsect1>
<refsect1>
<title>Methods</title>
<refsect2 id="method-gnomevfs-context--get_cancellation">
<title>gnomevfs.Context.get_cancellation</title>
<programlisting><methodsynopsis language="python">
<methodname>get_cancellation</methodname>
<methodparam />
</methodsynopsis>
</programlisting>
<para>As far as I can tell, the python binding for this is incomplete.</para>
</refsect2>
<refsect2 id="method-gnomevfs-context--check_cancellation">
<title>gnomevfs.Context.check_cancellation</title>
<programlisting><methodsynopsis language="python">
<methodname>check_cancellation</methodname>
<methodparam />
</methodsynopsis>
</programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis>:</term>
<listitem><simpara><literal>TRUE</literal> if the context has been cancelled</simpara></listitem>
</varlistentry>
</variablelist>
<para>Checks to see if this operation represented by this context has been cancelled.</para>
</refsect2>
<refsect2 id="method-gnomevfs-context--cancel">
<title>gnomevfs.Context.cancel</title>
<programlisting><methodsynopsis language="python">
<methodname>cancel</methodname>
<methodparam />
</methodsynopsis>
</programlisting>
<para>Cancel the operation represented by this context.</para>
</refsect2>
</refsect1>
</refentry>
|