Sophie

Sophie

distrib > Mageia > 7 > armv7hl > media > core-release > by-pkgid > 9540662fe244f017caf6640ff95073b6 > files > 19

libodfgen-doc-0.1.7-2.mga7.noarch.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>OdfDocumentHandler Class Reference documentation</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',false,false,'search.php','Search');
});
/* @license-end */</script>
<div id="main-nav"></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">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('classOdfDocumentHandler.html','');});
/* @license-end */
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classOdfDocumentHandler-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">OdfDocumentHandler Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div>  </div>
</div><!--header-->
<div class="contents">

<p>XML writer.  
 <a href="classOdfDocumentHandler.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="OdfDocumentHandler_8hxx_source.html">OdfDocumentHandler.hxx</a>&gt;</code></p>
<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:a5e299c1379bd1451e63d71a9a580e4a5"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOdfDocumentHandler.html#a5e299c1379bd1451e63d71a9a580e4a5">~OdfDocumentHandler</a> ()</td></tr>
<tr class="separator:a5e299c1379bd1451e63d71a9a580e4a5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa50d0147344238e538d0e76d5b8dc78d"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOdfDocumentHandler.html#aa50d0147344238e538d0e76d5b8dc78d">startDocument</a> ()=0</td></tr>
<tr class="memdesc:aa50d0147344238e538d0e76d5b8dc78d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Start an XML document.  <a href="#aa50d0147344238e538d0e76d5b8dc78d">More...</a><br /></td></tr>
<tr class="separator:aa50d0147344238e538d0e76d5b8dc78d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4ae202fabeb1a2c18b213b9b49e7d651"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOdfDocumentHandler.html#a4ae202fabeb1a2c18b213b9b49e7d651">endDocument</a> ()=0</td></tr>
<tr class="memdesc:a4ae202fabeb1a2c18b213b9b49e7d651"><td class="mdescLeft">&#160;</td><td class="mdescRight">End the XML document.  <a href="#a4ae202fabeb1a2c18b213b9b49e7d651">More...</a><br /></td></tr>
<tr class="separator:a4ae202fabeb1a2c18b213b9b49e7d651"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac5d2d724427a1fba3ae71fec822ecede"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOdfDocumentHandler.html#ac5d2d724427a1fba3ae71fec822ecede">startElement</a> (const char *psName, const librevenge::RVNGPropertyList &amp;xPropList)=0</td></tr>
<tr class="memdesc:ac5d2d724427a1fba3ae71fec822ecede"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add a start tag to the XML document.  <a href="#ac5d2d724427a1fba3ae71fec822ecede">More...</a><br /></td></tr>
<tr class="separator:ac5d2d724427a1fba3ae71fec822ecede"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a602f08df7a592660a07cfcdbd00f52de"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOdfDocumentHandler.html#a602f08df7a592660a07cfcdbd00f52de">endElement</a> (const char *psName)=0</td></tr>
<tr class="memdesc:a602f08df7a592660a07cfcdbd00f52de"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add a end tag to the XML document.  <a href="#a602f08df7a592660a07cfcdbd00f52de">More...</a><br /></td></tr>
<tr class="separator:a602f08df7a592660a07cfcdbd00f52de"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afb6475fee077d9e6b325e8605bf8911b"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOdfDocumentHandler.html#afb6475fee077d9e6b325e8605bf8911b">characters</a> (const librevenge::RVNGString &amp;sCharacters)=0</td></tr>
<tr class="memdesc:afb6475fee077d9e6b325e8605bf8911b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Insert a textual content into the currently opened element.  <a href="#afb6475fee077d9e6b325e8605bf8911b">More...</a><br /></td></tr>
<tr class="separator:afb6475fee077d9e6b325e8605bf8911b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>XML writer. </p>
<p>This interface is used by the document generators to create a valid XML document. It is up to the implementation if the document will be saved to a file, printed to the standard output, saved to a file inside a package, or whatever else. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a5e299c1379bd1451e63d71a9a580e4a5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5e299c1379bd1451e63d71a9a580e4a5">&#9670;&nbsp;</a></span>~OdfDocumentHandler()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual OdfDocumentHandler::~OdfDocumentHandler </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 class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="afb6475fee077d9e6b325e8605bf8911b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afb6475fee077d9e6b325e8605bf8911b">&#9670;&nbsp;</a></span>characters()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void OdfDocumentHandler::characters </td>
          <td>(</td>
          <td class="paramtype">const librevenge::RVNGString &amp;&#160;</td>
          <td class="paramname"><em>sCharacters</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Insert a textual content into the currently opened element. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">sCharacters</td><td>the content </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="a4ae202fabeb1a2c18b213b9b49e7d651"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4ae202fabeb1a2c18b213b9b49e7d651">&#9670;&nbsp;</a></span>endDocument()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void OdfDocumentHandler::endDocument </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>End the XML document. </p>

</div>
</div>
<a id="a602f08df7a592660a07cfcdbd00f52de"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a602f08df7a592660a07cfcdbd00f52de">&#9670;&nbsp;</a></span>endElement()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void OdfDocumentHandler::endElement </td>
          <td>(</td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>psName</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Add a end tag to the XML document. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">psName</td><td>name of the element. It must match the name of the innermost currently opened element. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="aa50d0147344238e538d0e76d5b8dc78d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa50d0147344238e538d0e76d5b8dc78d">&#9670;&nbsp;</a></span>startDocument()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void OdfDocumentHandler::startDocument </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Start an XML document. </p>

</div>
</div>
<a id="ac5d2d724427a1fba3ae71fec822ecede"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac5d2d724427a1fba3ae71fec822ecede">&#9670;&nbsp;</a></span>startElement()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void OdfDocumentHandler::startElement </td>
          <td>(</td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>psName</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const librevenge::RVNGPropertyList &amp;&#160;</td>
          <td class="paramname"><em>xPropList</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Add a start tag to the XML document. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">psName</td><td>name of the element </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">xPropList</td><td>list of attributes </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="OdfDocumentHandler_8hxx_source.html">OdfDocumentHandler.hxx</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<hr size="1"><address style="align: right;"><small>
Generated for libodfgen by <a href="http://www.doxygen.org/index.html">
doxygen</a> 1.8.14</small></address>
</body>
</html>