← 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/gfilteroutputstream.xml

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2010-03-23 19:25:52 UTC
  • mfrom: (3.4.9 experimental)
  • Revision ID: james.westby@ubuntu.com-20100323192552-istna8c33bw6harh
Tags: 2.23.6-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

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/gio/xml/gfilteroutputstream.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="GFilterOutputStream">
8
 
<refmeta>
9
 
<refentrytitle role="top_of_page" id="GFilterOutputStream.top_of_page">GFilterOutputStream</refentrytitle>
10
 
<manvolnum>3</manvolnum>
11
 
<refmiscinfo>GIO Library</refmiscinfo>
12
 
</refmeta>
13
 
 
14
 
<refnamediv>
15
 
<refname>GFilterOutputStream</refname>
16
 
<refpurpose>Filter Output Stream</refpurpose>
17
 
</refnamediv>
18
 
 
19
 
<refsynopsisdiv id="GFilterOutputStream.synopsis" role="synopsis">
20
 
<title role="synopsis.title">Synopsis</title>
21
 
 
22
 
<synopsis>
23
 
 
24
 
#include &lt;gio/gio.h&gt;
25
 
 
26
 
                    <link linkend="GFilterOutputStream-struct">GFilterOutputStream</link>;
27
 
<link linkend="GOutputStream">GOutputStream</link> *     <link linkend="g-filter-output-stream-get-base-stream">g_filter_output_stream_get_base_stream</link>
28
 
                                                        (<link linkend="GFilterOutputStream">GFilterOutputStream</link> *stream);
29
 
<link linkend="gboolean">gboolean</link>            <link linkend="g-filter-output-stream-get-close-base-stream">g_filter_output_stream_get_close_base_stream</link>
30
 
                                                        (<link linkend="GFilterOutputStream">GFilterOutputStream</link> *stream);
31
 
<link linkend="void">void</link>                <link linkend="g-filter-output-stream-set-close-base-stream">g_filter_output_stream_set_close_base_stream</link>
32
 
                                                        (<link linkend="GFilterOutputStream">GFilterOutputStream</link> *stream,
33
 
                                                         <link linkend="gboolean">gboolean</link> close_base);
34
 
</synopsis>
35
 
</refsynopsisdiv>
36
 
 
37
 
<refsect1 id="GFilterOutputStream.object-hierarchy" role="object_hierarchy">
38
 
<title role="object_hierarchy.title">Object Hierarchy</title>
39
 
<synopsis>
40
 
  <link linkend="GObject">GObject</link>
41
 
   +----<link linkend="GOutputStream">GOutputStream</link>
42
 
         +----GFilterOutputStream
43
 
               +----<link linkend="GBufferedOutputStream">GBufferedOutputStream</link>
44
 
               +----<link linkend="GConverterOutputStream">GConverterOutputStream</link>
45
 
               +----<link linkend="GDataOutputStream">GDataOutputStream</link>
46
 
</synopsis>
47
 
</refsect1>
48
 
 
49
 
 
50
 
 
51
 
 
52
 
 
53
 
<refsect1 id="GFilterOutputStream.properties" role="properties">
54
 
<title role="properties.title">Properties</title>
55
 
<synopsis>
56
 
  &quot;<link linkend="GFilterOutputStream--base-stream">base-stream</link>&quot;              <link linkend="GOutputStream">GOutputStream</link>*        : Read / Write / Construct Only
57
 
  &quot;<link linkend="GFilterOutputStream--close-base-stream">close-base-stream</link>&quot;        <link linkend="gboolean">gboolean</link>              : Read / Write / Construct Only
58
 
</synopsis>
59
 
</refsect1>
60
 
 
61
 
 
62
 
 
63
 
<refsect1 id="GFilterOutputStream.description" role="desc">
64
 
<title role="desc.title">Description</title>
65
 
<para>
66
 
</para>
67
 
<para>
68
 
</para>
69
 
</refsect1>
70
 
 
71
 
<refsect1 id="GFilterOutputStream.details" role="details">
72
 
<title role="details.title">Details</title>
73
 
<refsect2 id="GFilterOutputStream-struct" role="struct">
74
 
<title>GFilterOutputStream</title>
75
 
<indexterm zone="GFilterOutputStream-struct"><primary sortas="FilterOutputStream">GFilterOutputStream</primary></indexterm><programlisting>typedef struct _GFilterOutputStream GFilterOutputStream;</programlisting>
76
 
<para>
77
 
A base class for all output streams that work on an underlying stream.</para>
78
 
<para>
79
 
</para></refsect2>
80
 
<refsect2 id="g-filter-output-stream-get-base-stream" role="function">
81
 
<title>g_filter_output_stream_get_base_stream ()</title>
82
 
