← Back to branch summary

~ubuntu-branches/debian/squeeze/glib2.0/squeeze

« back to all changes in this revision

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

  • Committer: Bazaar Package Importer
  • Author(s): Gustavo Noronha Silva
  • Date: 2009-02-15 13:00:43 UTC
  • mfrom: (1.3.1 upstream) (69.1.10 intrepid)
  • Revision ID: james.westby@ubuntu.com-20090215130043-q47fbt3owmt42m2f
Tags: 2.18.4-2
* Release to unstable
* debian/rules:
- bump SHVER, since we are already forcing a 2.18.0 dependecy on the
  symbols introduced in the development versions
* debian/control.in:
- added Homepage and Vcs-* control fields

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/gio/xml/gfilterinputstream.xml
5
5
]>
6
6
<refentry id="GFilterInputStream">
7
7
<refmeta>
8
 
<refentrytitle role="top_of_page">GFilterInputStream</refentrytitle>
 
8
<refentrytitle role="top_of_page" id="GFilterInputStream.top_of_page">GFilterInputStream</refentrytitle>
9
9
<manvolnum>3</manvolnum>
10
10
<refmiscinfo>GIO Library</refmiscinfo>
11
11
</refmeta>
13
13
<refnamediv>
14
14
<refname>GFilterInputStream</refname>
15
15
<refpurpose>Filter Input Stream</refpurpose>
16
 
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
17
16
</refnamediv>
18
17
 
19
 
<refsynopsisdiv role="synopsis">
 
18
<refsynopsisdiv id="GFilterInputStream.synopsis" role="synopsis">
20
19
<title role="synopsis.title">Synopsis</title>
21
20
 
22
21
<synopsis>
23
22
 
24
23
#include &lt;gio/gio.h&gt;
25
24
 
26
 
 
27
25
                    <link linkend="GFilterInputStream-struct">GFilterInputStream</link>;
28
 
<link linkend="GInputStream">GInputStream</link>*       <link linkend="g-filter-input-stream-get-base-stream">g_filter_input_stream_get_base_stream</link>
 
26
<link linkend="GInputStream">GInputStream</link> *      <link linkend="g-filter-input-stream-get-base-stream">g_filter_input_stream_get_base_stream</link>
29
27
                                                        (<link linkend="GFilterInputStream">GFilterInputStream</link> *stream);
30
 
 
31
 
 
32
28
</synopsis>
33
29
</refsynopsisdiv>
34
30
 
35
 
<refsect1 role="object_hierarchy">
 
31
<refsect1 id="GFilterInputStream.object-hierarchy" role="object_hierarchy">
36
32
<title role="object_hierarchy.title">Object Hierarchy</title>
37
33
<synopsis>
38
 
 
39
34
  <link linkend="GObject">GObject</link>
40
35
   +----<link linkend="GInputStream">GInputStream</link>
41
36
         +----GFilterInputStream
42
37
               +----<link linkend="GBufferedInputStream">GBufferedInputStream</link>
43
38
</synopsis>
44
 
 
45
39
</refsect1>
46
40
 
47
41
 
48
42
 
49
43
 
50
44
 
51
 
<refsect1 role="properties">
 
45
<refsect1 id="GFilterInputStream.properties" role="properties">
52
46
<title role="properties.title">Properties</title>
53
47
<synopsis>
54
 
 
55
 
  &quot;<link linkend="GFilterInputStream--base-stream">base-stream</link>&quot;              <link linkend="GInputStream">GInputStream</link>          : Read / Write / Construct Only
 
48
  &quot;<link linkend="GFilterInputStream--base-stream">base-stream</link>&quot;              <link linkend="GInputStream">GInputStream</link>*         : Read / Write / Construct Only
56
49
</synopsis>
57
50
</refsect1>
58
51
 
59
52
 
60
53
 
61
 
<refsect1 role="desc">
 
54
<refsect1 id="GFilterInputStream.description" role="desc">
62
55
<title role="desc.title">Description</title>
63
56
<para>
64
57
</para>
65
58
<para>
66
 
 
67
59
</para>
68
60
</refsect1>
69
61
 
