From fded60d8376fc45d19bf6cd8be6b927cc3f2e8c6 Mon Sep 17 00:00:00 2001
From: Gian Mario Tagliaretti <gianmt@gnome.org>
Date: Tue, 2 Jun 2009 18:27:00 +0200
Subject: Add gio.FilterOutputStream docs

---
 docs/Makefile.am                            |   2 +
 docs/reference/pygio-classes.xml            |   1 +
 docs/reference/pygio-filteroutputstream.xml | 152 ++++++++++++++++++++++++++++
 3 files changed, 155 insertions(+)
 create mode 100644 docs/reference/pygio-filteroutputstream.xml

diff --git a/docs/Makefile.am b/docs/Makefile.am
index c7358c3..85673c1 100644
--- a/docs/Makefile.am
+++ b/docs/Makefile.am
@@ -32,6 +32,7 @@ HTML_FILES =					\
 	html/class-giofilemonitor.html		\
 	html/class-giofileoutputstream.html	\
 	html/class-giofilterinputstream.html	\
+	html/class-giofilteroutputstream.html	\
 	html/class-gioicon.html			\
 	html/class-gioinputstream.html		\
 	html/class-gioloadableicon.html		\
@@ -86,6 +87,7 @@ XML_FILES = 					\
 	reference/pygio-filemonitor.xml		\
 	reference/pygio-fileoutputstream.xml 	\
 	reference/pygio-filterinputstream.xml 	\
+	reference/pygio-filteroutputstream.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 eada7c6..0b385d6 100644
--- a/docs/reference/pygio-classes.xml
+++ b/docs/reference/pygio-classes.xml
@@ -23,6 +23,7 @@
 <xi:include href="pygio-filemonitor.xml"/>
 <xi:include href="pygio-fileoutputstream.xml"/>
 <xi:include href="pygio-filterinputstream.xml"/>
+<xi:include href="pygio-filteroutputstream.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-filteroutputstream.xml b/docs/reference/pygio-filteroutputstream.xml
new file mode 100644
index 0000000..7c9322e
--- /dev/null
+++ b/docs/reference/pygio-filteroutputstream.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-giofilteroutputstream">
+    <refnamediv>
+        <refname>gio.FilterOutputStream</refname>
+        <refpurpose>Filter Output Stream</refpurpose>
+    </refnamediv>
+
+    <refsect1>
+        <title>Synopsis</title>
+
+    <classsynopsis language="python">
+        <ooclass><classname>gio.FilterOutputStream</classname></ooclass>
+        <ooclass><classname><link linkend="class-giooutputstream">gio.OutputStream</link></classname></ooclass>
+    
+    <methodsynopsis language="python">
+        <methodname><link linkend="method-giofilteroutputstream--get-base-stream">get_base_stream</link></methodname>
+        <methodparam></methodparam>
+    </methodsynopsis>
+    <methodsynopsis language="python">
+        <methodname><link linkend="method-giofilteroutputstream--get-close-base-stream">get_close_base_stream</link></methodname>
+        <methodparam></methodparam>
+    </methodsynopsis>
+    <methodsynopsis language="python">
+        <methodname><link linkend="method-giofilteroutputstream--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-giooutputstream">gio.OutputStream</link>
+    +-- <link linkend="class-giofilteroutputstream">gio.FilterOutputStream</link>
+</synopsis>
+
+    </refsect1>
+
+    <refsect1 id="properties-giofilterinputstream">
+        <title>gio.FilterOutputStream 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-giofilteroutputstream--get-base-stream">
+            <title>gio.FilterOutputStream.get_base_stream</title>
+
+            <programlisting><methodsynopsis language="python">
+                <methodname>get_base_stream</methodname>
+                <methodparam></methodparam>
+            </methodsynopsis></programlisting>
+            
+            <variablelist>
+                <varlistentry>
+                    <term><emphasis>Returns</emphasis>&nbsp;:</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-giofilteroutputstream--get-close-base-stream">
+            <title>gio.FilterOutputStream.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>&nbsp;:</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-giofilteroutputstream--set-close-base-stream">
+            <title>gio.FilterOutputStream.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>&nbsp;:</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>
-- 
cgit