← Back to branch summary

~ubuntu-branches/ubuntu/trusty/glib2.0/trusty-proposed

« back to all changes in this revision

Viewing changes to docs/reference/gio/xml/gconverterinputstream.xml

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2010-03-09 11:28:22 UTC
  • mfrom: (3.4.8 experimental)
  • Revision ID: james.westby@ubuntu.com-20100309112822-j4n0v3xbtsup8s97
Tags: 2.23.5-1ubuntu1
* Resync on Debian
* debian/patches/01_gettext-desktopfiles.patch:
  - updated to use gettext for X-GNOME-Fullname too
* debian/patches/71_gio_launch_handler.patch:
  - new gio default launch handle feature required for wncksync
* debian/control.in, 
  debian/patches/80-gtester-subunit.patch:
  - gtester-report subunit support
* debian/libglib2.0-0.symbols:
  - updated the symbols list for the gio launcher handler
* debian/rules:
  - don't break build on test suite errors, debian recently activated this but
    the build breaks even when there is no error in the testsuite

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/gio/xml/gconverterinputstream.xml
 
1
<?xml version="1.0"?>
 
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
 
3
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
 
4
<!ENTITY % local.common.attrib "xmlns:xi  CDATA  #FIXED 'http://www.w3.org/2003/XInclude'">
 
5
<!ENTITY version SYSTEM "version.xml">
 
6
]>
 
7
<refentry id="gio-GConverterInputstream">
 
8
<refmeta>
 
9
<refentrytitle role="top_of_page" id="gio-GConverterInputstream.top_of_page">GConverterInputstream</refentrytitle>
 
10
<manvolnum>3</manvolnum>
 
11
<refmiscinfo>GIO Library</refmiscinfo>
 
12
</refmeta>
 
13
 
 
14
<refnamediv>
 
15
<refname>GConverterInputstream</refname>
 
16
<refpurpose>Converter Input Stream</refpurpose>
 
17
</refnamediv>
 
18
 
 
19
<refsynopsisdiv id="gio-GConverterInputstream.synopsis" role="synopsis">
 
20
<title role="synopsis.title">Synopsis</title>
 
21
<anchor id="GConverterInputStream"/>
 
22
<synopsis>
 
23
 
 
24
#include &lt;gio/gio.h&gt;
 
25
 
 
26
                    <link linkend="GConverterInputStream-struct">GConverterInputStream</link>;
 
27
<link linkend="GInputStream">GInputStream</link> *      <link linkend="g-converter-input-stream-new">g_converter_input_stream_new</link>        (<link linkend="GInputStream">GInputStream</link> *base_stream,
 
28
                                                         <link linkend="GConverter">GConverter</link> *converter);
 
29
<link linkend="GConverter">GConverter</link> *        <link linkend="g-converter-input-stream-get-converter">g_converter_input_stream_get_converter</link>
 
30
                                                        (<link linkend="GConverterInputStream">GConverterInputStream</link> *converter_stream);
 
31
</synopsis>
 
32
</refsynopsisdiv>
 
33
 
 
34
<refsect1 id="gio-GConverterInputstream.object-hierarchy" role="object_hierarchy">
 
35
<title role="object_hierarchy.title">Object Hierarchy</title>
 
36
<synopsis>
 
37
  <link linkend="GObject">GObject</link>
 
38
   +----<link linkend="GInputStream">GInputStream</link>
 
39
         +----<link linkend="GFilterInputStream">GFilterInputStream</link>
 
40
               +----GConverterInputStream
 
41
</synopsis>
 
42
</refsect1>
 
43
 
 
44
 
 
45
 
 
46
 
 
47
 
 
48
<refsect1 id="gio-GConverterInputstream.properties" role="properties">
 
49
<title role="properties.title">Properties</title>
 
50
<synopsis>
 
51
  &quot;<link linkend="GConverterInputStream--converter">converter</link>&quot;                <link linkend="GConverter">GConverter</link>*           : Read / Write / Construct Only
 
52
</synopsis>
 
53
</refsect1>
 
54
 
 
55
 
 
56
 
 
57
<refsect1 id="gio-GConverterInputstream.description" role="desc">
 
58
<title role="desc.title">Description</title>
 
59
<para>
 
60
Converter input stream implements <link linkend="GInputStream"><type>GInputStream</type></link> and allows
 
61
conversion of data of various types during reading.</para>
 
62
<para>
 
