<!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>libwps: libwps::Stream Class Reference documentation</title> <link href="doxygen.css" rel="stylesheet" type="text/css"> </head><body> <!-- Generated by Doxygen 1.5.6 --> <div class="navigation" id="top"> <div class="tabs"> <ul> <li><a href="main.html"><span>Main Page</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li class="current"><a href="classes.html"><span>Classes</span></a></li> <li><a href="files.html"><span>Files</span></a></li> </ul> </div> <div class="tabs"> <ul> <li><a href="classes.html"><span>Alphabetical List</span></a></li> <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="namespacelibwps.html">libwps</a>::<a class="el" href="classlibwps_1_1Stream.html">Stream</a> </div> </div> <div class="contents"> <h1>libwps::Stream Class Reference</h1><!-- doxytag: class="libwps::Stream" --><code>#include <<a class="el" href="WPSOLEStream_8h-source.html">WPSOLEStream.h</a>></code> <p> <p> <a href="classlibwps_1_1Stream-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0"> <tr><td></td></tr> <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlibwps_1_1Stream.html#4e5eb3ec973b64b371834f5bcdc156ec">Stream</a> (<a class="el" href="classlibwps_1_1Storage.html">Storage</a> *storage, const std::string &name)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Creates a new stream. <a href="#4e5eb3ec973b64b371834f5bcdc156ec"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlibwps_1_1Stream.html#c00f8b27d25a65942d226a2750c3e625">~Stream</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Destroys the stream. <a href="#c00f8b27d25a65942d226a2750c3e625"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned long </td><td class="memItemRight" valign="bottom"><a class="el" href="classlibwps_1_1Stream.html#c89a69ab3d08c9509d95a3a5baf8d57e">size</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the stream size. <a href="#c89a69ab3d08c9509d95a3a5baf8d57e"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned long </td><td class="memItemRight" valign="bottom"><a class="el" href="classlibwps_1_1Stream.html#bbbfd84a38f4eee0c466ead1bdccb9c9">read</a> (unsigned char *data, unsigned long maxlen)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Reads a block of data. <a href="#bbbfd84a38f4eee0c466ead1bdccb9c9"></a><br></td></tr> <tr><td colspan="2"><br><h2>Private Member Functions</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlibwps_1_1Stream.html#0e7ec048767c49d2f7cd137dab095f40">Stream</a> (const <a class="el" href="classlibwps_1_1Stream.html">Stream</a> &)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classlibwps_1_1Stream.html">Stream</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classlibwps_1_1Stream.html#6e8560394b24be3d3a73cc2638a020c0">operator=</a> (const <a class="el" href="classlibwps_1_1Stream.html">Stream</a> &)</td></tr> <tr><td colspan="2"><br><h2>Private Attributes</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classlibwps_1_1StreamIO.html">StreamIO</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classlibwps_1_1Stream.html#b24d4a5939cc605f32cc9c98fa6f48cd">io</a></td></tr> <tr><td colspan="2"><br><h2>Friends</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classlibwps_1_1Stream.html#b647623b3295040f83d3afb2a502a223">Storage</a></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classlibwps_1_1Stream.html#5071009534d971068634b17ca17c2c5c">StorageIO</a></td></tr> </table> <hr><h2>Constructor & Destructor Documentation</h2> <a class="anchor" name="4e5eb3ec973b64b371834f5bcdc156ec"></a><!-- doxytag: member="libwps::Stream::Stream" ref="4e5eb3ec973b64b371834f5bcdc156ec" args="(Storage *storage, const std::string &name)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">libwps::Stream::Stream </td> <td>(</td> <td class="paramtype"><a class="el" href="classlibwps_1_1Storage.html">libwps::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><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td></td> </tr> </table> </div> <div class="memdoc"> <p> Creates a new stream. <p> </div> </div><p> <a class="anchor" name="c00f8b27d25a65942d226a2750c3e625"></a><!-- doxytag: member="libwps::Stream::~Stream" ref="c00f8b27d25a65942d226a2750c3e625" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">libwps::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><p> <a class="anchor" name="0e7ec048767c49d2f7cd137dab095f40"></a><!-- doxytag: member="libwps::Stream::Stream" ref="0e7ec048767c49d2f7cd137dab095f40" args="(const Stream &)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">libwps::Stream::Stream </td> <td>(</td> <td class="paramtype">const <a class="el" href="classlibwps_1_1Stream.html">Stream</a> & </td> <td class="paramname"> </td> <td> ) </td> <td><code> [private]</code></td> </tr> </table> </div> <div class="memdoc"> <p> </div> </div><p> <hr><h2>Member Function Documentation</h2> <a class="anchor" name="c89a69ab3d08c9509d95a3a5baf8d57e"></a><!-- doxytag: member="libwps::Stream::size" ref="c89a69ab3d08c9509d95a3a5baf8d57e" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">unsigned long libwps::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="WPSStreamImplementation_8cpp-source.html#l00383">WPSMemoryStream::getDocumentOLEStream()</a>, and <a class="el" href="WPSStreamImplementation_8cpp-source.html#l00240">WPSFileStream::getDocumentOLEStream()</a>.</p> </div> </div><p> <a class="anchor" name="bbbfd84a38f4eee0c466ead1bdccb9c9"></a><!-- doxytag: member="libwps::Stream::read" ref="bbbfd84a38f4eee0c466ead1bdccb9c9" args="(unsigned char *data, unsigned long maxlen)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">unsigned long libwps::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><td> </td> </tr> <tr> <td></td> <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="WPSStreamImplementation_8cpp-source.html#l00383">WPSMemoryStream::getDocumentOLEStream()</a>, and <a class="el" href="WPSStreamImplementation_8cpp-source.html#l00240">WPSFileStream::getDocumentOLEStream()</a>.</p> </div> </div><p> <a class="anchor" name="6e8560394b24be3d3a73cc2638a020c0"></a><!-- doxytag: member="libwps::Stream::operator=" ref="6e8560394b24be3d3a73cc2638a020c0" args="(const Stream &)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classlibwps_1_1Stream.html">Stream</a>& libwps::Stream::operator= </td> <td>(</td> <td class="paramtype">const <a class="el" href="classlibwps_1_1Stream.html">Stream</a> & </td> <td class="paramname"> </td> <td> ) </td> <td><code> [private]</code></td> </tr> </table> </div> <div class="memdoc"> <p> </div> </div><p> <hr><h2>Friends And Related Function Documentation</h2> <a class="anchor" name="b647623b3295040f83d3afb2a502a223"></a><!-- doxytag: member="libwps::Stream::Storage" ref="b647623b3295040f83d3afb2a502a223" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">friend class <a class="el" href="classlibwps_1_1Storage.html">Storage</a><code> [friend]</code> </td> </tr> </table> </div> <div class="memdoc"> <p> </div> </div><p> <a class="anchor" name="5071009534d971068634b17ca17c2c5c"></a><!-- doxytag: member="libwps::Stream::StorageIO" ref="5071009534d971068634b17ca17c2c5c" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">friend class <a class="el" href="classlibwps_1_1StorageIO.html">StorageIO</a><code> [friend]</code> </td> </tr> </table> </div> <div class="memdoc"> <p> </div> </div><p> <hr><h2>Member Data Documentation</h2> <a class="anchor" name="b24d4a5939cc605f32cc9c98fa6f48cd"></a><!-- doxytag: member="libwps::Stream::io" ref="b24d4a5939cc605f32cc9c98fa6f48cd" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classlibwps_1_1StreamIO.html">StreamIO</a>* <a class="el" href="classlibwps_1_1Stream.html#b24d4a5939cc605f32cc9c98fa6f48cd">libwps::Stream::io</a><code> [private]</code> </td> </tr> </table> </div> <div class="memdoc"> <p> <p>Referenced by <a class="el" href="WPSOLEStream_8cpp-source.html#l01014">read()</a>, <a class="el" href="WPSOLEStream_8cpp-source.html#l01009">size()</a>, and <a class="el" href="WPSOLEStream_8cpp-source.html#l01004">~Stream()</a>.</p> </div> </div><p> <hr>The documentation for this class was generated from the following files:<ul> <li><a class="el" href="WPSOLEStream_8h-source.html">WPSOLEStream.h</a><li><a class="el" href="WPSOLEStream_8cpp.html">WPSOLEStream.cpp</a></ul> </div> <hr size="1"><address style="align: right;"><small> Generated on Sat Jun 28 12:35:51 2008 for libwps by <a href="http://www.doxygen.org/index.html"> doxygen</a> 1.5.6</small></address> </body> </html>