<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>glibmm: Gio::FilterInputStream Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="namespaceGio.html">Gio</a>::<a class="el" href="classGio_1_1FilterInputStream.html">FilterInputStream</a>
</div>
</div>
<div class="contents">
<h1>Gio::FilterInputStream Class Reference<br/>
<small>
[<a class="el" href="group__Streams.html">Stream Classes</a>]</small>
</h1><!-- doxytag: class="Gio::FilterInputStream" --><!-- doxytag: inherits="Gio::InputStream" -->
<p>Filter Input Stream. <a href="#_details">More...</a></p>
<p>Inherits <a class="el" href="classGio_1_1InputStream.html">Gio::InputStream</a>.</p>
<p>Inherited by <a class="el" href="classGio_1_1BufferedInputStream.html">Gio::BufferedInputStream</a>.</p>
<div class="dynheader">
Collaboration diagram for Gio::FilterInputStream:</div>
<div class="dynsection">
<div class="center"><img src="classGio_1_1FilterInputStream__coll__graph.png" border="0" usemap="#Gio_1_1FilterInputStream_coll__map" alt="Collaboration graph"/></div>
<map name="Gio_1_1FilterInputStream_coll__map" id="Gio_1_1FilterInputStream_coll__map">
<area shape="rect" href="classGio_1_1InputStream.html" title="Base class for implementing streaming input." alt="" coords="20,237,140,267"/><area shape="rect" href="classGlib_1_1Object.html" title="Glib::Object" alt="" coords="35,160,125,189"/><area shape="rect" href="classGlib_1_1ObjectBase.html" title="Glib::ObjectBase is a common base class for Objects and Interfaces." alt="" coords="20,83,140,112"/><area shape="rect" href="../../../libsigc++-2.0/reference/html/structsigc_1_1trackable.html" title="sigc::trackable" alt="" coords="27,5,133,35"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classGio_1_1FilterInputStream-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1FilterInputStream.html#a5d3ea75436d7681061f6c320225d7848">~FilterInputStream</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">GFilterInputStream* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1FilterInputStream.html#a6db43589745dcd172f4ca4082bc5d914">gobj</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GObject. <a href="#a6db43589745dcd172f4ca4082bc5d914"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const GFilterInputStream* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1FilterInputStream.html#ac8fbd2cc879bfab4854d952b27ce271c">gobj</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GObject. <a href="#ac8fbd2cc879bfab4854d952b27ce271c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">GFilterInputStream* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1FilterInputStream.html#a55ef3320e423245cc69066c90785328e">gobj_copy</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. <a href="#a55ef3320e423245cc69066c90785328e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classGio_1_1InputStream.html">InputStream</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1FilterInputStream.html#aa0e6304d8ea21a17b3e6a0127e3e7530">get_base_stream</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the base stream for the filter stream. <a href="#aa0e6304d8ea21a17b3e6a0127e3e7530"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a>< const <a class="el" href="classGio_1_1InputStream.html">InputStream</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1FilterInputStream.html#a41af6a4af682c043ac9c91ed13608705">get_base_stream</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the base stream for the filter stream. <a href="#a41af6a4af682c043ac9c91ed13608705"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1FilterInputStream.html#a1a78226f76528f61c87ebe5a31b0f133">get_close_base_stream</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return value: <code>true</code> if the base stream will be closed. <a href="#a1a78226f76528f61c87ebe5a31b0f133"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1FilterInputStream.html#a82e03517a6841b170c7e13fcf2f66920">set_close_base_stream</a> (bool close_base=true)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets whether the base stream will be closed when <em>stream</em> is closed. <a href="#a82e03517a6841b170c7e13fcf2f66920"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classGlib_1_1PropertyProxy__ReadOnly.html">Glib::PropertyProxy_ReadOnly</a><br class="typebreak"/>
< <a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classGio_1_1InputStream.html">InputStream</a> > > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1FilterInputStream.html#aee46182be8452b2b308e62b1fe932233">property_base_stream</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The underlying base stream on which the io ops will be done. <a href="#aee46182be8452b2b308e62b1fe932233"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classGlib_1_1PropertyProxy__ReadOnly.html">Glib::PropertyProxy_ReadOnly</a><br class="typebreak"/>
< bool > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1FilterInputStream.html#a9b5145644bfe5e2472cb219517ad54d0">property_close_base_stream</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">If the base stream should be closed when the filter stream is closed. <a href="#a9b5145644bfe5e2472cb219517ad54d0"></a><br/></td></tr>
<tr><td colspan="2"><h2>Related Functions</h2></td></tr>
<tr><td colspan="2"><p>(Note that these are not member functions.) </p>
<br/><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a><br class="typebreak"/>
< <a class="el" href="classGio_1_1FilterInputStream.html">Gio::FilterInputStream</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1FilterInputStream.html#a5f5a6b8c088b86f8671d9dfaed24ac70">wrap</a> (GFilterInputStream* object, bool take_copy=false)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A <a class="el" href="namespaceGlib.html#a671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object. <a href="#a5f5a6b8c088b86f8671d9dfaed24ac70"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Filter Input Stream. </p>
<dl class="since_2_16"><dt><b><a class="el" href="since_2_16.html#_since_2_16000033">Since glibmm 2.16:</a></b></dt><dd></dd></dl>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a5d3ea75436d7681061f6c320225d7848"></a><!-- doxytag: member="Gio::FilterInputStream::~FilterInputStream" ref="a5d3ea75436d7681061f6c320225d7848" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual Gio::FilterInputStream::~FilterInputStream </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a41af6a4af682c043ac9c91ed13608705"></a><!-- doxytag: member="Gio::FilterInputStream::get_base_stream" ref="a41af6a4af682c043ac9c91ed13608705" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a><const <a class="el" href="classGio_1_1InputStream.html">InputStream</a>> Gio::FilterInputStream::get_base_stream </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets the base stream for the filter stream. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>A <a class="el" href="classGio_1_1InputStream.html" title="Base class for implementing streaming input.">InputStream</a>. </dd></dl>
</div>
</div>
<a class="anchor" id="aa0e6304d8ea21a17b3e6a0127e3e7530"></a><!-- doxytag: member="Gio::FilterInputStream::get_base_stream" ref="aa0e6304d8ea21a17b3e6a0127e3e7530" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGio_1_1InputStream.html">InputStream</a>> Gio::FilterInputStream::get_base_stream </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets the base stream for the filter stream. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>A <a class="el" href="classGio_1_1InputStream.html" title="Base class for implementing streaming input.">InputStream</a>. </dd></dl>
</div>
</div>
<a class="anchor" id="a1a78226f76528f61c87ebe5a31b0f133"></a><!-- doxytag: member="Gio::FilterInputStream::get_close_base_stream" ref="a1a78226f76528f61c87ebe5a31b0f133" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Gio::FilterInputStream::get_close_base_stream </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return value: <code>true</code> if the base stream will be closed. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd><code>true</code> if the base stream will be closed. </dd></dl>
</div>
</div>
<a class="anchor" id="ac8fbd2cc879bfab4854d952b27ce271c"></a><!-- doxytag: member="Gio::FilterInputStream::gobj" ref="ac8fbd2cc879bfab4854d952b27ce271c" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const GFilterInputStream* Gio::FilterInputStream::gobj </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Provides access to the underlying C GObject. </p>
<p>Reimplemented from <a class="el" href="classGio_1_1InputStream.html#a1b0ef82ab81b3ded607584c7029fe1e9">Gio::InputStream</a>.</p>
<p>Reimplemented in <a class="el" href="classGio_1_1BufferedInputStream.html#ad6b09565f69b4c1cf1f0ca05ee53709e">Gio::BufferedInputStream</a>, and <a class="el" href="classGio_1_1DataInputStream.html#a5d8f01998854eac791a3089acef051c0">Gio::DataInputStream</a>.</p>
</div>
</div>
<a class="anchor" id="a6db43589745dcd172f4ca4082bc5d914"></a><!-- doxytag: member="Gio::FilterInputStream::gobj" ref="a6db43589745dcd172f4ca4082bc5d914" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GFilterInputStream* Gio::FilterInputStream::gobj </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Provides access to the underlying C GObject. </p>
<p>Reimplemented from <a class="el" href="classGio_1_1InputStream.html#a2ed1120b3d03a12086e7f0ed3946aba1">Gio::InputStream</a>.</p>
<p>Reimplemented in <a class="el" href="classGio_1_1BufferedInputStream.html#aa9d0c1e643650b9a45831865f06e21be">Gio::BufferedInputStream</a>, and <a class="el" href="classGio_1_1DataInputStream.html#ad788764326462190e900785f50a50740">Gio::DataInputStream</a>.</p>
</div>
</div>
<a class="anchor" id="a55ef3320e423245cc69066c90785328e"></a><!-- doxytag: member="Gio::FilterInputStream::gobj_copy" ref="a55ef3320e423245cc69066c90785328e" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GFilterInputStream* Gio::FilterInputStream::gobj_copy </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. </p>
<p>Reimplemented from <a class="el" href="classGio_1_1InputStream.html#a28a9394b07e9183c0c79798ea344c65c">Gio::InputStream</a>.</p>
<p>Reimplemented in <a class="el" href="classGio_1_1BufferedInputStream.html#a47dc5f78b1faed25cdaaafe42b526d6d">Gio::BufferedInputStream</a>, and <a class="el" href="classGio_1_1DataInputStream.html#a8252806b8ac5548c51a0418162ddb6ab">Gio::DataInputStream</a>.</p>
</div>
</div>
<a class="anchor" id="aee46182be8452b2b308e62b1fe932233"></a><!-- doxytag: member="Gio::FilterInputStream::property_base_stream" ref="aee46182be8452b2b308e62b1fe932233" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classGlib_1_1PropertyProxy__ReadOnly.html">Glib::PropertyProxy_ReadOnly</a>< <a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGio_1_1InputStream.html">InputStream</a>> > Gio::FilterInputStream::property_base_stream </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The underlying base stream on which the io ops will be done. </p>
<p>You rarely need to use properties because there are get_ and set_ methods for almost all of them. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes. </dd></dl>
</div>
</div>
<a class="anchor" id="a9b5145644bfe5e2472cb219517ad54d0"></a><!-- doxytag: member="Gio::FilterInputStream::property_close_base_stream" ref="a9b5145644bfe5e2472cb219517ad54d0" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classGlib_1_1PropertyProxy__ReadOnly.html">Glib::PropertyProxy_ReadOnly</a><bool> Gio::FilterInputStream::property_close_base_stream </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>If the base stream should be closed when the filter stream is closed. </p>
<p>You rarely need to use properties because there are get_ and set_ methods for almost all of them. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes. </dd></dl>
</div>
</div>
<a class="anchor" id="a82e03517a6841b170c7e13fcf2f66920"></a><!-- doxytag: member="Gio::FilterInputStream::set_close_base_stream" ref="a82e03517a6841b170c7e13fcf2f66920" args="(bool close_base=true)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Gio::FilterInputStream::set_close_base_stream </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>close_base</em> = <code>true</code></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets whether the base stream will be closed when <em>stream</em> is closed. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>close_base</em> </td><td><code>true</code> to close the base stream. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Friends And Related Function Documentation</h2>
<a class="anchor" id="a5f5a6b8c088b86f8671d9dfaed24ac70"></a><!-- doxytag: member="Gio::FilterInputStream::wrap" ref="a5f5a6b8c088b86f8671d9dfaed24ac70" args="(GFilterInputStream *object, bool take_copy=false)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classGio_1_1FilterInputStream.html">Gio::FilterInputStream</a> > wrap </td>
<td>(</td>
<td class="paramtype">GFilterInputStream * </td>
<td class="paramname"> <em>object</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>take_copy</em> = <code>false</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [related]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>A <a class="el" href="namespaceGlib.html#a671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>object</em> </td><td>The C instance. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>take_copy</em> </td><td>False if the result should take ownership of the C instance. True if it should take a new copy or ref. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A C++ instance that wraps this C instance. </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>giomm/filterinputstream.h</li>
</ul>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated on Mon Sep 21 11:07:23 2009 for glibmm by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>
</html>