<indexterm zone="g-filter-output-stream-get-base-stream"><primary sortas="filter_output_stream_get_base_stream">g_filter_output_stream_get_base_stream</primary></indexterm><programlisting><link linkend="GOutputStream">GOutputStream</link> *     g_filter_output_stream_get_base_stream
83
 
                                                        (<link linkend="GFilterOutputStream">GFilterOutputStream</link> *stream);</programlisting>
84
 
<para>
85
 
Gets the base stream for the filter stream.</para>
86
 
<para>
87
 
</para><variablelist role="params">
88
 
<varlistentry><term><parameter>stream</parameter>&#160;:</term>
89
 
<listitem><simpara> a <link linkend="GFilterOutputStream"><type>GFilterOutputStream</type></link>.
90
 
</simpara></listitem></varlistentry>
91
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a <link linkend="GOutputStream"><type>GOutputStream</type></link>.
92
 
</simpara></listitem></varlistentry>
93
 
</variablelist></refsect2>
94
 
<refsect2 id="g-filter-output-stream-get-close-base-stream" role="function">
95
 
<title>g_filter_output_stream_get_close_base_stream ()</title>
96
 
<indexterm zone="g-filter-output-stream-get-close-base-stream"><primary sortas="filter_output_stream_get_close_base_stream">g_filter_output_stream_get_close_base_stream</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            g_filter_output_stream_get_close_base_stream
97
 
                                                        (<link linkend="GFilterOutputStream">GFilterOutputStream</link> *stream);</programlisting>
98
 
<para>
99
 
Returns whether the base stream will be closed when <parameter>stream</parameter> is
100
 
closed.</para>
101
 
<para>
102
 
</para><variablelist role="params">
103
 
<varlistentry><term><parameter>stream</parameter>&#160;:</term>
104
 
<listitem><simpara> a <link linkend="GFilterOutputStream"><type>GFilterOutputStream</type></link>.
105
 
</simpara></listitem></varlistentry>
106
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if the base stream will be closed.
107
 
</simpara></listitem></varlistentry>
108
 
</variablelist></refsect2>
109
 
<refsect2 id="g-filter-output-stream-set-close-base-stream" role="function">
110
 
<title>g_filter_output_stream_set_close_base_stream ()</title>
111
 
<indexterm zone="g-filter-output-stream-set-close-base-stream"><primary sortas="filter_output_stream_set_close_base_stream">g_filter_output_stream_set_close_base_stream</primary></indexterm><programlisting><link linkend="void">void</link>                g_filter_output_stream_set_close_base_stream
112
 
                                                        (<link linkend="GFilterOutputStream">GFilterOutputStream</link> *stream,
113
 
                                                         <link linkend="gboolean">gboolean</link> close_base);</programlisting>
114
 
<para>
115
 
Sets whether the base stream will be closed when <parameter>stream</parameter> is closed.</para>
116
 
<para>
117
 
</para><variablelist role="params">
118
 
<varlistentry><term><parameter>stream</parameter>&#160;:</term>
119
 
<listitem><simpara> a <link linkend="GFilterOutputStream"><type>GFilterOutputStream</type></link>.
120
 
</simpara></listitem></varlistentry>
121
 
<varlistentry><term><parameter>close_base</parameter>&#160;:</term>
122
 
<listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> to close the base stream.
123
 
</simpara></listitem></varlistentry>
124
 
</variablelist></refsect2>
125
 
 
126
 
</refsect1>
127
 
<refsect1 id="GFilterOutputStream.property-details" role="property_details">
128
 
<title role="property_details.title">Property Details</title>
129
 
<refsect2 id="GFilterOutputStream--base-stream" role="property"><title>The <literal>&quot;base-stream&quot;</literal> property</title>
130
 
<indexterm zone="GFilterOutputStream--base-stream"><primary sortas="FilterOutputStream:base-stream">GFilterOutputStream:base-stream</primary></indexterm><programlisting>  &quot;base-stream&quot;              <link linkend="GOutputStream">GOutputStream</link>*        : Read / Write / Construct Only</programlisting>
131
 
<para>The underlying base stream on which the io ops will be done.</para></refsect2>
132
 
<refsect2 id="GFilterOutputStream--close-base-stream" role="property"><title>The <literal>&quot;close-base-stream&quot;</literal> property</title>
133
 
<indexterm zone="GFilterOutputStream--close-base-stream"><primary sortas="FilterOutputStream:close-base-stream">GFilterOutputStream:close-base-stream</primary></indexterm><programlisting>  &quot;close-base-stream&quot;        <link linkend="gboolean">gboolean</link>              : Read / Write / Construct Only</programlisting>
134
 
<para>If the base stream should be closed when the filter stream is closed.</para><para>Default value: TRUE</para>
135
 
</refsect2>
136
 
</refsect1>
137
 
 
138
 
 
139
 
 
140
 
 
141
 
</refentry>