docs/reference/pygio-filteroutputstream.xml

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