pygobject r1029 - in trunk/docs: . reference
- From: gianmt svn gnome org
- To: svn-commits-list gnome org
- Subject: pygobject r1029 - in trunk/docs: . reference
- Date: Sun, 22 Mar 2009 16:57:25 +0000 (UTC)
Author: gianmt
Date: Sun Mar 22 16:57:24 2009
New Revision: 1029
URL: http://svn.gnome.org/viewvc/pygobject?rev=1029&view=rev
Log:
2009-03-22 Gian Mario Tagliaretti <gianmt gnome org>
* docs/Makefile.am:
* docs/reference/pygio-classes.xml:
* docs/reference/pygio-fileicon.xml:
* docs/reference/pygio-fileenumerator.xml: Add gio.FileIcon and
gio.FileEnumerator in docs.
* docs/reference/pygio-constants.xml: Add gio.ERROR_* constants.
* docs/reference/pygio-applaunchcontext.xml:
* docs/reference/pygio-emblemedicon.xml: Fix a couple of typos.
Added:
trunk/docs/reference/pygio-fileenumerator.xml
trunk/docs/reference/pygio-fileicon.xml
Modified:
trunk/docs/Makefile.am
trunk/docs/reference/ChangeLog
trunk/docs/reference/pygio-applaunchcontext.xml
trunk/docs/reference/pygio-classes.xml
trunk/docs/reference/pygio-constants.xml
trunk/docs/reference/pygio-emblemedicon.xml
Modified: trunk/docs/Makefile.am
==============================================================================
--- trunk/docs/Makefile.am (original)
+++ trunk/docs/Makefile.am Sun Mar 22 16:57:24 2009
@@ -16,10 +16,13 @@
html/glib-functions.html \
html/gobject-class-reference.html \
html/glib-class-reference.html \
- html/gio-applaunchcontext.html \
- html/gio-emblem.html \
- html/gio-emblemedicon.html \
- html/gio-icon.html \
+ html/class-gioapplaunchcontext.html \
+ html/class-giocancellable.html \
+ html/class-gioemblem.html \
+ html/class-gioemblemedicon.html \
+ html/class-giofileenumerator.html \
+ html/class-giofileicon.html \
+ html/class-gioicon.html \
html/gio-constants.html \
html/gio-class-reference.html \
html/gobject-constants.html \
@@ -46,11 +49,13 @@
reference/pyglib-maincontext.xml \
reference/pyglib-mainloop.xml \
reference/pygio-classes.xml \
+ reference/pygio-constants.xml \
reference/pygio-applaunchcontext.xml \
reference/pygio-emblem.xml \
reference/pygio-emblemedicon.xml \
reference/pygio-icon.xml \
- reference/pygio-constants.xml
+ reference/pygio-fileenumerator.xml \
+ reference/pygio-fileicon.xml
XSL_FILES = \
xsl/common.xsl \
Modified: trunk/docs/reference/pygio-applaunchcontext.xml
==============================================================================
--- trunk/docs/reference/pygio-applaunchcontext.xml (original)
+++ trunk/docs/reference/pygio-applaunchcontext.xml Sun Mar 22 16:57:24 2009
@@ -2,7 +2,7 @@
<!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-gdkapplaunchcontext">
+<refentry id="class-gioapplaunchcontext">
<refnamediv>
<refname>gio.AppLaunchContext</refname>
<refpurpose>Application launch context.</refpurpose>
Modified: trunk/docs/reference/pygio-classes.xml
==============================================================================
--- trunk/docs/reference/pygio-classes.xml (original)
+++ trunk/docs/reference/pygio-classes.xml Sun Mar 22 16:57:24 2009
@@ -12,6 +12,8 @@
<xi:include href="pygio-emblem.xml"/>
<xi:include href="pygio-icon.xml"/>
<xi:include href="pygio-emblemedicon.xml"/>
+<xi:include href="pygio-fileenumerator.xml"/>
+<xi:include href="pygio-fileicon.xml"/>
<xi:include href="pygio-constants.xml"/>
</chapter>
Modified: trunk/docs/reference/pygio-constants.xml
==============================================================================
--- trunk/docs/reference/pygio-constants.xml (original)
+++ trunk/docs/reference/pygio-constants.xml Sun Mar 22 16:57:24 2009
@@ -13,6 +13,7 @@
<programlisting>
<xref linkend="gio-emblem-origin-constants" endterm="gio-emblem-origin-constants-title"></xref>
+<xref linkend="gio-error-constants" endterm="gio-error-constants-title"></xref>
</programlisting>
</refsect1>
@@ -54,6 +55,215 @@
</varlistentry>
</variablelist>
</refsect2>
+
+ <refsect2 id="gio-error-constants">
+ <title id="gio-error-constants-title">Gio Error Constants</title>
+
+ <para>
+ GIOError Error codes returned by GIO functions.
+ </para>
+
+ <variablelist>
+ <varlistentry>
+ <term><literal>gio.ERROR_ALREADY_MOUNTED</literal></term>
+ <listitem>
+ <simpara>File is already mounted.</simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><literal>gio.ERROR_BUSY</literal></term>
+ <listitem>
+ <simpara>File is busy.</simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><literal>gio.ERROR_CANCELLED</literal></term>
+ <listitem>
+ <simpara>Operation was cancelled. See
+ <link linkend="class-giocancellable"><classname>gio.Cancellable</classname></link>.
+ </simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><literal>gio.ERROR_CANT_CREATE_BACKUP</literal></term>
+ <listitem>
+ <simpara>Backup couldn't be created.</simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><literal>gio.ERROR_CLOSED</literal></term>
+ <listitem>
+ <simpara>File was closed.</simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><literal>gio.ERROR_EXISTS</literal></term>
+ <listitem>
+ <simpara>File already exists error.</simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><literal>gio.ERROR_FAILED</literal></term>
+ <listitem>
+ <simpara>Generic error condition for when any operation fails.</simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><literal>gio.ERROR_FAILED_HANDLED</literal></term>
+ <listitem>
+ <simpara>Operation failed and a helper program has already interacted with
+ the user. Do not display any error dialog. </simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><literal>gio.ERROR_FILENAME_TOO_LONG</literal></term>
+ <listitem>
+ <simpara>Filename is too many characters.</simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><literal>gio.ERROR_HOST_NOT_FOUND</literal></term>
+ <listitem>
+ <simpara>Host couldn't be found (remote operations).</simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><literal>gio.ERROR_INVALID_ARGUMENT</literal></term>
+ <listitem>
+ <simpara>Invalid argument.</simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><literal>gio.ERROR_INVALID_FILENAME</literal></term>
+ <listitem>
+ <simpara>Filename is invalid or contains invalid characters.</simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><literal>gio.ERROR_IS_DIRECTORY</literal></term>
+ <listitem>
+ <simpara>File is a directory error.</simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><literal>gio.ERROR_NOT_DIRECTORY</literal></term>
+ <listitem>
+ <simpara>File is not a directory.</simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><literal>gio.ERROR_NOT_EMPTY</literal></term>
+ <listitem>
+ <simpara>File is a directory that isn't empty.</simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><literal>gio.ERROR_NOT_FOUND</literal></term>
+ <listitem>
+ <simpara>File not found error.</simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><literal>gio.ERROR_NOT_MOUNTABLE_FILE</literal></term>
+ <listitem>
+ <simpara>File cannot be mounted.</simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><literal>gio.ERROR_NOT_MOUNTED</literal></term>
+ <listitem>
+ <simpara>File isn't mounted. </simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><literal>gio.ERROR_NOT_REGULAR_FILE</literal></term>
+ <listitem>
+ <simpara>File is not a regular file.</simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><literal>gio.ERROR_NOT_SUPPORTED</literal></term>
+ <listitem>
+ <simpara>Operation not supported for the current backend.</simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><literal>gio.ERROR_NOT_SYMBOLIC_LINK</literal></term>
+ <listitem>
+ <simpara>File is not a symbolic link.</simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><literal>gio.ERROR_NO_SPACE</literal></term>
+ <listitem>
+ <simpara>No space left on drive. </simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><literal>gio.ERROR_PENDING</literal></term>
+ <listitem>
+ <simpara>Operations are still pending.</simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><literal>gio.ERROR_PERMISSION_DENIED</literal></term>
+ <listitem>
+ <simpara>Permission denied.</simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><literal>gio.ERROR_READ_ONLY</literal></term>
+ <listitem>
+ <simpara>File is read only. </simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><literal>gio.ERROR_TIMED_OUT</literal></term>
+ <listitem>
+ <simpara>Operation timed out. </simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><literal>gio.ERROR_TOO_MANY_LINKS</literal></term>
+ <listitem>
+ <simpara>File contains too many symbolic links. </simpara>
+ </listitem>
+ </varlistentry>
+ <!--
+ <varlistentry>
+ <term><literal>gio.ERROR_TOO_MANY_OPEN_FILES</literal></term>
+ <listitem>
+ <simpara>The current process has too many files open and can't open any
+ more. Duplicate descriptors do count toward this limit. Since 2.20</simpara>
+ </listitem>
+ </varlistentry>
+ -->
+ <varlistentry>
+ <term><literal>gio.ERROR_WOULD_BLOCK</literal></term>
+ <listitem>
+ <simpara>Operation would block.</simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><literal>gio.ERROR_WOULD_MERGE</literal></term>
+ <listitem>
+ <simpara>Operation would merge files.</simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><literal>gio.ERROR_WOULD_RECURSE</literal></term>
+ <listitem>
+ <simpara>Operation would be recursive.</simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><literal>gio.ERROR_WRONG_ETAG</literal></term>
+ <listitem>
+ <simpara>File's Entity Tag was incorrect. </simpara>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect2>
</refsect1>
</refentry>
Modified: trunk/docs/reference/pygio-emblemedicon.xml
==============================================================================
--- trunk/docs/reference/pygio-emblemedicon.xml (original)
+++ trunk/docs/reference/pygio-emblemedicon.xml Sun Mar 22 16:57:24 2009
@@ -72,7 +72,7 @@
</para>
</refsect1>
- <refsect1 id="constructor-gioemblem">
+ <refsect1 id="constructor-gioemblemedicon">
<title>Constructor</title>
<programlisting><constructorsynopsis language="python">
Added: trunk/docs/reference/pygio-fileenumerator.xml
==============================================================================
--- (empty file)
+++ trunk/docs/reference/pygio-fileenumerator.xml Sun Mar 22 16:57:24 2009
@@ -0,0 +1,488 @@
+<?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-giofileenumerator">
+ <refnamediv>
+ <refname>gio.FileEnumerator</refname>
+ <refpurpose>Enumerated Files Routines.</refpurpose>
+ </refnamediv>
+
+ <refsect1>
+ <title>Synopsis</title>
+
+ <classsynopsis language="python">
+ <ooclass><classname>gio.FileEnumerator</classname></ooclass>
+ <ooclass><classname><link linkend="class-gobject">gobject.GObject</link></classname></ooclass>
+
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-giofileenumerator--close">close</link></methodname>
+ <methodparam><parameter role="keyword">cancellable</parameter><initializer><literal>None</literal></initializer></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-giofileenumerator--close-async">close_async</link></methodname>
+ <methodparam><parameter role="keyword">callback</parameter></methodparam>
+ <methodparam><parameter role="keyword">io_priority</parameter><initializer><literal>glib.PRIORITY_DEFAULT</literal></initializer></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-giofileenumerator--close-finish">close_finish</link></methodname>
+ <methodparam><parameter role="keyword">result</parameter></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-giofileenumerator--get-container">get_container</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-giofileenumerator--has-pending">has_pending</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-giofileenumerator--is-closed">is_closed</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-giofileenumerator--next-file">next_file</link></methodname>
+ <methodparam><parameter role="keyword">cancellable</parameter><initializer><literal>None</literal></initializer></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-giofileenumerator--next-files-async">next_files_async</link></methodname>
+ <methodparam><parameter role="keyword">num_files</parameter></methodparam>
+ <methodparam><parameter role="keyword">callback</parameter></methodparam>
+ <methodparam><parameter role="keyword">io_priority</parameter><initializer><literal>glib.PRIORITY_DEFAULT</literal></initializer></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-giofileenumerator--next-files-finish">next_files_finish</link></methodname>
+ <methodparam><parameter role="keyword">result</parameter></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-giofileenumerator--set-pending">set_pending</link></methodname>
+ <methodparam><parameter role="keyword">pending</parameter></methodparam>
+ </methodsynopsis>
+
+ </classsynopsis>
+
+ </refsect1>
+
+ <refsect1>
+ <title>Ancestry</title>
+
+<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
+ +-- <link linkend="class-giofileenumerator">gio.FileEnumerator</link>
+</synopsis>
+
+ </refsect1>
+
+ <refsect1 id="properties-giofileenumerator">
+ <title>gio.FileEnumerator Properties</title>
+
+ <blockquote role="properties">
+ <informaltable pgwide="1" frame="none">
+ <tgroup cols="3">
+ <colspec column="1" colwidth="1in"/>
+ <colspec column="2" colwidth="1in"/>
+ <colspec column="3" colwidth="4in"/>
+ <tbody>
+ <row valign="top">
+ <entry>"container"</entry>
+ <entry>Write - Construct only</entry>
+ <entry>The container that is being enumerated.</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </blockquote>
+
+ </refsect1>
+
+ <refsect1>
+ <title>Description</title>
+
+ <para>
+ The <link linkend="class-giofileenumerator"><classname>gio.FileEnumerator</classname></link>
+ allows you to operate on a set of
+ <link linkend="class-giofile"><classname>gio.File</classname></link>s
+ returning a
+ <link linkend="class-giofileinfo"><classname>gio.FileInfo</classname></link>
+ structure for each file enumerated (e.g.
+ <methodname><link linkend="method-giofile--enumerate-children">gio.File.enumerate_children</link></methodname>()
+ will return a The <link linkend="class-giofileenumerator"><classname>gio.FileEnumerator</classname></link>
+ for each of the children within a directory).
+ </para>
+ <para>
+ To get the next file's information from a
+ The <link linkend="class-giofileenumerator"><classname>gio.FileEnumerator</classname></link> use
+ <methodname><link linkend="method-giofileenumerator--next-file">gio.FileEnumerator.next_file</link></methodname>()
+ or its asynchronous version,
+ <methodname><link linkend="method-giofileenumerator--next-files-async">gio.FileEnumerator.next_files_async</link></methodname>().
+ Note that the asynchronous version will return a list of
+ <link linkend="class-giofileinfo"><classname>gio.FileInfo</classname></link>s,
+ whereas the synchronous will only return the next file in the enumerator.
+ </para>
+ <para>
+ To close a <link linkend="class-giofileenumerator"><classname>gio.FileEnumerator</classname></link>
+ use <methodname><link linkend="method-giofileenumerator--close">close</link></methodname>,
+ or its asynchronous version,
+ <methodname><link linkend="method-giofileenumerator--close-async">close_async</link></methodname>.
+ Once a <link linkend="class-giofileenumerator"><classname>gio.FileEnumerator</classname></link>
+ is closed, no further actions may be performed on it.
+ </para>
+ </refsect1>
+
+ <refsect1>
+ <title>Methods</title>
+
+ <refsect2 id="method-giofileenumerator--close">
+ <title>gio.FileEnumerator.close</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>close</methodname>
+ <methodparam>
+ <parameter role="keyword">cancellable</parameter><initializer><literal>None</literal></initializer>
+ </methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><parameter role="keyword">cancellable</parameter> :</term>
+ <listitem><simpara>Optional
+ <link linkend="class-giocancellable"><classname>gio.Cancellable</classname></link>
+ object, <literal>None</literal> to ignore.
+ </simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara><literal>True</literal> on success or
+ <literal>False</literal> on error.
+ </simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <para>
+ The <methodname>close</methodname>() method releases all resources used by this
+ enumerator, making the
+ <xref linkend="gio-error-constants" endterm="gio-error-constants-title"></xref>
+ return gio.ERROR_CLOSED on all calls.
+ </para>
+ <para>
+ This will be automatically called when the last reference is dropped,
+ but you might want to call this function to make sure resources are released
+ as early as possible.
+ </para>
+ </refsect2>
+
+ <refsect2 id="method-giofileenumerator--close-async">
+ <title>gio.FileEnumerator.close_async</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>close_async</methodname>
+ <methodparam>
+ <parameter role="keyword">callback</parameter>
+ </methodparam>
+ <methodparam>
+ <parameter role="keyword">io_priority</parameter><initializer><literal>glib.PRIORITY_DEFAULT</literal></initializer>
+ </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> :</term>
+ <listitem><simpara>A GAsyncReadyCallback to call when the request is satisfied.
+ </simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter role="keyword">io_priority</parameter> :</term>
+ <listitem><simpara>The
+ <xref linkend="glib-priority-constants" endterm="glib-priority-constants-title"></xref> of the request.
+ </simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter role="keyword">cancellable</parameter> :</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> :</term>
+ <listitem><simpara>The data to pass to callback function.
+ </simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <para>
+ The <methodname>close_async</methodname>() method asynchronously closes the file enumerator.
+ </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.ERROR_CANCELLED will be returned in
+ <methodname><link linkend="method-giofileenumerator--close-finish">gio.FileEnumerator.close_finish</link></methodname>().
+ </para>
+ </refsect2>
+
+ <refsect2 id="method-giofileenumerator--close-finish">
+ <title>gio.FileEnumerator.close_finish</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>close_finish</methodname>
+ <methodparam><parameter role="keyword">result</parameter></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><parameter role="keyword">result</parameter> :</term>
+ <listitem><simpara>a GAsyncResult.
+ </simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara><literal>True</literal> if the close operation
+ has finished successfully.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <para>
+ The <methodname>close_finish</methodname>() method finishes closing a file enumerator, started from
+ <methodname><link linkend="method-giofileenumerator--close-async">gio.FileEnumerator.close_async</link></methodname>().
+ </para>
+ <para>
+ If the file enumerator was already closed when
+ <methodname><link linkend="method-giofileenumerator--close-async">gio.FileEnumerator.close_async</link></methodname>()
+ was called, then this function will report gio.ERROR_CLOSED in error, and return <literal>False</literal>.
+ If the file enumerator had pending operation when the close operation was started, then this function will report
+ gio.ERROR_PENDING, and return <literal>False</literal>. If cancellable was not <literal>None</literal>, then the operation
+ may have been cancelled by triggering the cancellable object from another thread. If the operation was cancelled,
+ the error gio.ERROR_CANCELLED will be set, and <literal>False</literal> will be returned.
+ </para>
+ </refsect2>
+
+ <refsect2 id="method-giofileenumerator--get-container">
+ <title>gio.FileEnumerator.get_container</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>get_container</methodname>
+ <methodparam></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>the <link linkend="class-giofile"><classname>gio.File</classname></link>
+ which is being enumerated. </simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <para>
+ The <methodname>get_container</methodname>() method gets the
+ <link linkend="class-giofile"><classname>gio.File</classname></link>
+ container which is being enumerated.
+ </para>
+ </refsect2>
+
+ <refsect2 id="method-giofileenumerator--has-pending">
+ <title>gio.FileEnumerator.has_pending</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>has_pending</methodname>
+ <methodparam></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara><literal>True</literal> if the enumerator has pending operations.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <para>
+ The <methodname>has_pending</methodname>() method checks if the file enumerator has pending operations.
+ </para>
+ </refsect2>
+
+ <refsect2 id="method-giofileenumerator--is-closed">
+ <title>gio.FileEnumerator.is_closed</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>is_closed</methodname>
+ <methodparam></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara><literal>True</literal> if the enumerator is closed.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <para>
+ The <methodname>is_closed</methodname>() method checks if the file enumerator has been closed.
+ </para>
+ </refsect2>
+
+ <refsect2 id="method-giofileenumerator--next-file">
+ <title>gio.FileEnumerator.next_file</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>next_file</methodname>
+ <methodparam><parameter role="keyword">cancellable</parameter><initializer><literal>None</literal></initializer></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><parameter role="keyword">cancellable</parameter> :</term>
+ <listitem><simpara>Optional
+ <link linkend="class-giocancellable"><classname>gio.Cancellable</classname></link>
+ object, <literal>None</literal> to ignore.
+ </simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>A <link linkend="class-giofileinfo"><classname>gio.FileInfo</classname></link>
+ or <literal>None</literal> on error or end of enumerator.
+ </simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <para>
+ The <methodname>next_file</methodname>() method returns information for the next
+ file in the enumerated object. Will block until the information is available.
+ The <link linkend="class-giofileinfo"><classname>gio.FileInfo</classname></link>
+ returned from this function will contain attributes that match the attribute string
+ that was passed when the GFileEnumerator was created.
+ </para>
+ <para>
+ On error, returns <literal>None</literal> and sets error to the error. If the enumerator
+ is at the end, <literal>None</literal> will be returned and error will be unset.
+ </para>
+ </refsect2>
+
+ <refsect2 id="method-giofileenumerator--next-files-async">
+ <title>gio.FileEnumerator.next_files_async</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>next_files_async</methodname>
+ <methodparam><parameter role="keyword">num_files</parameter></methodparam>
+ <methodparam><parameter role="keyword">callback</parameter></methodparam>
+ <methodparam>
+ <parameter role="keyword">io_priority</parameter><initializer><literal>glib.PRIORITY_DEFAULT</literal></initializer>
+ </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">num_files</parameter> :</term>
+ <listitem><simpara>The number of file info objects to request.
+ </simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter role="keyword">callback</parameter> :</term>
+ <listitem><simpara>A GAsyncReadyCallback to call when the request is satisfied.
+ </simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter role="keyword">io_priority</parameter> :</term>
+ <listitem><simpara>The
+ <xref linkend="glib-priority-constants" endterm="glib-priority-constants-title"></xref> of the request.
+ </simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter role="keyword">cancellable</parameter> :</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> :</term>
+ <listitem><simpara>The data to pass to callback function.
+ </simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <para>
+ The <methodname>next_files_async</methodname>() method requests information for a number
+ of files from the enumerator asynchronously. When all i/o for the operation is finished
+ the callback will be called with the requested information.
+ </para>
+ <para>
+ The callback can be called with less than num_files files in case of error or at the
+ end of the enumerator. In case of a partial error the callback will be called with any
+ succeeding items and no error, and on the next request the error will be reported. If a
+ request is cancelled the callback will be called with gio.ERROR_CANCELLED.
+ </para>
+ <para>
+ During an async request no other sync and async calls are allowed, and will result in gio.ERROR_PENDING errors.
+ </para>
+ <para>
+ Any outstanding i/o request with higher priority (lower numerical value) will be executed
+ before an outstanding request with lower priority. Default priority is glib.PRIORITY_DEFAULT.
+ </para>
+ </refsect2>
+
+ <refsect2 id="method-giofileenumerator--next-files-finish">
+ <title>gio.FileEnumerator.next_files_finish</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>next_files_finish</methodname>
+ <methodparam><parameter role="keyword">result</parameter></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><parameter role="keyword">result</parameter> :</term>
+ <listitem><simpara>a GAsyncResult.
+ </simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>A list of
+ <link linkend="class-giofileinfo"><classname>gio.FileInfo</classname></link>s.
+ </simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <para>
+ The <methodname>next_files_finish</methodname>() method finishes the
+ asynchronous operation started with
+ <methodname><link linkend="method-giofileenumerator--next-files-async">gio.FileEnumerator.next_files_async</link></methodname>().
+ </para>
+ </refsect2>
+
+ <refsect2 id="method-giofileenumerator--set-pending">
+ <title>gio.FileEnumerator.set_pending</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>set_pending</methodname>
+ <methodparam><parameter role="keyword">pending</parameter></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><parameter role="keyword">pending</parameter> :</term>
+ <listitem><simpara>A boolean value.
+ </simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <para>
+ The <methodname>push_current</methodname>() method sets the file enumerator as having pending operations.
+ </para>
+ </refsect2>
+ </refsect1>
+</refentry>
Added: trunk/docs/reference/pygio-fileicon.xml
==============================================================================
--- (empty file)
+++ trunk/docs/reference/pygio-fileicon.xml Sun Mar 22 16:57:24 2009
@@ -0,0 +1,109 @@
+<?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-giofileicon">
+ <refnamediv>
+ <refname>gio.FileIcon</refname>
+ <refpurpose>Icons pointing to an image file.</refpurpose>
+ </refnamediv>
+
+ <refsect1>
+ <title>Synopsis</title>
+
+ <classsynopsis language="python">
+ <ooclass><classname>gio.FileIcon</classname></ooclass>
+ <ooclass><classname><link linkend="class-gobject">gobject.GObject</link></classname></ooclass>
+ <ooclass><classname><link linkend="class-gioicon">gio.Icon</link></classname></ooclass>
+ <ooclass><classname><link linkend="class-gioloadableicon">gio.LoadableIcon</link></classname></ooclass>
+
+ <constructorsynopsis language="python">
+ <methodname><link linkend="constructor-giofileicon">gio.FileIcon</link></methodname>
+ <methodparam><parameter role="keyword">file</parameter></methodparam>
+ </constructorsynopsis>
+
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-giofileicon--get-file">get_file</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+
+ </classsynopsis>
+
+ </refsect1>
+
+ <refsect1>
+ <title>Ancestry</title>
+
+<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
+ +-- <link linkend="class-giofileicon">gio.FileIcon</link>
+</synopsis>
+
+ </refsect1>
+
+ <refsect1>
+ <title>Description</title>
+
+ <para>
+ The <link linkend="class-giofileicon"><classname>gio.FileIcon</classname></link>
+ specifies an icon by pointing to an image file to be used as icon.
+ </para>
+ </refsect1>
+
+ <refsect1 id="constructor-giofileicon">
+ <title>Constructor</title>
+
+ <programlisting><constructorsynopsis language="python">
+ <methodname>gio.FileIcon</methodname>
+ <methodparam><parameter role="keyword">file</parameter></methodparam>
+ </constructorsynopsis></programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>file</parameter> :</term>
+ <listitem><simpara>a
+ <link linkend="class-giofile"><classname>gio.File</classname></link>
+ </simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>a new
+ <link linkend="class-giofileicon"><classname>gio.FileIcon</classname></link>
+ for the given file, or <literal>None</literal> on error.
+ </simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <para>
+ Creates a new icon for a file.
+ </para>
+
+ </refsect1>
+
+ <refsect1>
+ <title>Methods</title>
+
+ <refsect2 id="method-giofileicon--get-file">
+ <title>gio.FileIcon.get_file</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>get_file</methodname>
+ <methodparam></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>a
+ <link linkend="class-giofile"><classname>gio.File</classname></link>
+ or <literal>None</literal>.
+ </simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <para>
+ The <methodname>get_file</methodname>() method gets the
+ <link linkend="class-giofile"><classname>gio.File</classname></link>
+ associated with the given icon.
+ </para>
+ </refsect2>
+ </refsect1>
+</refentry>
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
