[pygobject] Add docs for gio.BufferedOutputStream class
- From: Gian Mario Tagliaretti <gianmt src gnome org>
- To: svn-commits-list gnome org
- Subject: [pygobject] Add docs for gio.BufferedOutputStream class
- Date: Sat, 13 Jun 2009 08:45:29 -0400 (EDT)
commit 268e1681fd5b46e6412d3a8db84f3f1cb02fdbde
Author: Gian Mario Tagliaretti <gianmt gnome org>
Date: Sat Jun 13 14:44:47 2009 +0200
Add docs for gio.BufferedOutputStream class
docs/Makefile.am | 96 +++++-----
docs/reference/pygio-bufferedoutputstream.xml | 275 +++++++++++++++++++++++++
docs/reference/pygio-classes.xml | 1 +
3 files changed, 325 insertions(+), 47 deletions(-)
---
diff --git a/docs/Makefile.am b/docs/Makefile.am
index f9255d1..13d2703 100644
--- a/docs/Makefile.am
+++ b/docs/Makefile.am
@@ -20,6 +20,7 @@ HTML_FILES = \
html/class-gioappinfo.html \
html/class-gioasyncresult.html \
html/class-giobufferedinputstream.html \
+ html/class-giobufferedoutputstream.html \
html/class-giocancellable.html \
html/class-giodrive.html \
html/class-gioemblem.html \
@@ -57,53 +58,54 @@ HTML_FILES = \
html/pygobject-introduction.html
-XML_FILES = \
- reference/pygobject.xml \
- reference/pygobject-introduction.xml \
- reference/pygobject-classes.xml \
- reference/pygobject-constants.xml \
- reference/pygobject-ref.xml \
- reference/pygobject-functions.xml \
- reference/pygobject-gboxed.xml \
- reference/pygobject-ginterface.xml \
- reference/pygobject-gpointer.xml \
- reference/pyglib-classes.xml \
- reference/pyglib-constants.xml \
- reference/pyglib-functions.xml \
- reference/pyglib-maincontext.xml \
- reference/pyglib-mainloop.xml \
- reference/pygio-classes.xml \
- reference/pygio-constants.xml \
- reference/pygio-applaunchcontext.xml \
- reference/pygio-appinfo.xml \
- reference/pygio-asyncresult.xml \
- reference/pygio-bufferedinputstream.xml \
- reference/pygio-cancellable.xml \
- reference/pygio-drive.xml \
- reference/pygio-emblem.xml \
- reference/pygio-emblemedicon.xml \
- reference/pygio-file.xml \
- reference/pygio-fileattributeinfo.xml \
- reference/pygio-fileenumerator.xml \
- reference/pygio-fileicon.xml \
- reference/pygio-fileinfo.xml \
- reference/pygio-fileinputstream.xml \
- 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 \
- reference/pygio-memoryinputstream.xml \
- reference/pygio-memoryoutputstream.xml \
- reference/pygio-mount.xml \
- reference/pygio-mountoperation.xml \
- reference/pygio-outputstream.xml \
- reference/pygio-seekable.xml \
- reference/pygio-simpleasyncresult.xml \
- reference/pygio-themedicon.xml \
- reference/pygio-volume.xml \
+XML_FILES = \
+ reference/pygobject.xml \
+ reference/pygobject-introduction.xml \
+ reference/pygobject-classes.xml \
+ reference/pygobject-constants.xml \
+ reference/pygobject-ref.xml \
+ reference/pygobject-functions.xml \
+ reference/pygobject-gboxed.xml \
+ reference/pygobject-ginterface.xml \
+ reference/pygobject-gpointer.xml \
+ reference/pyglib-classes.xml \
+ reference/pyglib-constants.xml \
+ reference/pyglib-functions.xml \
+ reference/pyglib-maincontext.xml \
+ reference/pyglib-mainloop.xml \
+ reference/pygio-classes.xml \
+ reference/pygio-constants.xml \
+ reference/pygio-applaunchcontext.xml \
+ reference/pygio-appinfo.xml \
+ reference/pygio-asyncresult.xml \
+ reference/pygio-bufferedinputstream.xml \
+ reference/pygio-bufferedoutputstream.xml \
+ reference/pygio-cancellable.xml \
+ reference/pygio-drive.xml \
+ reference/pygio-emblem.xml \
+ reference/pygio-emblemedicon.xml \
+ reference/pygio-file.xml \
+ reference/pygio-fileattributeinfo.xml \
+ reference/pygio-fileenumerator.xml \
+ reference/pygio-fileicon.xml \
+ reference/pygio-fileinfo.xml \
+ reference/pygio-fileinputstream.xml \
+ 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 \
+ reference/pygio-memoryinputstream.xml \
+ reference/pygio-memoryoutputstream.xml \
+ reference/pygio-mount.xml \
+ reference/pygio-mountoperation.xml \
+ reference/pygio-outputstream.xml \
+ reference/pygio-seekable.xml \
+ reference/pygio-simpleasyncresult.xml \
+ reference/pygio-themedicon.xml \
+ reference/pygio-volume.xml \
reference/pygio-volumemonitor.xml
XSL_FILES = \
diff --git a/docs/reference/pygio-bufferedoutputstream.xml b/docs/reference/pygio-bufferedoutputstream.xml
new file mode 100644
index 0000000..6d7900f
--- /dev/null
+++ b/docs/reference/pygio-bufferedoutputstream.xml
@@ -0,0 +1,275 @@
+<?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-giobufferedoutputstream">
+ <refnamediv>
+ <refname>gio.BufferedOutputStream</refname>
+ <refpurpose>Buffered Output Stream</refpurpose>
+ </refnamediv>
+
+ <refsect1>
+ <title>Synopsis</title>
+
+ <classsynopsis language="python">
+ <ooclass><classname>gio.BufferedOutputStream</classname></ooclass>
+ <ooclass><classname><link linkend="class-giofilteroutputstream">gio.FilterOutputStream</link></classname></ooclass>
+
+ <constructorsynopsis language="python">
+ <methodname><link linkend="constructor-giobufferedoutputstream">gio.BufferedOutputStream</link></methodname>
+ <methodparam><parameter role="keyword">base_stream</parameter></methodparam>
+ </constructorsynopsis>
+
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-giobufferedoutputstream--get-auto-grow">get_auto_grow</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-giobufferedoutputstream--get-buffer-size">get_buffer_size</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-giobufferedoutputstream--set-auto-grow">set_auto_grow</link></methodname>
+ <methodparam><parameter role="keyword">auto_grow</parameter></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-giobufferedoutputstream--set-buffer-size">set_buffer_size</link></methodname>
+ <methodparam><parameter role="keyword">size</parameter></methodparam>
+ </methodsynopsis>
+
+ </classsynopsis>
+
+<programlisting>
+<emphasis role="bold">Functions</emphasis>
+
+<methodsynopsis language="python">
+ <methodname><link linkend="function-gio--buffered-output-stream-new-sized">gio.buffered_output_stream_new_sized</link></methodname>
+ <methodparam><parameter role="keyword">size</parameter></methodparam>
+</methodsynopsis></programlisting>
+
+ </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>
+ +-- <link linkend="class-giobufferedoutputstream">gio.BufferedOutputStream</link>
+</synopsis>
+
+ </refsect1>
+
+ <refsect1 id="properties-giobufferedoutputstream">
+ <title>gio.BufferedOutputStream 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>"auto-grow"</entry>
+ <entry>Read - Write</entry>
+ <entry>Whether the buffer should automatically grow. Default value: <literal>False</literal>.</entry>
+ </row>
+ <row valign="top">
+ <entry>"buffer-size"</entry>
+ <entry>Read - Write - Construct</entry>
+ <entry>The size of the backend buffer. Allowed values: >= 1. Default value: 4096.</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </blockquote>
+
+ </refsect1>
+
+ <refsect1>
+ <title>Description</title>
+
+ <para>
+ <link linkend="class-giobufferedoutputstream"><classname>gio.BufferedOutputStream</classname></link>
+ implements <link linkend="class-giofilteroutputstream"><classname>gio.FilterOutputStream</classname></link>
+ and provides for buffered writes.
+ </para>
+ <para>
+ By default,
+ <link linkend="class-giobufferedoutputstream"><classname>gio.BufferedOutputStream</classname></link>'s
+ buffer size is set at 4 kilobytes.
+ </para>
+ <para>
+ To create a buffered output stream, use
+ <methodname><link linkend="constructor-giobufferedoutputstream">gio.BufferedOutputStream</link></methodname>(),
+ or <methodname><link linkend="function-gio--buffered-output-stream-new-sized">gio.buffered_output_stream_new_sized</link></methodname>()
+ to specify the buffer's size at construction.
+ </para>
+ <para>
+ To get the size of a buffer within a buffered output stream, use
+ <methodname><link linkend="method-giobufferedoutputstream--get-buffer-size">gio.BufferedOutputStream.get_buffer_size</link></methodname>().
+ To change the size of a buffered output stream's buffer, use
+ <methodname><link linkend="method-giobufferedoutputstream--set-buffer-size">gio.BufferedOutputStream.set_buffer_size</link></methodname>().
+ Note that the buffer's size cannot be reduced below the size of the data within the buffer.
+ </para>
+ </refsect1>
+
+ <refsect1 id="constructor-giobufferedoutputstream">
+ <title>Constructor</title>
+
+ <programlisting><constructorsynopsis language="python">
+ <methodname>gio.BufferedOutputStream</methodname>
+ <methodparam><parameter role="keyword">base_stream</parameter></methodparam>
+ </constructorsynopsis></programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>base_stream</parameter> :</term>
+ <listitem><simpara>a
+ <link linkend="class-giooutputstream"><classname>gio.OutputStream</classname></link>.
+ </simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>a new
+ <link linkend="class-giooutputstream"><classname>gio.OutputStream</classname></link>
+ for the given base_stream.
+ </simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <para>
+ Creates a new buffered output stream for a base stream.
+ </para>
+
+ </refsect1>
+
+ <refsect1>
+ <title>Methods</title>
+
+ <refsect2 id="method-giobufferedoutputstream--get-auto-grow">
+ <title>gio.BufferedOutputStream.get_auto_grow</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>get_auto_grow</methodname>
+ <methodparam></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara><literal>True</literal> if the stream's
+ buffer automatically grows, <literal>False</literal> otherwise.
+ </simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <para>
+ The <methodname>get_auto_grow</methodname>() method checks if the
+ buffer automatically grows as data is added.
+ </para>
+ </refsect2>
+
+ <refsect2 id="method-giobufferedoutputstream--get-buffer-size">
+ <title>gio.BufferedOutputStream.get_buffer_size</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>get_buffer_size</methodname>
+ <methodparam></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>the current buffer size.
+ </simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <para>
+ The <methodname>get_buffer_size</methodname>() method gets the size
+ of the buffer in the stream.
+ </para>
+ </refsect2>
+
+ <refsect2 id="method-giobufferedoutputstream--set-auto-grow">
+ <title>gio.BufferedOutputStream.set_auto_grow</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>set_auto_grow</methodname>
+ <methodparam><parameter role="keyword">auto_grow</parameter></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><parameter role="keyword">auto_grow</parameter> :</term>
+ <listitem><simpara>a boolean.
+ </simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <para>
+ The <methodname>set_auto_grow</methodname>() method sets whether or not
+ the stream's buffer should automatically grow. If auto_grow is true,
+ then each write will just make the buffer larger, and you must manually
+ flush the buffer to actually write out the data to the underlying stream.
+ </para>
+ </refsect2>
+
+ <refsect2 id="method-giobufferedoutputstream--set-buffer-size">
+ <title>gio.BufferedOutputStream.set_buffer_size</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>set_buffer_size</methodname>
+ <methodparam><parameter role="keyword">size</parameter></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><parameter role="keyword">size</parameter> :</term>
+ <listitem><simpara>the new buffer size.
+ </simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <para>
+ The <methodname>set_buffer_size</methodname>() method sets the size of
+ the internal buffer to size.
+ </para>
+ </refsect2>
+ </refsect1>
+
+ <refsect1>
+ <title>Functions</title>
+
+ <refsect2 id="function-gio--buffered-output-stream-new-sized">
+ <title>gio.buffered_output_stream_new_sized</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>buffered_output_stream_new_sized</methodname>
+ <methodparam><parameter role="keyword">size</parameter></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><parameter>size</parameter> :</term>
+ <listitem><simpara>the requested buffer size.
+ </simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>A new
+ <link linkend="class-giooutputstream"><classname>gio.OutputStream</classname></link>
+ with an internal buffer set to size..
+ </simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <para>
+ The <methodname>buffered_output_stream_new_sized</methodname>() function creates
+ a new <link linkend="class-giobufferedoutputstream"><classname>gio.BufferedOutputStream</classname></link>
+ from the given base_stream, with a buffer set to size.
+ </para>
+ </refsect2>
+ </refsect1>
+</refentry>
diff --git a/docs/reference/pygio-classes.xml b/docs/reference/pygio-classes.xml
index f9396cb..1c59d61 100644
--- a/docs/reference/pygio-classes.xml
+++ b/docs/reference/pygio-classes.xml
@@ -11,6 +11,7 @@
<xi:include href="pygio-applaunchcontext.xml"/>
<xi:include href="pygio-asyncresult.xml"/>
<xi:include href="pygio-bufferedinputstream.xml"/>
+<xi:include href="pygio-bufferedoutputstream.xml"/>
<xi:include href="pygio-cancellable.xml"/>
<xi:include href="pygio-drive.xml"/>
<xi:include href="pygio-emblem.xml"/>
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
