diff options
author | Gian Mario Tagliaretti <gianmt@gnome.org> | 2009-06-02 13:29:59 +0200 |
---|---|---|
committer | Gian Mario Tagliaretti <gianmt@gnome.org> | 2009-06-02 13:29:59 +0200 |
commit | e2c31f916967229b6547e68013628ce0082cf875 (patch) | |
tree | e6e945f291659ad6db618376378a91fab0492157 /docs | |
parent | 49a467eee445bc75554db0374006722ac075194b (diff) | |
download | pygobject-e2c31f916967229b6547e68013628ce0082cf875.tar.gz pygobject-e2c31f916967229b6547e68013628ce0082cf875.tar.xz pygobject-e2c31f916967229b6547e68013628ce0082cf875.zip |
Add gio.FilterInputStream docs
Diffstat (limited to 'docs')
-rw-r--r-- | docs/Makefile.am | 2 | ||||
-rw-r--r-- | docs/reference/pygio-classes.xml | 1 | ||||
-rw-r--r-- | docs/reference/pygio-filterinputstream.xml | 152 |
3 files changed, 155 insertions, 0 deletions
diff --git a/docs/Makefile.am b/docs/Makefile.am index 5d7b083..c7358c3 100644 --- a/docs/Makefile.am +++ b/docs/Makefile.am @@ -31,6 +31,7 @@ HTML_FILES = \ html/class-giofileinputstream.html \ html/class-giofilemonitor.html \ html/class-giofileoutputstream.html \ + html/class-giofilterinputstream.html \ html/class-gioicon.html \ html/class-gioinputstream.html \ html/class-gioloadableicon.html \ @@ -84,6 +85,7 @@ XML_FILES = \ reference/pygio-fileinputstream.xml \ reference/pygio-filemonitor.xml \ reference/pygio-fileoutputstream.xml \ + reference/pygio-filterinputstream.xml \ reference/pygio-icon.xml \ reference/pygio-inputstream.xml \ reference/pygio-loadableicon.xml \ diff --git a/docs/reference/pygio-classes.xml b/docs/reference/pygio-classes.xml index 5c7f9df..eada7c6 100644 --- a/docs/reference/pygio-classes.xml +++ b/docs/reference/pygio-classes.xml @@ -22,6 +22,7 @@ <xi:include href="pygio-fileinputstream.xml"/> <xi:include href="pygio-filemonitor.xml"/> <xi:include href="pygio-fileoutputstream.xml"/> +<xi:include href="pygio-filterinputstream.xml"/> <xi:include href="pygio-icon.xml"/> <xi:include href="pygio-inputstream.xml"/> <xi:include href="pygio-loadableicon.xml"/> diff --git a/docs/reference/pygio-filterinputstream.xml b/docs/reference/pygio-filterinputstream.xml new file mode 100644 index 0000000..e6fb90b --- /dev/null +++ b/docs/reference/pygio-filterinputstream.xml @@ -0,0 +1,152 @@ +<?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-giofilterinputstream"> + <refnamediv> + <refname>gio.FilterInputStream</refname> + <refpurpose>Filter Input Stream</refpurpose> + </refnamediv> + + <refsect1> + <title>Synopsis</title> + + <classsynopsis language="python"> + <ooclass><classname>gio.FilterInputStream</classname></ooclass> + <ooclass><classname><link linkend="class-gioinputstream">gio.InputStream</link></classname></ooclass> + + <methodsynopsis language="python"> + <methodname><link linkend="method-giofilterinputstream--get-base-stream">get_base_stream</link></methodname> + <methodparam></methodparam> + </methodsynopsis> + <methodsynopsis language="python"> + <methodname><link linkend="method-giofilterinputstream--get-close-base-stream">get_close_base_stream</link></methodname> + <methodparam></methodparam> + </methodsynopsis> + <methodsynopsis language="python"> + <methodname><link linkend="method-giofilterinputstream--set-close-base-stream">set_close_base_stream</link></methodname> + <methodparam><parameter role="keyword">close_base</parameter></methodparam> + </methodsynopsis> + + </classsynopsis> + + </refsect1> + + <refsect1> + <title>Ancestry</title> + +<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link> + +-- <link linkend="class-gioinputstream">gio.InputStream</link> + +-- <link linkend="class-giofilterinputstream">gio.FilterInputStream</link> +</synopsis> + + </refsect1> + + <refsect1 id="properties-giofilterinputstream"> + <title>gio.FilterInputStream 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>"base-stream"</entry> + <entry>Read - Write - Construct only</entry> + <entry>The underlying base stream on which the io ops will be done.</entry> + </row> + <row valign="top"> + <entry>"close-base-stream"</entry> + <entry>Read - Write - Construct only</entry> + <entry>If the base stream should be closed when the filter stream is closed. + Default value: <literal>True</literal>.</entry> + </row> + </tbody> + </tgroup> + </informaltable> + </blockquote> + + </refsect1> + + <refsect1> + <title>Description</title> + + <para> + Filter Input Stream. + </para> + </refsect1> + + <refsect1> + <title>Methods</title> + + <refsect2 id="method-giofilterinputstream--get-base-stream"> + <title>gio.FilterInputStream.get_base_stream</title> + + <programlisting><methodsynopsis language="python"> + <methodname>get_base_stream</methodname> + <methodparam></methodparam> + </methodsynopsis></programlisting> + + <variablelist> + <varlistentry> + <term><emphasis>Returns</emphasis> :</term> + <listitem><simpara>A + <link linkend="class-gioinputstream"><classname>gio.InputStream</classname></link> + </simpara></listitem> + </varlistentry> + </variablelist> + + <para> + The <methodname>get_base_stream</methodname>() method gets the base + stream for the filter stream. + </para> + </refsect2> + + <refsect2 id="method-giofilterinputstream--get-close-base-stream"> + <title>gio.FilterInputStream.get_close_base_stream</title> + + <programlisting><methodsynopsis language="python"> + <methodname>get_close_base_stream</methodname> + <methodparam></methodparam> + </methodsynopsis></programlisting> + + <variablelist> + <varlistentry> + <term><emphasis>Returns</emphasis> :</term> + <listitem><simpara><literal>True</literal> if the base stream + will be closed. + </simpara></listitem> + </varlistentry> + </variablelist> + + <para> + The <methodname>get_close_base_stream</methodname>() method returns + whether the base stream will be closed when stream is closed. + </para> + </refsect2> + + <refsect2 id="method-giofilterinputstream--set-close-base-stream"> + <title>gio.FilterInputStream.set_close_base_stream</title> + + <programlisting><methodsynopsis language="python"> + <methodname>set_close_base_stream</methodname> + <methodparam><parameter role="keyword">close_base</parameter></methodparam> + </methodsynopsis></programlisting> + + <variablelist> + <varlistentry> + <term><parameter role="keyword">close_base</parameter> :</term> + <listitem><simpara><literal>True</literal> to close the base stream. + </simpara></listitem> + </varlistentry> + </variablelist> + + <para> + The <methodname>set_close_base_stream</methodname>() method sets whether + the base stream will be closed when stream is closed. + </para> + </refsect2> + </refsect1> +</refentry> |