70
 
<refsect1 role="details">
 
62
<refsect1 id="GFilterInputStream.details" role="details">
71
63
<title role="details.title">Details</title>
72
 
<refsect2>
73
 
<title><anchor id="GFilterInputStream-struct" role="struct"/>GFilterInputStream</title>
74
 
<indexterm><primary>GFilterInputStream</primary></indexterm><programlisting>typedef struct _GFilterInputStream GFilterInputStream;</programlisting>
 
64
<refsect2 id="GFilterInputStream-struct" role="struct">
 
65
<title>GFilterInputStream</title>
 
66
<indexterm zone="GFilterInputStream-struct"><primary sortas="GFilterInputStream">GFilterInputStream</primary></indexterm><programlisting>typedef struct _GFilterInputStream GFilterInputStream;</programlisting>
75
67
<para>
76
68
A base class for all input streams that work on an underlying stream.</para>
77
69
<para>
78
 
 
79
70
</para></refsect2>
80
 
<refsect2>
81
 
<title><anchor id="g-filter-input-stream-get-base-stream" role="function"/>g_filter_input_stream_get_base_stream ()</title>
82
 
<indexterm><primary>g_filter_input_stream_get_base_stream</primary></indexterm><programlisting><link linkend="GInputStream">GInputStream</link>*       g_filter_input_stream_get_base_stream
 
71
<refsect2 id="g-filter-input-stream-get-base-stream" role="function">
 
72
<title>g_filter_input_stream_get_base_stream ()</title>
 
73
<indexterm zone="g-filter-input-stream-get-base-stream"><primary sortas="g_filter_input_stream_get_base_stream">g_filter_input_stream_get_base_stream</primary></indexterm><programlisting><link linkend="GInputStream">GInputStream</link> *      g_filter_input_stream_get_base_stream
83
74
                                                        (<link linkend="GFilterInputStream">GFilterInputStream</link> *stream);</programlisting>
84
75
<para>
85
76
Gets the base stream for the filter stream.</para>
86
77
<para>
87
 
 
88
78
</para><variablelist role="params">
89
 
<varlistentry><term><parameter>stream</parameter>&nbsp;:</term>
 
79
<varlistentry><term><parameter>stream</parameter>&#160;:</term>
90
80
<listitem><simpara> a <link linkend="GFilterInputStream"><type>GFilterInputStream</type></link>.
91
81
</simpara></listitem></varlistentry>
92
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a <link linkend="GInputStream"><type>GInputStream</type></link>.
 
82
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a <link linkend="GInputStream"><type>GInputStream</type></link>.
93
83
</simpara></listitem></varlistentry>
94
84
</variablelist></refsect2>
95
85
 
96
86
</refsect1>
97
 
<refsect1 role="property_details">
 
87
<refsect1 id="GFilterInputStream.property-details" role="property_details">
98
88
<title role="property_details.title">Property Details</title>
99
 
<refsect2><title><anchor id="GFilterInputStream--base-stream"/>The <literal>&quot;base-stream&quot;</literal> property</title>
100
 
<indexterm><primary>GFilterInputStream:base-stream</primary></indexterm><programlisting>  &quot;base-stream&quot;              <link linkend="GInputStream">GInputStream</link>          : Read / Write / Construct Only</programlisting>
 
89
<refsect2 id="GFilterInputStream--base-stream" role="property"><title>The <literal>&quot;base-stream&quot;</literal> property</title>
 
90
<indexterm zone="GFilterInputStream--base-stream"><primary sortas="GFilterInputStream:base-stream">GFilterInputStream:base-stream</primary></indexterm><programlisting>  &quot;base-stream&quot;              <link linkend="GInputStream">GInputStream</link>*         : Read / Write / Construct Only</programlisting>
101
91
<para>The underlying base stream the io ops will be done on.</para></refsect2>
102
 
 
103
92
</refsect1>
104
93
 
105
94
 
106
95
 
107
96
 
108
 
 
109
 
<refsect1><refsect2 /><refsect2 /></refsect1>
110
97
</refentry>