summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorGian Mario Tagliaretti <gianmt@gnome.org>2009-06-08 11:45:11 +0200
committerGian Mario Tagliaretti <gianmt@gnome.org>2009-06-09 00:10:08 +0200
commitdfbdf23633a772e78b47b0e7b0c3e3b87855d9ff (patch)
tree415a9a91458c5d592ba80b4bdc450b4caadbdeab /docs
parentfcc3cb0e167789746a1a9db0cba54ea7a97c7259 (diff)
downloadpygobject-dfbdf23633a772e78b47b0e7b0c3e3b87855d9ff.tar.gz
pygobject-dfbdf23633a772e78b47b0e7b0c3e3b87855d9ff.tar.xz
pygobject-dfbdf23633a772e78b47b0e7b0c3e3b87855d9ff.zip
Wrap gio.memory_input_stream_new_from_data
Add the wrapper for gio.memory_input_stream_new_from_data including docs and a test.
Diffstat (limited to 'docs')
-rw-r--r--docs/Makefile.am4
-rw-r--r--docs/reference/pygio-classes.xml1
-rw-r--r--docs/reference/pygio-memoryinputstream.xml151
3 files changed, 155 insertions, 1 deletions
diff --git a/docs/Makefile.am b/docs/Makefile.am
index 85673c1..46bdc12 100644
--- a/docs/Makefile.am
+++ b/docs/Makefile.am
@@ -36,7 +36,8 @@ HTML_FILES = \
html/class-gioicon.html \
html/class-gioinputstream.html \
html/class-gioloadableicon.html \
- html/class-giomount.html \
+ html/class-giomemoryinputstream.html \
+ html/class-giomount.html \
html/class-giomountoperation.html \
html/class-giooutputstream.html \
html/class-gioseekable.html \
@@ -91,6 +92,7 @@ XML_FILES = \
reference/pygio-icon.xml \
reference/pygio-inputstream.xml \
reference/pygio-loadableicon.xml \
+ reference/pygio-memoryinputstream.xml \
reference/pygio-mount.xml \
reference/pygio-mountoperation.xml \
reference/pygio-outputstream.xml \
diff --git a/docs/reference/pygio-classes.xml b/docs/reference/pygio-classes.xml
index 0b385d6..8e5b191 100644
--- a/docs/reference/pygio-classes.xml
+++ b/docs/reference/pygio-classes.xml
@@ -27,6 +27,7 @@
<xi:include href="pygio-icon.xml"/>
<xi:include href="pygio-inputstream.xml"/>
<xi:include href="pygio-loadableicon.xml"/>
+<xi:include href="pygio-memoryinputstream.xml"/>
<xi:include href="pygio-mount.xml"/>
<xi:include href="pygio-mountoperation.xml"/>
<xi:include href="pygio-outputstream.xml"/>
diff --git a/docs/reference/pygio-memoryinputstream.xml b/docs/reference/pygio-memoryinputstream.xml
new file mode 100644
index 0000000..7d8cffb
--- /dev/null
+++ b/docs/reference/pygio-memoryinputstream.xml
@@ -0,0 +1,151 @@
+<?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-giomemoryinputstream">
+ <refnamediv>
+ <refname>gio.MemoryInputStream</refname>
+ <refpurpose>Base class for implementing streaming input</refpurpose>
+ </refnamediv>
+
+ <refsect1>
+ <title>Synopsis</title>
+
+ <classsynopsis language="python">
+ <ooclass><classname>gio.MemoryInputStream</classname></ooclass>
+ <ooclass><classname><link linkend="class-gioinputstream">gio.InputStream</link></classname></ooclass>
+
+ <constructorsynopsis language="python">
+ <methodname><link linkend="constructor-giomemoryinputstream">gio.MemoryInputStream</link></methodname>
+ <methodparam></methodparam>
+ </constructorsynopsis>
+
+
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-giomemoryinputstream--add-data">add_data</link></methodname>
+ <methodparam><parameter role="keyword">data</parameter></methodparam>
+ </methodsynopsis>
+
+ </classsynopsis>
+
+<programlisting>
+<emphasis role="bold">Functions</emphasis>
+
+<methodsynopsis language="python">
+ <methodname><link linkend="function-gio--memory-input-stream-new-from-data">gio.memory_input_stream_new_from_data</link></methodname>
+ <methodparam><parameter role="keyword">data</parameter></methodparam>
+</methodsynopsis></programlisting>
+
+ </refsect1>
+
+ <refsect1>
+ <title>Ancestry</title>
+
+<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
+ +-- <link linkend="class-gioinputstream">gio.InputStream</link>
+ +-- <link linkend="class-giomemoryinputstream">gio.MemoryInputStream</link>
+</synopsis>
+
+ </refsect1>
+
+ <refsect1>
+ <title>Implemented Interfaces</title>
+ <para>
+ <link linkend="class-giomemoryinputstream"><classname>gio.MemoryInputStream</classname></link>
+ implements
+ <link linkend="class-gioseekable"><classname>gio.Seekable</classname></link>
+ </para>
+ </refsect1>
+
+ <refsect1>
+ <title>Description</title>
+
+ <para>
+ <link linkend="class-giomemoryinputstream"><classname>gio.MemoryInputStream</classname></link>
+ is a class for using arbitrary memory chunks as input for GIO streaming input operations.
+ </para>
+ </refsect1>
+
+ <refsect1 id="constructor-giomemoryinputstream">
+ <title>Constructor</title>
+
+ <programlisting><constructorsynopsis language="python">
+ <methodname>gio.MemoryInputStream</methodname>
+ <methodparam><parameter role="keyword">icon</parameter></methodparam>
+ </constructorsynopsis></programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis>&nbsp;:</term>
+ <listitem><simpara>a new
+ <link linkend="class-giomemoryinputstream"><classname>gio.MemoryInputStream</classname></link>.
+ </simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <para>
+ Creates an empty
+ <link linkend="class-giomemoryinputstream"><classname>gio.MemoryInputStream</classname></link>.
+ </para>
+
+ </refsect1>
+
+ <refsect1>
+ <title>Methods</title>
+
+ <refsect2 id="method-giomemoryinputstream--add-data">
+ <title>gio.MemoryInputStream.add_data</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>add_data</methodname>
+ <methodparam><parameter role="keyword">data</parameter></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><parameter role="keyword">data</parameter>&nbsp;:</term>
+ <listitem><simpara>input data.
+ </simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <para>
+ The <methodname>add_data</methodname>() method appends data to data
+ that can be read from the input stream
+ </para>
+ </refsect2>
+ </refsect1>
+
+ <refsect1>
+ <title>Functions</title>
+
+ <refsect2 id="function-gio--memory-input-stream-new-from-data">
+ <title>gio.memory_input_stream_new_from_data</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>memory_input_stream_new_from_data</methodname>
+ <methodparam><parameter role="keyword">data</parameter></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><parameter>data</parameter>&nbsp;:</term>
+ <listitem><simpara>input data.
+ </simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis>&nbsp;:</term>
+ <listitem><simpara>A new
+ <link linkend="class-giomemoryinputstream"><classname>gio.MemoryInputStream</classname></link>
+ read from data
+ </simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <para>
+ The <methodname>memory_input_stream_new_from_data</methodname>() function creates
+ a new <link linkend="class-giomemoryinputstream"><classname>gio.MemoryInputStream</classname></link>
+ with data in memory.
+ </para>
+ </refsect2>
+ </refsect1>
+</refentry>