<!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: WPSDocument Class Reference documentation</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.4 -->
<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>
<h1>WPSDocument Class Reference</h1><!-- doxytag: class="WPSDocument" --><code>#include <<a class="el" href="WPSDocument_8h-source.html">WPSDocument.h</a>></code>
<p>
<p>
<a href="classWPSDocument-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
This class provides all the functions an application would need to parse Works documents. <table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="WPSDocument_8h.html#cda7c59188729c6946337bc699cbd004">WPSConfidence</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWPSDocument.html#2dc605447bd34d2c12f5d3aa29627639">isFileFormatSupported</a> (<a class="el" href="classWPSInputStream.html">WPSInputStream</a> *input, bool partialContent)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Analyzes the content of an input stream to see if it can be parsed. <a href="#2dc605447bd34d2c12f5d3aa29627639"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="WPSDocument_8h.html#f7225176f4a213df407623fcc9ddfe31">WPSResult</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWPSDocument.html#ccf2750a4d54533cc258608a55263a5e">parse</a> (<a class="el" href="classWPSInputStream.html">WPSInputStream</a> *input, WPXHLListenerImpl *listenerImpl)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Parses the input stream content. <a href="#ccf2750a4d54533cc258608a55263a5e"></a><br></td></tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="2dc605447bd34d2c12f5d3aa29627639"></a><!-- doxytag: member="WPSDocument::isFileFormatSupported" ref="2dc605447bd34d2c12f5d3aa29627639" args="(WPSInputStream *input, bool partialContent)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="WPSDocument_8h.html#cda7c59188729c6946337bc699cbd004">WPSConfidence</a> WPSDocument::isFileFormatSupported </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classWPSInputStream.html">WPSInputStream</a> * </td>
<td class="paramname"> <em>input</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>partialContent</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Analyzes the content of an input stream to see if it can be parsed.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>input</em> </td><td>The input stream </td></tr>
<tr><td valign="top"></td><td valign="top"><em>partialContent</em> </td><td>A boolean which states if the content from the input stream represents the full contents of a MS Works file, or just the first X bytes </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A confidence value which represents the likelyhood that the content from the input stream can be parsed </dd></dl>
</div>
</div><p>
<a class="anchor" name="ccf2750a4d54533cc258608a55263a5e"></a><!-- doxytag: member="WPSDocument::parse" ref="ccf2750a4d54533cc258608a55263a5e" args="(WPSInputStream *input, WPXHLListenerImpl *listenerImpl)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="WPSDocument_8h.html#f7225176f4a213df407623fcc9ddfe31">WPSResult</a> WPSDocument::parse </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classWPSInputStream.html">WPSInputStream</a> * </td>
<td class="paramname"> <em>input</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">WPXHLListenerImpl * </td>
<td class="paramname"> <em>listenerImpl</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Parses the input stream content.
<p>
It will make callbacks to the functions provided by a WPXHLListenerImpl class implementation when needed. This is often commonly called the 'main parsing routine'. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>input</em> </td><td>The input stream </td></tr>
<tr><td valign="top"></td><td valign="top"><em>listenerImpl</em> </td><td>A <a class="el" href="classWPSContentListener.html">WPSContentListener</a> implementation </td></tr>
</table>
</dl>
</div>
</div><p>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="WPSDocument_8h-source.html">WPSDocument.h</a><li><a class="el" href="WPSDocument_8cpp.html">WPSDocument.cpp</a></ul>
<hr size="1"><address style="align: right;"><small>
Generated on Sat Jan 5 21:59:17 2008 for libwps by <a href="http://www.doxygen.org/index.html">
doxygen</a> 1.5.4</small></address>
</body>
</html>
