<!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: WPSFileStream 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> <div class="contents"> <h1>WPSFileStream Class Reference</h1><!-- doxytag: class="WPSFileStream" --><!-- doxytag: inherits="WPSInputStream" --><code>#include <<a class="el" href="WPSStreamImplementation_8h-source.html">WPSStreamImplementation.h</a>></code> <p> <div class="dynheader"> Inheritance diagram for WPSFileStream:</div> <div class="dynsection"> <p><center><img src="classWPSFileStream.png" usemap="#WPSFileStream_map" border="0" alt=""></center> <map name="WPSFileStream_map"> <area href="classWPSInputStream.html" alt="WPSInputStream" shape="rect" coords="0,0,105,24"> </map> </div> <p> <a href="classWPSFileStream-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="classWPSFileStream.html#d48f7cf876fb2b52f47d2824d102f639">WPSFileStream</a> (const char *filename)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWPSFileStream.html#6132605d07c5d408395da5d79f9c947e">~WPSFileStream</a> ()</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">const uint8_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="classWPSFileStream.html#fa9d7c311bf1f8c6ccf2396476e8d8e6">read</a> (size_t numBytes, size_t &numBytesRead)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="classWPSFileStream.html#290c4d22008bebe7fa17a1c4ce88019c">tell</a> ()</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classWPSFileStream.html#e8ba82a70d4d1464618ab05da70b8a13">seek</a> (long offset, WPX_SEEK_TYPE seekType)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classWPSFileStream.html#ac3c053c7f0fb792de9de242dec4bddd">atEOS</a> ()</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classWPSFileStream.html#e57ab8acc8af310ac36a82c6a787f1ba">isOLEStream</a> ()</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">WPXInputStream * </td><td class="memItemRight" valign="bottom"><a class="el" href="classWPSFileStream.html#813d6ba6c20b47c38589893c4b111675">getDocumentOLEStream</a> (const char *name)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">WPXInputStream * </td><td class="memItemRight" valign="bottom"><a class="el" href="classWPSFileStream.html#c50b53577463d8dde7ead28f4a475f51">getDocumentOLEStream</a> ()</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="classWPSFileStream.html#9dd9138cb65ce33549171a7b6c460a2c">WPSFileStream</a> (const <a class="el" href="classWPSFileStream.html">WPSFileStream</a> &)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classWPSFileStream.html">WPSFileStream</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWPSFileStream.html#2040851db00a5f672b835d78bf432ab7">operator=</a> (const <a class="el" href="classWPSFileStream.html">WPSFileStream</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="classWPSFileStreamPrivate.html">WPSFileStreamPrivate</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classWPSFileStream.html#b0c7e3325d6c6e8afe5b55898a2254aa">d</a></td></tr> </table> <hr><h2>Constructor & Destructor Documentation</h2> <a class="anchor" name="d48f7cf876fb2b52f47d2824d102f639"></a><!-- doxytag: member="WPSFileStream::WPSFileStream" ref="d48f7cf876fb2b52f47d2824d102f639" args="(const char *filename)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">WPSFileStream::WPSFileStream </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"> <em>filename</em> </td> <td> ) </td> <td><code> [explicit]</code></td> </tr> </table> </div> <div class="memdoc"> <p> </div> </div><p> <a class="anchor" name="6132605d07c5d408395da5d79f9c947e"></a><!-- doxytag: member="WPSFileStream::~WPSFileStream" ref="6132605d07c5d408395da5d79f9c947e" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">WPSFileStream::~WPSFileStream </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p> </div> </div><p> <a class="anchor" name="9dd9138cb65ce33549171a7b6c460a2c"></a><!-- doxytag: member="WPSFileStream::WPSFileStream" ref="9dd9138cb65ce33549171a7b6c460a2c" args="(const WPSFileStream &)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">WPSFileStream::WPSFileStream </td> <td>(</td> <td class="paramtype">const <a class="el" href="classWPSFileStream.html">WPSFileStream</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="fa9d7c311bf1f8c6ccf2396476e8d8e6"></a><!-- doxytag: member="WPSFileStream::read" ref="fa9d7c311bf1f8c6ccf2396476e8d8e6" args="(size_t numBytes, size_t &numBytesRead)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const uint8_t * WPSFileStream::read </td> <td>(</td> <td class="paramtype">size_t </td> <td class="paramname"> <em>numBytes</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">size_t & </td> <td class="paramname"> <em>numBytesRead</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> <p>Implements <a class="el" href="classWPSInputStream.html#f468833d8239f86ede21712d87783be6">WPSInputStream</a>.</p> </div> </div><p> <a class="anchor" name="290c4d22008bebe7fa17a1c4ce88019c"></a><!-- doxytag: member="WPSFileStream::tell" ref="290c4d22008bebe7fa17a1c4ce88019c" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">long WPSFileStream::tell </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> <p>Implements <a class="el" href="classWPSInputStream.html#08acdf4afa45f0a382dd63d7c4c98518">WPSInputStream</a>.</p> <p>Referenced by <a class="el" href="WPSStreamImplementation_8cpp-source.html#l00216">atEOS()</a>, <a class="el" href="WPSStreamImplementation_8cpp-source.html#l00113">read()</a>, and <a class="el" href="WPSStreamImplementation_8cpp-source.html#l00183">seek()</a>.</p> </div> </div><p> <a class="anchor" name="e8ba82a70d4d1464618ab05da70b8a13"></a><!-- doxytag: member="WPSFileStream::seek" ref="e8ba82a70d4d1464618ab05da70b8a13" args="(long offset, WPX_SEEK_TYPE seekType)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int WPSFileStream::seek </td> <td>(</td> <td class="paramtype">long </td> <td class="paramname"> <em>offset</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">WPX_SEEK_TYPE </td> <td class="paramname"> <em>seekType</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> <p>Implements <a class="el" href="classWPSInputStream.html#32d6ad2d1d872a3644be97d4cf45ff22">WPSInputStream</a>.</p> <p>Referenced by <a class="el" href="WPSStreamImplementation_8cpp-source.html#l00221">isOLEStream()</a>.</p> </div> </div><p> <a class="anchor" name="ac3c053c7f0fb792de9de242dec4bddd"></a><!-- doxytag: member="WPSFileStream::atEOS" ref="ac3c053c7f0fb792de9de242dec4bddd" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool WPSFileStream::atEOS </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> <p>Implements <a class="el" href="classWPSInputStream.html#9ae9ad16e823365798f3a13b109fb7ee">WPSInputStream</a>.</p> </div> </div><p> <a class="anchor" name="e57ab8acc8af310ac36a82c6a787f1ba"></a><!-- doxytag: member="WPSFileStream::isOLEStream" ref="e57ab8acc8af310ac36a82c6a787f1ba" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool WPSFileStream::isOLEStream </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> <p>Implements <a class="el" href="classWPSInputStream.html#68c2284f323f7c62aada06646aa6812b">WPSInputStream</a>.</p> </div> </div><p> <a class="anchor" name="813d6ba6c20b47c38589893c4b111675"></a><!-- doxytag: member="WPSFileStream::getDocumentOLEStream" ref="813d6ba6c20b47c38589893c4b111675" args="(const char *name)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">WPXInputStream * WPSFileStream::getDocumentOLEStream </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"> <em>name</em> </td> <td> ) </td> <td><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> <p>Implements <a class="el" href="classWPSInputStream.html#846d2bb2e9f08bf5f2f8ae27bdb5759a">WPSInputStream</a>.</p> </div> </div><p> <a class="anchor" name="c50b53577463d8dde7ead28f4a475f51"></a><!-- doxytag: member="WPSFileStream::getDocumentOLEStream" ref="c50b53577463d8dde7ead28f4a475f51" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">WPXInputStream * WPSFileStream::getDocumentOLEStream </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> <p>Implements <a class="el" href="classWPSInputStream.html#b02b5edcbacf373c8afe61ea4c2358f1">WPSInputStream</a>.</p> </div> </div><p> <a class="anchor" name="2040851db00a5f672b835d78bf432ab7"></a><!-- doxytag: member="WPSFileStream::operator=" ref="2040851db00a5f672b835d78bf432ab7" args="(const WPSFileStream &)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classWPSFileStream.html">WPSFileStream</a>& WPSFileStream::operator= </td> <td>(</td> <td class="paramtype">const <a class="el" href="classWPSFileStream.html">WPSFileStream</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 Data Documentation</h2> <a class="anchor" name="b0c7e3325d6c6e8afe5b55898a2254aa"></a><!-- doxytag: member="WPSFileStream::d" ref="b0c7e3325d6c6e8afe5b55898a2254aa" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classWPSFileStreamPrivate.html">WPSFileStreamPrivate</a>* <a class="el" href="classWPSFileStream.html#b0c7e3325d6c6e8afe5b55898a2254aa">WPSFileStream::d</a><code> [private]</code> </td> </tr> </table> </div> <div class="memdoc"> <p> <p>Referenced by <a class="el" href="WPSStreamImplementation_8cpp-source.html#l00216">atEOS()</a>, <a class="el" href="WPSStreamImplementation_8cpp-source.html#l00240">getDocumentOLEStream()</a>, <a class="el" href="WPSStreamImplementation_8cpp-source.html#l00221">isOLEStream()</a>, <a class="el" href="WPSStreamImplementation_8cpp-source.html#l00113">read()</a>, <a class="el" href="WPSStreamImplementation_8cpp-source.html#l00183">seek()</a>, <a class="el" href="WPSStreamImplementation_8cpp-source.html#l00178">tell()</a>, <a class="el" href="WPSStreamImplementation_8cpp-source.html#l00092">WPSFileStream()</a>, and <a class="el" href="WPSStreamImplementation_8cpp-source.html#l00106">~WPSFileStream()</a>.</p> </div> </div><p> <hr>The documentation for this class was generated from the following files:<ul> <li><a class="el" href="WPSStreamImplementation_8h-source.html">WPSStreamImplementation.h</a><li><a class="el" href="WPSStreamImplementation_8cpp.html">WPSStreamImplementation.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>