<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.15"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Orcus: sax_token_handler Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Orcus
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.15 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<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&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="classsax__token__handler-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">sax_token_handler Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include <<a class="el" href="sax__token_8hpp_source.html">sax_token.hpp</a>></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:aaf1e70ab190b57e1fb6220ecb2bcf3ea"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsax__token__handler.html#aaf1e70ab190b57e1fb6220ecb2bcf3ea">declaration</a> (const <a class="el" href="structorcus_1_1xml__declaration__t.html">orcus::xml_declaration_t</a> &decl)</td></tr>
<tr class="separator:aaf1e70ab190b57e1fb6220ecb2bcf3ea"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abd70a8ad1546ba4c37e33490b3ccc86f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsax__token__handler.html#abd70a8ad1546ba4c37e33490b3ccc86f">start_element</a> (const <a class="el" href="structorcus_1_1xml__token__element__t.html">orcus::xml_token_element_t</a> &elem)</td></tr>
<tr class="separator:abd70a8ad1546ba4c37e33490b3ccc86f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a820de86d5fe8ff6e08a8955bc8ee0247"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsax__token__handler.html#a820de86d5fe8ff6e08a8955bc8ee0247">end_element</a> (const <a class="el" href="structorcus_1_1xml__token__element__t.html">orcus::xml_token_element_t</a> &elem)</td></tr>
<tr class="separator:a820de86d5fe8ff6e08a8955bc8ee0247"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a73f6f84ebc17a6bc23492f686d795867"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsax__token__handler.html#a73f6f84ebc17a6bc23492f686d795867">characters</a> (const <a class="el" href="classorcus_1_1pstring.html">orcus::pstring</a> &val, bool transient)</td></tr>
<tr class="separator:a73f6f84ebc17a6bc23492f686d795867"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Skeleton handler for sax_token_parser. Feel free to copy this as a starting point for your own handler. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a73f6f84ebc17a6bc23492f686d795867"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a73f6f84ebc17a6bc23492f686d795867">◆ </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">void sax_token_handler::characters </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classorcus_1_1pstring.html">orcus::pstring</a> & </td>
<td class="paramname"><em>val</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>transient</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Called when a segment of a text content is parsed. Each text content is a direct child of an element, which may have multiple child contents when the element also has a child element that are direct sibling to the text contents or the text contents are splitted by a comment.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">val</td><td>value of the text content. </td></tr>
<tr><td class="paramname">transient</td><td>when true, the text content has been converted and is stored in a temporary buffer due to presence of one or more encoded characters, in which case <em>the passed text value needs to be either immediately converted to a non-text value or be interned within the scope of the callback</em>. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aaf1e70ab190b57e1fb6220ecb2bcf3ea"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaf1e70ab190b57e1fb6220ecb2bcf3ea">◆ </a></span>declaration()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void sax_token_handler::declaration </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structorcus_1_1xml__declaration__t.html">orcus::xml_declaration_t</a> & </td>
<td class="paramname"><em>decl</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Called immediately after the entire XML declaration has been parsed.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">decl</td><td>struct containing the attributes of the XML declaration. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a820de86d5fe8ff6e08a8955bc8ee0247"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a820de86d5fe8ff6e08a8955bc8ee0247">◆ </a></span>end_element()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void sax_token_handler::end_element </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structorcus_1_1xml__token__element__t.html">orcus::xml_token_element_t</a> & </td>
<td class="paramname"><em>elem</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Called at the end of each element.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">elem</td><td>struct containing the element's information as well as all the attributes that belong to the element. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="abd70a8ad1546ba4c37e33490b3ccc86f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abd70a8ad1546ba4c37e33490b3ccc86f">◆ </a></span>start_element()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void sax_token_handler::start_element </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structorcus_1_1xml__token__element__t.html">orcus::xml_token_element_t</a> & </td>
<td class="paramname"><em>elem</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Called at the start of each element.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">elem</td><td>struct containing the element's information as well as all the attributes that belong to the element. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Jan 11 2019 05:05:18 for Orcus by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.15
</small></address>
</body>
</html>
