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 75 76 77 78 79
|
<?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-directoryhandle">
<refnamediv>
<refname>gnomevfs.DirectoryHandle</refname>
<refpurpose>iterator object for reading directories</refpurpose>
</refnamediv>
<refsect1>
<title>Synopsis</title>
<classsynopsis language="python">
<ooclass><classname>gnomevfs.DirectoryHandle</classname></ooclass>
<constructorsynopsis language="python">
<methodname><link linkend="constructor-gnomevfs-directoryhandle">gnomevfs.DirectoryHandle</link></methodname>
<methodparam><parameter role="keyword">uri</parameter></methodparam>
<methodparam><parameter role="keyword">options</parameter><initializer>gnomevfs.DIRECTORY_VISIT_DEFAULT</initializer></methodparam>
</constructorsynopsis>
<methodsynopsis>
<methodname><link linkend="method-gnomevfs-directoryhandle--next">next</link></methodname>
<methodparam />
</methodsynopsis>
</classsynopsis>
</refsect1>
<refsect1>
<title>Description</title>
<para></para>
</refsect1>
<refsect1>
<title>Constructor</title>
<refsect2 id="constructor-gnomevfs-directoryhandle">
<programlisting><constructorsynopsis language="python">
<methodname>gnomevfs.DirectoryHandle</methodname>
<methodparam><parameter role="keyword">uri</parameter></methodparam>
<methodparam><parameter role="keyword">options</parameter><initializer>gnomevfs.DIRECTORY_VISIT_DEFAULT</initializer></methodparam>
</constructorsynopsis>
</programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">uri</parameter>:</term>
<listitem><simpara>gnome-vfs URI to open</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter role="keyword">options</parameter>:</term>
<listitem><simpara>Or'd set of <link linkend="gnomevfs-constants-directory-visit">directory visit flags</link>.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><emphasis>Returns</emphasis>:</term>
<listitem><simpara>the new <link linkend="class-gnomevfs-directoryhandle"><classname>gnomevfs.DirectoryHandle</classname></link></simpara></listitem>
</varlistentry>
</variablelist>
<para>Open the directory specified by <parameter>uri</parameter>.</para>
</refsect2>
</refsect1>
<refsect1>
<title>Methods</title>
<refsect2 id="method-gnomevfs-directoryhandle--next">
<title>gnomevfs.DirectoryHandle.next</title>
<programlisting><methodsynopsis language="python">
<methodname>next</methodname>
<methodparam />
</methodsynopsis>
</programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>A <link linkend="class-gnomevfs-fileinfo">gnomevfs.FileInfo</link> describing the next directory entry.</simpara></listitem>
</varlistentry>
</variablelist>
<para>Read the next directory entry.</para>
</refsect2>
</refsect1>
</refentry>
|