1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
|
<?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-giofilterinputstream">
<refnamediv>
<refname>gio.FilterInputStream</refname>
<refpurpose>Filter Input Stream</refpurpose>
</refnamediv>
<refsect1>
<title>Synopsis</title>
<classsynopsis language="python">
<ooclass><classname>gio.FilterInputStream</classname></ooclass>
<ooclass><classname><link linkend="class-gioinputstream">gio.InputStream</link></classname></ooclass>
<methodsynopsis language="python">
<methodname><link linkend="method-giofilterinputstream--get-base-stream">get_base_stream</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-giofilterinputstream--get-close-base-stream">get_close_base_stream</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-giofilterinputstream--set-close-base-stream">set_close_base_stream</link></methodname>
<methodparam><parameter role="keyword">close_base</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
</refsect1>
<refsect1>
<title>Ancestry</title>
<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
+-- <link linkend="class-gioinputstream">gio.InputStream</link>
+-- <link linkend="class-giofilterinputstream">gio.FilterInputStream</link>
</synopsis>
</refsect1>
<refsect1 id="properties-giofilterinputstream">
<title>gio.FilterInputStream Properties</title>
<blockquote role="properties">
<informaltable pgwide="1" frame="none">
<tgroup cols="3">
<colspec column="1" colwidth="1in"/>
<colspec column="2" colwidth="1in"/>
<colspec column="3" colwidth="4in"/>
<tbody>
<row valign="top">
<entry>"base-stream"</entry>
<entry>Read - Write - Construct only</entry>
<entry>The underlying base stream on which the io ops will be done.</entry>
</row>
<row valign="top">
<entry>"close-base-stream"</entry>
<entry>Read - Write - Construct only</entry>
<entry>If the base stream should be closed when the filter stream is closed.
Default value: <literal>True</literal>.</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</blockquote>
</refsect1>
<refsect1>
<title>Description</title>
<para>
Filter Input Stream.
</para>
</refsect1>
<refsect1>
<title>Methods</title>
<refsect2 id="method-giofilterinputstream--get-base-stream">
<title>gio.FilterInputStream.get_base_stream</title>
<programlisting><methodsynopsis language="python">
<methodname>get_base_stream</methodname>
<methodparam></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>A
<link linkend="class-gioinputstream"><classname>gio.InputStream</classname></link>
</simpara></listitem>
</varlistentry>
</variablelist>
<para>
The <methodname>get_base_stream</methodname>() method gets the base
stream for the filter stream.
</para>
</refsect2>
<refsect2 id="method-giofilterinputstream--get-close-base-stream">
<title>gio.FilterInputStream.get_close_base_stream</title>
<programlisting><methodsynopsis language="python">
<methodname>get_close_base_stream</methodname>
<methodparam></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara><literal>True</literal> if the base stream
will be closed.
</simpara></listitem>
</varlistentry>
</variablelist>
<para>
The <methodname>get_close_base_stream</methodname>() method returns
whether the base stream will be closed when stream is closed.
</para>
</refsect2>
<refsect2 id="method-giofilterinputstream--set-close-base-stream">
<title>gio.FilterInputStream.set_close_base_stream</title>
<programlisting><methodsynopsis language="python">
<methodname>set_close_base_stream</methodname>
<methodparam><parameter role="keyword">close_base</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">close_base</parameter> :</term>
<listitem><simpara><literal>True</literal> to close the base stream.
</simpara></listitem>
</varlistentry>
</variablelist>
<para>
The <methodname>set_close_base_stream</methodname>() method sets whether
the base stream will be closed when stream is closed.
</para>
</refsect2>
</refsect1>
</refentry>
|
