Sophie

Sophie

distrib > Arklinux > devel > i586 > media > main > by-pkgid > 19939756bcec9fabb9b9a5fb2bb32a78 > files > 56

libwps-docs-0.2.2-1ark.i586.rpm

<!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.7.3 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</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&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
  initNavTree('classWPSDocument.html','');
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#pub-static-methods">Static Public Member Functions</a>  </div>
  <div class="headertitle">
<h1>WPSDocument Class Reference</h1>  </div>
</div>
<div class="contents">
<!-- doxytag: class="WPSDocument" -->
<p>This class provides all the functions an application would need to parse Works documents.  
<a href="#_details">More...</a></p>

<p><code>#include &lt;<a class="el" href="WPSDocument_8h_source.html">WPSDocument.h</a>&gt;</code></p>

<p><a href="classWPSDocument-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static WPSLIB <a class="el" href="WPSDocument_8h.html#acda7c59188729c6946337bc699cbd004">WPSConfidence</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWPSDocument.html#a348f2c570153c7826fb77c4d74a4a4ec">isFileFormatSupported</a> (WPXInputStream *input)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Analyzes the content of an input stream to see if it can be parsed.  <a href="#a348f2c570153c7826fb77c4d74a4a4ec"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static WPSLIB <a class="el" href="WPSDocument_8h.html#af7225176f4a213df407623fcc9ddfe31">WPSResult</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWPSDocument.html#aad2d9e4d9a4fe6a930c2f4d045871fff">parse</a> (WPXInputStream *input, WPXDocumentInterface *documentInterface)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Parses the input stream content.  <a href="#aad2d9e4d9a4fe6a930c2f4d045871fff"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>This class provides all the functions an application would need to parse Works documents. </p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a348f2c570153c7826fb77c4d74a4a4ec"></a><!-- doxytag: member="WPSDocument::isFileFormatSupported" ref="a348f2c570153c7826fb77c4d74a4a4ec" args="(WPXInputStream *input)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="WPSDocument_8h.html#acda7c59188729c6946337bc699cbd004">WPSConfidence</a> WPSDocument::isFileFormatSupported </td>
          <td>(</td>
          <td class="paramtype">WPXInputStream *&#160;</td>
          <td class="paramname"><em>input</em></td><td>)</td>
          <td><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><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">input</td><td>The input stream </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><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>
<a class="anchor" id="aad2d9e4d9a4fe6a930c2f4d045871fff"></a><!-- doxytag: member="WPSDocument::parse" ref="aad2d9e4d9a4fe6a930c2f4d045871fff" args="(WPXInputStream *input, WPXDocumentInterface *documentInterface)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="WPSDocument_8h.html#af7225176f4a213df407623fcc9ddfe31">WPSResult</a> WPSDocument::parse </td>
          <td>(</td>
          <td class="paramtype">WPXInputStream *&#160;</td>
          <td class="paramname"><em>input</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">WPXDocumentInterface *&#160;</td>
          <td class="paramname"><em>documentInterface</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Parses the input stream content. </p>
<p>It will make callbacks to the functions provided by a WPXDocumentInterface class implementation when needed. This is often commonly called the 'main parsing routine'. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">input</td><td>The input stream </td></tr>
    <tr><td class="paramname">documentInterface</td><td>A WPSListener implementation </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<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>
<li><a class="el" href="WPSDocument_8cpp.html">WPSDocument.cpp</a></li>
</ul>
</div>
</div>
  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><a class="el" href="classWPSDocument.html">WPSDocument</a>      </li>
<hr size="1"><address style="align: right;"><small>
Generated on Mon May 23 2011 10:43:36 for libwps by <a href="http://www.doxygen.org/index.html">
doxygen</a> 1.7.3</small></address>
</body>
</html>