summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorGian Mario Tagliaretti <gianmt@gnome.org>2009-04-29 21:28:44 +0200
committerGian Mario Tagliaretti <gianmt@gnome.org>2009-04-29 21:28:44 +0200
commitd292dd4f624f2a08afc228f82a5f72e77593864e (patch)
treee6b32f51d2a4f8a7d3491917d2051c0995d0727c /docs
parent96f958cd66ac99130ef7b2049db77b6a9bbb20f9 (diff)
downloadpygobject-d292dd4f624f2a08afc228f82a5f72e77593864e.tar.gz
pygobject-d292dd4f624f2a08afc228f82a5f72e77593864e.tar.xz
pygobject-d292dd4f624f2a08afc228f82a5f72e77593864e.zip
Wrap three gio.Mount methods
the following methods of gio.Mount have been wrapped including docs (_wrap_g_mount_guess_content_type) (_wrap_g_mount_guess_content_type_finish) (_wrap_g_mount_guess_content_type_sync)
Diffstat (limited to 'docs')
-rw-r--r--docs/reference/pygio-mount.xml152
1 files changed, 152 insertions, 0 deletions
diff --git a/docs/reference/pygio-mount.xml b/docs/reference/pygio-mount.xml
index 0ea320d..f5688c5 100644
--- a/docs/reference/pygio-mount.xml
+++ b/docs/reference/pygio-mount.xml
@@ -58,6 +58,22 @@
<methodparam></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
+ <methodname><link linkend="method-giomount--guess-content-type">guess_content_type</link></methodname>
+ <methodparam><parameter role="keyword">callback</parameter></methodparam>
+ <methodparam><parameter role="keyword">force_rescan</parameter></methodparam>
+ <methodparam><parameter role="keyword">cancellable</parameter><initializer><literal>None</literal></initializer></methodparam>
+ <methodparam><parameter role="keyword">user_data</parameter><initializer><literal>None</literal></initializer></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-giomount--guess-content-type-finish">guess_content_type_finish</link></methodname>
+ <methodparam><parameter role="keyword">result</parameter></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-giomount--guess-content-type-sync">guess_content_type_sync</link></methodname>
+ <methodparam><parameter role="keyword">force_rescan</parameter></methodparam>
+ <methodparam><parameter role="keyword">cancellable</parameter><initializer><literal>None</literal></initializer></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
<methodname><link linkend="method-giomount--remount">remount</link></methodname>
<methodparam><parameter role="keyword">callback</parameter></methodparam>
<methodparam><parameter role="keyword">flags</parameter><initializer><literal>gio.MOUNT_UNMOUNT_NONE</literal></initializer></methodparam>
@@ -424,6 +440,132 @@
</para>
</refsect2>
+ <refsect2 id="method-giomount--guess-content-type">
+ <title>gio.Mount.guess_content_type</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>guess_content_type</methodname>
+ <methodparam><parameter role="keyword">callback</parameter></methodparam>
+ <methodparam><parameter role="keyword">force_rescan</parameter></methodparam>
+ <methodparam><parameter role="keyword">cancellable</parameter><initializer><literal>None</literal></initializer></methodparam>
+ <methodparam><parameter role="keyword">user_data</parameter><initializer><literal>None</literal></initializer></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><parameter role="keyword">callback</parameter>&nbsp;:</term>
+ <listitem><simpara>A GAsyncReadyCallback to call when the request is satisfied.
+ </simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter role="keyword">force_rescan</parameter>&nbsp;:</term>
+ <listitem><simpara>Whether to force a rescan of the content. Otherwise a cached result will be used if available.
+ </simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter role="keyword">cancellable</parameter>&nbsp;:</term>
+ <listitem><simpara>Optional
+ <link linkend="class-giocancellable"><classname>gio.Cancellable</classname></link>
+ object, <literal>None</literal> to ignore.
+ </simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter role="keyword">user_data</parameter>&nbsp;:</term>
+ <listitem><simpara>The data to pass to callback function.
+ </simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <para>
+ The <methodname>guess_content_type</methodname>() method asynchronously tries to guess the type of
+ content stored on mount. Returns one or more textual identifiers of well-known content
+ types (typically prefixed with "x-content/"), e.g. x-content/image-dcf for camera memory
+ cards. See the shared-mime-info specification for more on x-content types.
+ </para>
+ <para>
+ If cancellable is not <literal>None</literal>, then the operation can be cancelled
+ by triggering the cancellable object from another thread. If the operation was cancelled,
+ the error gio.IO_ERROR_CANCELLED will be returned.
+ </para>
+ <para>
+ When the operation is finished, callback will be called. You can then call
+ <methodname><link linkend="method-giomount--guess-content-type-finish">gio.Mount.guess_content_type_finish</link></methodname>()
+ to obtain the result of the operation.
+ </para>
+ </refsect2>
+
+ <refsect2 id="method-giomount--guess-content-type-finish">
+ <title>gio.Mount.guess_content_type_finish</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>guess_content_type_finish</methodname>
+ <methodparam><parameter role="keyword">result</parameter></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><parameter role="keyword">result</parameter>&nbsp;:</term>
+ <listitem><simpara>a <link linkend="class-gioasyncresult"><classname>gio.AsyncResult</classname></link>.
+ </simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis>&nbsp;:</term>
+ <listitem><simpara>A list of types or <literal>None</literal> on error.
+ </simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <para>
+ The <methodname>guess_content_type_finish</methodname>() method finishes guessing content
+ types of mount. If any errors occured during the operation, error will be set to
+ contain the errors and FALSE will be returned. In particular, you may get an
+ gio.IO_ERROR_NOT_SUPPORTED if the mount does not support content guessing.
+ </para>
+ </refsect2>
+
+ <refsect2 id="method-giomount--guess-content-type-sync">
+ <title>gio.Mount.guess_content_type_sync</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>guess_content_type_sync</methodname>
+ <methodparam><parameter role="keyword">force_rescan</parameter></methodparam>
+ <methodparam><parameter role="keyword">cancellable</parameter><initializer><literal>None</literal></initializer></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><parameter role="keyword">force_rescan</parameter>&nbsp;:</term>
+ <listitem><simpara>Whether to force a rescan of the content. Otherwise a cached result will be used if available.
+ </simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter role="keyword">cancellable</parameter>&nbsp;:</term>
+ <listitem><simpara>Optional
+ <link linkend="class-giocancellable"><classname>gio.Cancellable</classname></link>
+ object, <literal>None</literal> to ignore.
+ </simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <para>
+ The <methodname>guess_content_type_sync</methodname>() method tries to guess
+ the type of content stored on mount. Returns one or more textual identifiers
+ of well-known content types (typically prefixed with "x-content/"), e.g.
+ x-content/image-dcf for camera memory cards. See the shared-mime-info specification
+ for more on x-content types.
+ </para>
+ <para>
+ If cancellable is not <literal>None</literal>, then the operation can be cancelled
+ by triggering the cancellable object from another thread. If the operation was cancelled,
+ the error gio.IO_ERROR_CANCELLED will be returned.
+ </para>
+ <para>
+ This is an synchronous operation and as such may block doing IO; see
+ <methodname><link linkend="method-giomount--guess-content-type">gio.Mount.guess_content_type</link></methodname>()
+ for the asynchronous version.
+ </para>
+ </refsect2>
+
<refsect2 id="method-giomount--remount">
<title>gio.Mount.remount</title>
@@ -472,6 +614,11 @@
The <methodname>remount</methodname>() method asynchronously remounts a mount.
</para>
<para>
+ If cancellable is not <literal>None</literal>, then the operation can be cancelled
+ by triggering the cancellable object from another thread. If the operation was cancelled,
+ the error gio.IO_ERROR_CANCELLED will be returned.
+ </para>
+ <para>
When the operation is finished, callback will be called. You can then call
<methodname><link linkend="method-giomount--remount-finish">gio.Mount.remount_finish</link></methodname>()
to obtain the result of the operation.
@@ -546,6 +693,11 @@
The <methodname>unmount</methodname>() method asynchronously unmounts a mount.
</para>
<para>
+ If cancellable is not <literal>None</literal>, then the operation can be cancelled
+ by triggering the cancellable object from another thread. If the operation was cancelled,
+ the error gio.IO_ERROR_CANCELLED will be returned.
+ </para>
+ <para>
When the operation is finished, callback will be called. You can then call
<methodname><link linkend="method-giomount--unmount-finish">gio.Mount.unmount_finish</link></methodname>()
to obtain the result of the operation.