<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>librevenge::Stream Class Reference documentation</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.8.5 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</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="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</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><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('classlibrevenge_1_1Stream.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pri-methods">Private Member Functions</a> |
<a href="#pri-attribs">Private Attributes</a> |
<a href="#friends">Friends</a> |
<a href="classlibrevenge_1_1Stream-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">librevenge::Stream Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include <<a class="el" href="RVNGOLEStream_8h_source.html">RVNGOLEStream.h</a>></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:abfc28c3b87781562ee7fc378a6d25e36"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlibrevenge_1_1Stream.html#abfc28c3b87781562ee7fc378a6d25e36">Stream</a> (<a class="el" href="classlibrevenge_1_1Storage.html">Storage</a> *storage, const std::string &name)</td></tr>
<tr class="memdesc:abfc28c3b87781562ee7fc378a6d25e36"><td class="mdescLeft"> </td><td class="mdescRight">Creates a new stream. <a href="#abfc28c3b87781562ee7fc378a6d25e36">More...</a><br/></td></tr>
<tr class="separator:abfc28c3b87781562ee7fc378a6d25e36"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad15f155f954f7c6d73d634e58d3a06ad"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlibrevenge_1_1Stream.html#ad15f155f954f7c6d73d634e58d3a06ad">~Stream</a> ()</td></tr>
<tr class="memdesc:ad15f155f954f7c6d73d634e58d3a06ad"><td class="mdescLeft"> </td><td class="mdescRight">Destroys the stream. <a href="#ad15f155f954f7c6d73d634e58d3a06ad">More...</a><br/></td></tr>
<tr class="separator:ad15f155f954f7c6d73d634e58d3a06ad"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad9030d883183e08230381be5e5459503"><td class="memItemLeft" align="right" valign="top">unsigned long </td><td class="memItemRight" valign="bottom"><a class="el" href="classlibrevenge_1_1Stream.html#ad9030d883183e08230381be5e5459503">size</a> ()</td></tr>
<tr class="memdesc:ad9030d883183e08230381be5e5459503"><td class="mdescLeft"> </td><td class="mdescRight">Returns the stream size. <a href="#ad9030d883183e08230381be5e5459503">More...</a><br/></td></tr>
<tr class="separator:ad9030d883183e08230381be5e5459503"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a59950ce986c687b84fb6043e3a492484"><td class="memItemLeft" align="right" valign="top">unsigned long </td><td class="memItemRight" valign="bottom"><a class="el" href="classlibrevenge_1_1Stream.html#a59950ce986c687b84fb6043e3a492484">read</a> (unsigned char *data, unsigned long maxlen)</td></tr>
<tr class="memdesc:a59950ce986c687b84fb6043e3a492484"><td class="mdescLeft"> </td><td class="mdescRight">Reads a block of data. <a href="#a59950ce986c687b84fb6043e3a492484">More...</a><br/></td></tr>
<tr class="separator:a59950ce986c687b84fb6043e3a492484"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-methods"></a>
Private Member Functions</h2></td></tr>
<tr class="memitem:a0c25d4c123e9b5689612b144920ce8bb"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlibrevenge_1_1Stream.html#a0c25d4c123e9b5689612b144920ce8bb">Stream</a> (const <a class="el" href="classlibrevenge_1_1Stream.html">Stream</a> &)</td></tr>
<tr class="separator:a0c25d4c123e9b5689612b144920ce8bb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:affae4d8e817157c6bc9088485796e3d7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classlibrevenge_1_1Stream.html">Stream</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classlibrevenge_1_1Stream.html#affae4d8e817157c6bc9088485796e3d7">operator=</a> (const <a class="el" href="classlibrevenge_1_1Stream.html">Stream</a> &)</td></tr>
<tr class="separator:affae4d8e817157c6bc9088485796e3d7"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:a4ecb6bef4dd0661ab44f850f5a73f335"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classlibrevenge_1_1IStream.html">IStream</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classlibrevenge_1_1Stream.html#a4ecb6bef4dd0661ab44f850f5a73f335">m_io</a></td></tr>
<tr class="separator:a4ecb6bef4dd0661ab44f850f5a73f335"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:ab647623b3295040f83d3afb2a502a223"><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classlibrevenge_1_1Stream.html#ab647623b3295040f83d3afb2a502a223">Storage</a></td></tr>
<tr class="separator:ab647623b3295040f83d3afb2a502a223"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aea72caa8122aacd6856650f060b69211"><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classlibrevenge_1_1Stream.html#aea72caa8122aacd6856650f060b69211">IStorage</a></td></tr>
<tr class="separator:aea72caa8122aacd6856650f060b69211"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="abfc28c3b87781562ee7fc378a6d25e36"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">librevenge::Stream::Stream </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classlibrevenge_1_1Storage.html">librevenge::Storage</a> * </td>
<td class="paramname"><em>storage</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>name</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a new stream. </p>
</div>
</div>
<a class="anchor" id="ad15f155f954f7c6d73d634e58d3a06ad"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">librevenge::Stream::~Stream </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Destroys the stream. </p>
</div>
</div>
<a class="anchor" id="a0c25d4c123e9b5689612b144920ce8bb"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">librevenge::Stream::Stream </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classlibrevenge_1_1Stream.html">Stream</a> & </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="affae4d8e817157c6bc9088485796e3d7"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classlibrevenge_1_1Stream.html">Stream</a>& librevenge::Stream::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classlibrevenge_1_1Stream.html">Stream</a> & </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a59950ce986c687b84fb6043e3a492484"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned long librevenge::Stream::read </td>
<td>(</td>
<td class="paramtype">unsigned char * </td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned long </td>
<td class="paramname"><em>maxlen</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Reads a block of data. </p>
<p>Referenced by <a class="el" href="classlibrevenge_1_1RVNGFileStream.html#a5006210d339166a351591e2943be84d1">librevenge::RVNGFileStream::getSubStreamByName()</a>, and <a class="el" href="classlibrevenge_1_1RVNGStringStream.html#a58bda7ec695c021ec264120073adf848">librevenge::RVNGStringStream::getSubStreamByName()</a>.</p>
</div>
</div>
<a class="anchor" id="ad9030d883183e08230381be5e5459503"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned long librevenge::Stream::size </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the stream size. </p>
<p>Referenced by <a class="el" href="classlibrevenge_1_1RVNGFileStream.html#a5006210d339166a351591e2943be84d1">librevenge::RVNGFileStream::getSubStreamByName()</a>, and <a class="el" href="classlibrevenge_1_1RVNGStringStream.html#a58bda7ec695c021ec264120073adf848">librevenge::RVNGStringStream::getSubStreamByName()</a>.</p>
</div>
</div>
<h2 class="groupheader">Friends And Related Function Documentation</h2>
<a class="anchor" id="aea72caa8122aacd6856650f060b69211"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">friend class <a class="el" href="classlibrevenge_1_1IStorage.html">IStorage</a></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">friend</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="ab647623b3295040f83d3afb2a502a223"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">friend class <a class="el" href="classlibrevenge_1_1Storage.html">Storage</a></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">friend</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="a4ecb6bef4dd0661ab44f850f5a73f335"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classlibrevenge_1_1IStream.html">IStream</a>* librevenge::Stream::m_io</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Referenced by <a class="el" href="classlibrevenge_1_1Stream.html#abfc28c3b87781562ee7fc378a6d25e36">Stream()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="RVNGOLEStream_8h_source.html">RVNGOLEStream.h</a></li>
<li><a class="el" href="RVNGOLEStream_8cpp.html">RVNGOLEStream.cpp</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<hr size="1"><address style="align: right;"><small>
Generated for librevenge by <a href="http://www.doxygen.org/index.html">
doxygen</a> 1.8.5</small></address>
</body>
</html>
