<!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::IStream 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_1IStream.html','');}); </script> <div id="doc-content"> <div class="header"> <div class="summary"> <a href="#pub-methods">Public Member Functions</a> | <a href="#pub-attribs">Public Attributes</a> | <a href="#pro-methods">Protected Member Functions</a> | <a href="#pri-methods">Private Member Functions</a> | <a href="#pri-attribs">Private Attributes</a> | <a href="classlibrevenge_1_1IStream-members.html">List of all members</a> </div> <div class="headertitle"> <div class="title">librevenge::IStream Class Reference</div> </div> </div><!--header--> <div class="contents"> <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:aa6550a88bb72a0a0a3d22d69fce23ea4"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlibrevenge_1_1IStream.html#aa6550a88bb72a0a0a3d22d69fce23ea4">IStream</a> (<a class="el" href="classlibrevenge_1_1IStorage.html">IStorage</a> *io, std::string const &name)</td></tr> <tr class="separator:aa6550a88bb72a0a0a3d22d69fce23ea4"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a935d2511da4bb929ca7b7798d28f896d"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlibrevenge_1_1IStream.html#a935d2511da4bb929ca7b7798d28f896d">~IStream</a> ()</td></tr> <tr class="separator:a935d2511da4bb929ca7b7798d28f896d"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a9ac31d4b80734979fc1617d7ceb7bb37"><td class="memItemLeft" align="right" valign="top">unsigned long </td><td class="memItemRight" valign="bottom"><a class="el" href="classlibrevenge_1_1IStream.html#a9ac31d4b80734979fc1617d7ceb7bb37">size</a> () const </td></tr> <tr class="separator:a9ac31d4b80734979fc1617d7ceb7bb37"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a55196ccc8c7494cc5342a0ea7b413a02"><td class="memItemLeft" align="right" valign="top">unsigned long </td><td class="memItemRight" valign="bottom"><a class="el" href="classlibrevenge_1_1IStream.html#a55196ccc8c7494cc5342a0ea7b413a02">tell</a> () const </td></tr> <tr class="separator:a55196ccc8c7494cc5342a0ea7b413a02"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:abf36575936edb7c4b3cfb93d91f26967"><td class="memItemLeft" align="right" valign="top">unsigned long </td><td class="memItemRight" valign="bottom"><a class="el" href="classlibrevenge_1_1IStream.html#abf36575936edb7c4b3cfb93d91f26967">read</a> (unsigned char *data, unsigned long maxlen)</td></tr> <tr class="separator:abf36575936edb7c4b3cfb93d91f26967"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a> Public Attributes</h2></td></tr> <tr class="memitem:a7daf2cdb9f9f8f43a07b909811b97bd4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classlibrevenge_1_1IStorage.html">IStorage</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classlibrevenge_1_1IStream.html#a7daf2cdb9f9f8f43a07b909811b97bd4">m_iStorage</a></td></tr> <tr class="separator:a7daf2cdb9f9f8f43a07b909811b97bd4"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a3d1bfdc8b8f18b2a55b5c8dadb6a36a1"><td class="memItemLeft" align="right" valign="top">unsigned long </td><td class="memItemRight" valign="bottom"><a class="el" href="classlibrevenge_1_1IStream.html#a3d1bfdc8b8f18b2a55b5c8dadb6a36a1">m_size</a></td></tr> <tr class="memdesc:a3d1bfdc8b8f18b2a55b5c8dadb6a36a1"><td class="mdescLeft"> </td><td class="mdescRight">the stream size <a href="#a3d1bfdc8b8f18b2a55b5c8dadb6a36a1">More...</a><br/></td></tr> <tr class="separator:a3d1bfdc8b8f18b2a55b5c8dadb6a36a1"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:acab621de243e39a9bfaf80c753d784f5"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classlibrevenge_1_1IStream.html#acab621de243e39a9bfaf80c753d784f5">m_name</a></td></tr> <tr class="separator:acab621de243e39a9bfaf80c753d784f5"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a> Protected Member Functions</h2></td></tr> <tr class="memitem:acef662d19bb46a5746fb54f4f3169aa2"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classlibrevenge_1_1IStream.html#acef662d19bb46a5746fb54f4f3169aa2">createOleFromDirectory</a> (<a class="el" href="classlibrevenge_1_1IStorage.html">IStorage</a> *io, std::string const &name)</td></tr> <tr class="memdesc:acef662d19bb46a5746fb54f4f3169aa2"><td class="mdescLeft"> </td><td class="mdescRight">create the data corresponding to a directory <a href="#acef662d19bb46a5746fb54f4f3169aa2">More...</a><br/></td></tr> <tr class="separator:acef662d19bb46a5746fb54f4f3169aa2"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a9ed42ce77b566233a33c2f71f42adf19"><td class="memItemLeft" align="right" valign="top">unsigned long </td><td class="memItemRight" valign="bottom"><a class="el" href="classlibrevenge_1_1IStream.html#a9ed42ce77b566233a33c2f71f42adf19">readUsingStorage</a> (unsigned long pos, unsigned char *data, unsigned long maxlen)</td></tr> <tr class="memdesc:a9ed42ce77b566233a33c2f71f42adf19"><td class="mdescLeft"> </td><td class="mdescRight">try to read maxlen data using m_iStorage <a href="#a9ed42ce77b566233a33c2f71f42adf19">More...</a><br/></td></tr> <tr class="separator:a9ed42ce77b566233a33c2f71f42adf19"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aace06c080550a270de76fd5ffae46dd6"><td class="memItemLeft" align="right" valign="top">unsigned long </td><td class="memItemRight" valign="bottom"><a class="el" href="classlibrevenge_1_1IStream.html#aace06c080550a270de76fd5ffae46dd6">readData</a> (unsigned long pos, unsigned char *data, unsigned long maxlen)</td></tr> <tr class="memdesc:aace06c080550a270de76fd5ffae46dd6"><td class="mdescLeft"> </td><td class="mdescRight">try to read maxlen data using m_data <a href="#aace06c080550a270de76fd5ffae46dd6">More...</a><br/></td></tr> <tr class="separator:aace06c080550a270de76fd5ffae46dd6"><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:a816edab1567cec0c5aa98fd0f138cd6a"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlibrevenge_1_1IStream.html#a816edab1567cec0c5aa98fd0f138cd6a">IStream</a> (const <a class="el" href="classlibrevenge_1_1IStream.html">IStream</a> &)</td></tr> <tr class="separator:a816edab1567cec0c5aa98fd0f138cd6a"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a35295a5533b9a2485ad3338d86425e69"><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_1IStream.html#a35295a5533b9a2485ad3338d86425e69">operator=</a> (const <a class="el" href="classlibrevenge_1_1IStream.html">IStream</a> &)</td></tr> <tr class="separator:a35295a5533b9a2485ad3338d86425e69"><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:a2406665a8dd4461fd2606a20426ebc64"><td class="memItemLeft" align="right" valign="top">std::vector< unsigned long > </td><td class="memItemRight" valign="bottom"><a class="el" href="classlibrevenge_1_1IStream.html#a2406665a8dd4461fd2606a20426ebc64">m_blocks</a></td></tr> <tr class="separator:a2406665a8dd4461fd2606a20426ebc64"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ad9eabf4e8bc869fc07d4a490d0f64560"><td class="memItemLeft" align="right" valign="top">unsigned long </td><td class="memItemRight" valign="bottom"><a class="el" href="classlibrevenge_1_1IStream.html#ad9eabf4e8bc869fc07d4a490d0f64560">m_pos</a></td></tr> <tr class="separator:ad9eabf4e8bc869fc07d4a490d0f64560"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a70f32832a04e29038a777b85604c5cee"><td class="memItemLeft" align="right" valign="top">std::vector< unsigned char > </td><td class="memItemRight" valign="bottom"><a class="el" href="classlibrevenge_1_1IStream.html#a70f32832a04e29038a777b85604c5cee">m_data</a></td></tr> <tr class="separator:a70f32832a04e29038a777b85604c5cee"><td class="memSeparator" colspan="2"> </td></tr> </table> <h2 class="groupheader">Constructor & Destructor Documentation</h2> <a class="anchor" id="aa6550a88bb72a0a0a3d22d69fce23ea4"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">librevenge::IStream::IStream </td> <td>(</td> <td class="paramtype"><a class="el" href="classlibrevenge_1_1IStorage.html">librevenge::IStorage</a> * </td> <td class="paramname"><em>s</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">std::string const & </td> <td class="paramname"><em>name</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> </div> </div> <a class="anchor" id="a935d2511da4bb929ca7b7798d28f896d"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">librevenge::IStream::~IStream </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> </div> </div> <a class="anchor" id="a816edab1567cec0c5aa98fd0f138cd6a"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">librevenge::IStream::IStream </td> <td>(</td> <td class="paramtype">const <a class="el" href="classlibrevenge_1_1IStream.html">IStream</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="acef662d19bb46a5746fb54f4f3169aa2"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">bool librevenge::IStream::createOleFromDirectory </td> <td>(</td> <td class="paramtype"><a class="el" href="classlibrevenge_1_1IStorage.html">IStorage</a> * </td> <td class="paramname"><em>io</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">std::string const & </td> <td class="paramname"><em>name</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">protected</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>create the data corresponding to a directory </p> <p>Referenced by <a class="el" href="classlibrevenge_1_1IStream.html#aa6550a88bb72a0a0a3d22d69fce23ea4">IStream()</a>.</p> </div> </div> <a class="anchor" id="a35295a5533b9a2485ad3338d86425e69"></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::IStream::operator= </td> <td>(</td> <td class="paramtype">const <a class="el" href="classlibrevenge_1_1IStream.html">IStream</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="abf36575936edb7c4b3cfb93d91f26967"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">unsigned long librevenge::IStream::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> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Referenced by <a class="el" href="classlibrevenge_1_1IStream.html#acef662d19bb46a5746fb54f4f3169aa2">createOleFromDirectory()</a>.</p> </div> </div> <a class="anchor" id="aace06c080550a270de76fd5ffae46dd6"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">unsigned long librevenge::IStream::readData </td> <td>(</td> <td class="paramtype">unsigned long </td> <td class="paramname"><em>pos</em>, </td> </tr> <tr> <td class="paramkey"></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> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">protected</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>try to read maxlen data using m_data </p> <p>Referenced by <a class="el" href="classlibrevenge_1_1IStream.html#abf36575936edb7c4b3cfb93d91f26967">read()</a>.</p> </div> </div> <a class="anchor" id="a9ed42ce77b566233a33c2f71f42adf19"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">unsigned long librevenge::IStream::readUsingStorage </td> <td>(</td> <td class="paramtype">unsigned long </td> <td class="paramname"><em>pos</em>, </td> </tr> <tr> <td class="paramkey"></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> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">protected</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>try to read maxlen data using m_iStorage </p> <p>Referenced by <a class="el" href="classlibrevenge_1_1IStream.html#abf36575936edb7c4b3cfb93d91f26967">read()</a>.</p> </div> </div> <a class="anchor" id="a9ac31d4b80734979fc1617d7ceb7bb37"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">unsigned long librevenge::IStream::size </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Referenced by <a class="el" href="classlibrevenge_1_1IStream.html#acef662d19bb46a5746fb54f4f3169aa2">createOleFromDirectory()</a>.</p> </div> </div> <a class="anchor" id="a55196ccc8c7494cc5342a0ea7b413a02"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">unsigned long librevenge::IStream::tell </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Referenced by <a class="el" href="classlibrevenge_1_1IStream.html#abf36575936edb7c4b3cfb93d91f26967">read()</a>.</p> </div> </div> <h2 class="groupheader">Member Data Documentation</h2> <a class="anchor" id="a2406665a8dd4461fd2606a20426ebc64"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">std::vector<unsigned long> librevenge::IStream::m_blocks</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_1IStream.html#aa6550a88bb72a0a0a3d22d69fce23ea4">IStream()</a>.</p> </div> </div> <a class="anchor" id="a70f32832a04e29038a777b85604c5cee"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">std::vector<unsigned char> librevenge::IStream::m_data</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_1IStream.html#abf36575936edb7c4b3cfb93d91f26967">read()</a>.</p> </div> </div> <a class="anchor" id="a7daf2cdb9f9f8f43a07b909811b97bd4"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classlibrevenge_1_1IStorage.html">IStorage</a>* librevenge::IStream::m_iStorage</td> </tr> </table> </div><div class="memdoc"> <p>Referenced by <a class="el" href="classlibrevenge_1_1IStream.html#aa6550a88bb72a0a0a3d22d69fce23ea4">IStream()</a>.</p> </div> </div> <a class="anchor" id="acab621de243e39a9bfaf80c753d784f5"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">std::string librevenge::IStream::m_name</td> </tr> </table> </div><div class="memdoc"> </div> </div> <a class="anchor" id="ad9eabf4e8bc869fc07d4a490d0f64560"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">unsigned long librevenge::IStream::m_pos</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_1IStream.html#abf36575936edb7c4b3cfb93d91f26967">read()</a>, and <a class="el" href="classlibrevenge_1_1IStream.html#a55196ccc8c7494cc5342a0ea7b413a02">tell()</a>.</p> </div> </div> <a class="anchor" id="a3d1bfdc8b8f18b2a55b5c8dadb6a36a1"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">unsigned long librevenge::IStream::m_size</td> </tr> </table> </div><div class="memdoc"> <p>the stream size </p> <p>Referenced by <a class="el" href="classlibrevenge_1_1IStream.html#aa6550a88bb72a0a0a3d22d69fce23ea4">IStream()</a>, <a class="el" href="classlibrevenge_1_1IStream.html#abf36575936edb7c4b3cfb93d91f26967">read()</a>, and <a class="el" href="classlibrevenge_1_1IStream.html#a9ac31d4b80734979fc1617d7ceb7bb37">size()</a>.</p> </div> </div> <hr/>The documentation for this class was generated from the following file:<ul> <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>