Sophie

Sophie

distrib > Mageia > 6 > i586 > media > core-release > by-pkgid > dcba08025f2814910ab603731a9c888d > files > 395

libe-book-doc-0.1.2-10.mga6.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>libebook::FB2DataContextBase Class Reference documentation</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',false,false,'search.php','Search');
});
</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">
$(document).ready(function(){initNavTree('classlibebook_1_1FB2DataContextBase.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-methods">Private Member Functions</a> &#124;
<a href="classlibebook_1_1FB2DataContextBase-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">libebook::FB2DataContextBase Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Base class for leaf data element contexts.  
 <a href="classlibebook_1_1FB2DataContextBase.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="FB2ParserContext_8h_source.html">FB2ParserContext.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for libebook::FB2DataContextBase:</div>
<div class="dyncontent">
 <div class="center">
  <img src="classlibebook_1_1FB2DataContextBase.png" usemap="#libebook::FB2DataContextBase_map" alt=""/>
  <map id="libebook::FB2DataContextBase_map" name="libebook::FB2DataContextBase_map">
<area href="classlibebook_1_1FB2ParserContext.html" title="Base class for all contexts. " alt="libebook::FB2ParserContext" shape="rect" coords="102,56,297,80"/>
<area href="classlibebook_1_1FB2XMLParserContext.html" alt="libebook::FB2XMLParserContext" shape="rect" coords="102,0,297,24"/>
<area href="classlibebook_1_1FB2EmptyLineContext.html" alt="libebook::FB2EmptyLineContext" shape="rect" coords="0,168,195,192"/>
<area href="classlibebook_1_1FB2InlineImageContext.html" alt="libebook::FB2InlineImageContext" shape="rect" coords="205,168,400,192"/>
</map>
 </div></div>
<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:a3d1225470b194a17d727821138fcadac"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlibebook_1_1FB2DataContextBase.html#a3d1225470b194a17d727821138fcadac">FB2DataContextBase</a> (<a class="el" href="classlibebook_1_1FB2ParserContext.html">FB2ParserContext</a> *parentContext)</td></tr>
<tr class="separator:a3d1225470b194a17d727821138fcadac"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classlibebook_1_1FB2ParserContext"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classlibebook_1_1FB2ParserContext')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classlibebook_1_1FB2ParserContext.html">libebook::FB2ParserContext</a></td></tr>
<tr class="memitem:ab85eb8ac359c18b2f6e8d76e35ff136d inherit pub_methods_classlibebook_1_1FB2ParserContext"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlibebook_1_1FB2ParserContext.html#ab85eb8ac359c18b2f6e8d76e35ff136d">FB2ParserContext</a> (<a class="el" href="classlibebook_1_1FB2ParserContext.html">FB2ParserContext</a> *parentContext, <a class="el" href="classlibebook_1_1FB2Collector.html">FB2Collector</a> *collector=0)</td></tr>
<tr class="memdesc:ab85eb8ac359c18b2f6e8d76e35ff136d inherit pub_methods_classlibebook_1_1FB2ParserContext"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a new context with <code>parentContext</code> as parent.  <a href="classlibebook_1_1FB2ParserContext.html#ab85eb8ac359c18b2f6e8d76e35ff136d">More...</a><br /></td></tr>
<tr class="separator:ab85eb8ac359c18b2f6e8d76e35ff136d inherit pub_methods_classlibebook_1_1FB2ParserContext"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af51c321ed88d25c8da83d90993fb04bf inherit pub_methods_classlibebook_1_1FB2ParserContext"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classlibebook_1_1FB2XMLParserContext.html">FB2XMLParserContext</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlibebook_1_1FB2ParserContext.html#af51c321ed88d25c8da83d90993fb04bf">leaveContext</a> () const</td></tr>
<tr class="memdesc:af51c321ed88d25c8da83d90993fb04bf inherit pub_methods_classlibebook_1_1FB2ParserContext"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destroy this context and return parent.  <a href="classlibebook_1_1FB2ParserContext.html#af51c321ed88d25c8da83d90993fb04bf">More...</a><br /></td></tr>
<tr class="separator:af51c321ed88d25c8da83d90993fb04bf inherit pub_methods_classlibebook_1_1FB2ParserContext"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adc84e1517246cf9d18ee59e19a9c94a5 inherit pub_methods_classlibebook_1_1FB2ParserContext"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classlibebook_1_1FB2Collector.html">FB2Collector</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlibebook_1_1FB2ParserContext.html#adc84e1517246cf9d18ee59e19a9c94a5">getCollector</a> () const</td></tr>
<tr class="memdesc:adc84e1517246cf9d18ee59e19a9c94a5 inherit pub_methods_classlibebook_1_1FB2ParserContext"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the collector.  <a href="classlibebook_1_1FB2ParserContext.html#adc84e1517246cf9d18ee59e19a9c94a5">More...</a><br /></td></tr>
<tr class="separator:adc84e1517246cf9d18ee59e19a9c94a5 inherit pub_methods_classlibebook_1_1FB2ParserContext"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4892371a3d247432ba31d68d811b71f8 inherit pub_methods_classlibebook_1_1FB2ParserContext"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classlibebook_1_1FB2ParserContext.html">FB2ParserContext</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlibebook_1_1FB2ParserContext.html#a4892371a3d247432ba31d68d811b71f8">getParentContext</a> () const</td></tr>
<tr class="memdesc:a4892371a3d247432ba31d68d811b71f8 inherit pub_methods_classlibebook_1_1FB2ParserContext"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the parent context.  <a href="classlibebook_1_1FB2ParserContext.html#a4892371a3d247432ba31d68d811b71f8">More...</a><br /></td></tr>
<tr class="separator:a4892371a3d247432ba31d68d811b71f8 inherit pub_methods_classlibebook_1_1FB2ParserContext"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classlibebook_1_1FB2XMLParserContext"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classlibebook_1_1FB2XMLParserContext')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classlibebook_1_1FB2XMLParserContext.html">libebook::FB2XMLParserContext</a></td></tr>
<tr class="memitem:aa11e14c160bfffb6baac586d39937845 inherit pub_methods_classlibebook_1_1FB2XMLParserContext"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlibebook_1_1FB2XMLParserContext.html#aa11e14c160bfffb6baac586d39937845">~FB2XMLParserContext</a> ()=0</td></tr>
<tr class="separator:aa11e14c160bfffb6baac586d39937845 inherit pub_methods_classlibebook_1_1FB2XMLParserContext"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0381dd7c689e9aac771307d9b3977007 inherit pub_methods_classlibebook_1_1FB2XMLParserContext"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlibebook_1_1FB2XMLParserContext.html#a0381dd7c689e9aac771307d9b3977007">endOfElement</a> ()=0</td></tr>
<tr class="memdesc:a0381dd7c689e9aac771307d9b3977007 inherit pub_methods_classlibebook_1_1FB2XMLParserContext"><td class="mdescLeft">&#160;</td><td class="mdescRight">Signalize the end of an element.  <a href="classlibebook_1_1FB2XMLParserContext.html#a0381dd7c689e9aac771307d9b3977007">More...</a><br /></td></tr>
<tr class="separator:a0381dd7c689e9aac771307d9b3977007 inherit pub_methods_classlibebook_1_1FB2XMLParserContext"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a46a2f5d7f1ca830114911aa416753fde inherit pub_methods_classlibebook_1_1FB2XMLParserContext"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlibebook_1_1FB2XMLParserContext.html#a46a2f5d7f1ca830114911aa416753fde">attribute</a> (const <a class="el" href="structlibebook_1_1FB2TokenData.html">FB2TokenData</a> &amp;<a class="el" href="RBToken_8cpp.html#a8f8f80d37794cde9472343e4487ba3eb">name</a>, const <a class="el" href="structlibebook_1_1FB2TokenData.html">FB2TokenData</a> *ns, const char *value)=0</td></tr>
<tr class="memdesc:a46a2f5d7f1ca830114911aa416753fde inherit pub_methods_classlibebook_1_1FB2XMLParserContext"><td class="mdescLeft">&#160;</td><td class="mdescRight">Process an attribute.  <a href="classlibebook_1_1FB2XMLParserContext.html#a46a2f5d7f1ca830114911aa416753fde">More...</a><br /></td></tr>
<tr class="separator:a46a2f5d7f1ca830114911aa416753fde inherit pub_methods_classlibebook_1_1FB2XMLParserContext"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-methods"></a>
Private Member Functions</h2></td></tr>
<tr class="memitem:a7235b65036a7e4f04c165dbd51dc3a65"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classlibebook_1_1FB2XMLParserContext.html">FB2XMLParserContext</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlibebook_1_1FB2DataContextBase.html#a7235b65036a7e4f04c165dbd51dc3a65">element</a> (const <a class="el" href="structlibebook_1_1FB2TokenData.html">FB2TokenData</a> &amp;<a class="el" href="RBToken_8cpp.html#a8f8f80d37794cde9472343e4487ba3eb">name</a>, const <a class="el" href="structlibebook_1_1FB2TokenData.html">FB2TokenData</a> &amp;ns)</td></tr>
<tr class="memdesc:a7235b65036a7e4f04c165dbd51dc3a65"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a context for parsing a child element.  <a href="#a7235b65036a7e4f04c165dbd51dc3a65">More...</a><br /></td></tr>
<tr class="separator:a7235b65036a7e4f04c165dbd51dc3a65"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8e3d5996aadfa65248c1ac63cfe30f04"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlibebook_1_1FB2DataContextBase.html#a8e3d5996aadfa65248c1ac63cfe30f04">startOfElement</a> ()</td></tr>
<tr class="memdesc:a8e3d5996aadfa65248c1ac63cfe30f04"><td class="mdescLeft">&#160;</td><td class="mdescRight">Signalize the start of an element.  <a href="#a8e3d5996aadfa65248c1ac63cfe30f04">More...</a><br /></td></tr>
<tr class="separator:a8e3d5996aadfa65248c1ac63cfe30f04"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad9fc70d598ec6775a414f50d4487ddd3"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlibebook_1_1FB2DataContextBase.html#ad9fc70d598ec6775a414f50d4487ddd3">endOfAttributes</a> ()</td></tr>
<tr class="memdesc:ad9fc70d598ec6775a414f50d4487ddd3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Signalize the end of attributes.  <a href="#ad9fc70d598ec6775a414f50d4487ddd3">More...</a><br /></td></tr>
<tr class="separator:ad9fc70d598ec6775a414f50d4487ddd3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a01cf9dfc017b0919e7dad8fb44502c03"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlibebook_1_1FB2DataContextBase.html#a01cf9dfc017b0919e7dad8fb44502c03">text</a> (const char *value)</td></tr>
<tr class="memdesc:a01cf9dfc017b0919e7dad8fb44502c03"><td class="mdescLeft">&#160;</td><td class="mdescRight">Process textual content of an element.  <a href="#a01cf9dfc017b0919e7dad8fb44502c03">More...</a><br /></td></tr>
<tr class="separator:a01cf9dfc017b0919e7dad8fb44502c03"><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>Base class for leaf data element contexts. </p>
<p>It provides empty implementations for functions that are typically not needed for processing leaf data elements (i.e., empty elements that only have attributes).</p>
<dl class="section note"><dt>Note</dt><dd>The parser inserts an artificial <a class="el" href="classlibebook_1_1FB2XMLParserContext.html#a0381dd7c689e9aac771307d9b3977007" title="Signalize the end of an element. ">endOfElement()</a> call for empty elements. </dd></dl>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a3d1225470b194a17d727821138fcadac"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3d1225470b194a17d727821138fcadac">&#9670;&nbsp;</a></span>FB2DataContextBase()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">libebook::FB2DataContextBase::FB2DataContextBase </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classlibebook_1_1FB2ParserContext.html">FB2ParserContext</a> *&#160;</td>
          <td class="paramname"><em>parentContext</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">explicit</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

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

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classlibebook_1_1FB2XMLParserContext.html">FB2XMLParserContext</a> * libebook::FB2DataContextBase::element </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="structlibebook_1_1FB2TokenData.html">FB2TokenData</a> &amp;&#160;</td>
          <td class="paramname"><em>name</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="structlibebook_1_1FB2TokenData.html">FB2TokenData</a> &amp;&#160;</td>
          <td class="paramname"><em>ns</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">private</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Create a context for parsing a child element. </p>
<dl class="section return"><dt>Returns</dt><dd>A new context or <code>0</code> if the child element cannot be handled. </dd></dl>

<p>Implements <a class="el" href="classlibebook_1_1FB2XMLParserContext.html#a01702a4ed0f5ac62b617f522eae871d8">libebook::FB2XMLParserContext</a>.</p>

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

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void libebook::FB2DataContextBase::endOfAttributes </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Signalize the end of attributes. </p>

<p>Implements <a class="el" href="classlibebook_1_1FB2XMLParserContext.html#ae41a93b66cb1715d00d9a1d194400ee4">libebook::FB2XMLParserContext</a>.</p>

<p>Reimplemented in <a class="el" href="classlibebook_1_1FB2InlineImageContext.html#ac5ba4e4a2f2270e71796029ecac9c3ed">libebook::FB2InlineImageContext</a>.</p>

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

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void libebook::FB2DataContextBase::startOfElement </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Signalize the start of an element. </p>
<p>This can be used if initialization of the context needs virtual function calls. </p>

<p>Implements <a class="el" href="classlibebook_1_1FB2XMLParserContext.html#adeb12339a4f6d7b6cb47592512b97a0f">libebook::FB2XMLParserContext</a>.</p>

<p>Reimplemented in <a class="el" href="classlibebook_1_1FB2InlineImageContext.html#afde8cecb1b58f1048767eef18314dbba">libebook::FB2InlineImageContext</a>.</p>

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

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void libebook::FB2DataContextBase::text </td>
          <td>(</td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>value</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Process textual content of an element. </p>
<p>This function can be called more than once if the element has mixed content. </p>

<p>Implements <a class="el" href="classlibebook_1_1FB2XMLParserContext.html#a42d6723b9fed90bedf18d79b1214941d">libebook::FB2XMLParserContext</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="FB2ParserContext_8h_source.html">FB2ParserContext.h</a></li>
<li><a class="el" href="FB2ParserContext_8cpp.html">FB2ParserContext.cpp</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<hr size="1"><address style="align: right;"><small>
Generated for libe-book by <a href="http://www.doxygen.org/index.html">
doxygen</a> 1.8.13</small></address>
</body>
</html>