63
</para>
 
64
</refsect1>
 
65
 
 
66
<refsect1 id="gio-GConverterInputstream.details" role="details">
 
67
<title role="details.title">Details</title>
 
68
<refsect2 id="GConverterInputStream-struct" role="struct">
 
69
<title>GConverterInputStream</title>
 
70
<indexterm zone="GConverterInputStream-struct"><primary sortas="ConverterInputStream">GConverterInputStream</primary></indexterm><programlisting>typedef struct _GConverterInputStream GConverterInputStream;</programlisting>
 
71
<para>
 
72
An implementation of <link linkend="GFilterInputStream"><type>GFilterInputStream</type></link> that allows data
 
73
conversion.</para>
 
74
<para>
 
75
</para><variablelist role="struct">
 
76
</variablelist></refsect2>
 
77
<refsect2 id="g-converter-input-stream-new" role="function">
 
78
<title>g_converter_input_stream_new ()</title>
 
79
<indexterm zone="g-converter-input-stream-new"><primary sortas="converter_input_stream_new">g_converter_input_stream_new</primary></indexterm><programlisting><link linkend="GInputStream">GInputStream</link> *      g_converter_input_stream_new        (<link linkend="GInputStream">GInputStream</link> *base_stream,
 
80
                                                         <link linkend="GConverter">GConverter</link> *converter);</programlisting>
 
81
<para>
 
82
Creates a new converter input stream for the <parameter>base_stream</parameter>.</para>
 
83
<para>
 
84
</para><variablelist role="params">
 
85
<varlistentry><term><parameter>base_stream</parameter>&#160;:</term>
 
86
<listitem><simpara> a <link linkend="GInputStream"><type>GInputStream</type></link>
 
87
</simpara></listitem></varlistentry>
 
88
<varlistentry><term><parameter>converter</parameter>&#160;:</term>
 
89
<listitem><simpara> a <link linkend="GConverter"><type>GConverter</type></link>
 
90
</simpara></listitem></varlistentry>
 
91
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a new <link linkend="GInputStream"><type>GInputStream</type></link>.
 
92
</simpara></listitem></varlistentry>
 
93
</variablelist></refsect2>
 
94
<refsect2 id="g-converter-input-stream-get-converter" role="function" condition="since:2.24">
 
95
<title>g_converter_input_stream_get_converter ()</title>
 
96
<indexterm zone="g-converter-input-stream-get-converter" role="2.24"><primary sortas="converter_input_stream_get_converter">g_converter_input_stream_get_converter</primary></indexterm><programlisting><link linkend="GConverter">GConverter</link> *        g_converter_input_stream_get_converter
 
97
                                                        (<link linkend="GConverterInputStream">GConverterInputStream</link> *converter_stream);</programlisting>
 
98
<para>
 
99
Gets the <link linkend="GConverter"><type>GConverter</type></link> that is used by <parameter>converter_stream</parameter>.</para>
 
100
<para>
 
101
</para><variablelist role="params">
 
102
<varlistentry><term><parameter>converter_stream</parameter>&#160;:</term>
 
103
<listitem><simpara> a <link linkend="GConverterInputStream"><type>GConverterInputStream</type></link>
 
104
</simpara></listitem></varlistentry>
 
105
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the converter of the converter input stream
 
106
 
 
107
</simpara></listitem></varlistentry>
 
108
</variablelist><para role="since">Since 2.24</para></refsect2>
 
109
 
 
110
</refsect1>
 
111
<refsect1 id="gio-GConverterInputstream.property-details" role="property_details">
 
112
<title role="property_details.title">Property Details</title>
 
113
<refsect2 id="GConverterInputStream--converter" role="property"><title>The <literal>&quot;converter&quot;</literal> property</title>
 
114
<indexterm zone="GConverterInputStream--converter"><primary sortas="ConverterInputStream:converter">GConverterInputStream:converter</primary></indexterm><programlisting>  &quot;converter&quot;                <link linkend="GConverter">GConverter</link>*           : Read / Write / Construct Only</programlisting>
 
115
<para>The converter object.</para></refsect2>
 
116
</refsect1>
 
117
 
 
118
 
 
119
 
 
120
<refsect1 id="gio-GConverterInputstream.see-also">
 
121
<title>See Also</title>
 
122
#GInputStream, <link linkend="GConverter"><type>GConverter</type></link>
 
123
</refsect1>
 
124
 
 
125
</refentry>