diff options
Diffstat (limited to 'docs/reference/pygio-memoryinputstream.xml')
| -rw-r--r-- | docs/reference/pygio-memoryinputstream.xml | 151 |
1 files changed, 151 insertions, 0 deletions
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> :</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> :</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> :</term> + <listitem><simpara>input data. + </simpara></listitem> + </varlistentry> + <varlistentry> + <term><emphasis>Returns</emphasis> :</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> |