You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
567 lines
34 KiB
567 lines
34 KiB
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.9.1"/>
|
|
<title>Xerces-C++: DocumentHandler 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="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 style="padding-left: 0.5em;">
|
|
<div id="projectname">Xerces-C++
|
|
 <span id="projectnumber">3.1.2</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.9.1 -->
|
|
<div id="navrow1" class="tabs">
|
|
<ul class="tablist">
|
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
|
<li><a href="pages.html"><span>Related Pages</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 List</span></a></li>
|
|
<li><a href="classes.html"><span>Class Index</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>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="classDocumentHandler-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">DocumentHandler Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Receive notification of general document events.
|
|
<a href="classDocumentHandler.html#details">More...</a></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for DocumentHandler:</div>
|
|
<div class="dyncontent">
|
|
<div class="center">
|
|
<img src="classDocumentHandler.png" usemap="#DocumentHandler_map" alt=""/>
|
|
<map id="DocumentHandler_map" name="DocumentHandler_map">
|
|
<area href="classHandlerBase.html" title="Default base class for handlers. " alt="HandlerBase" shape="rect" coords="0,56,113,80"/>
|
|
</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><td colspan="2"><div class="groupHeader">Constructors and Destructor</div></td></tr>
|
|
<tr class="memitem:ac24bb98e06d7db2b0823816eec2f6c19"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classDocumentHandler.html#ac24bb98e06d7db2b0823816eec2f6c19">DocumentHandler</a> ()</td></tr>
|
|
<tr class="memdesc:ac24bb98e06d7db2b0823816eec2f6c19"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="#ac24bb98e06d7db2b0823816eec2f6c19">More...</a><br /></td></tr>
|
|
<tr class="separator:ac24bb98e06d7db2b0823816eec2f6c19"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a64348e5ec164b667c1fe22053f8b1a8b"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classDocumentHandler.html#a64348e5ec164b667c1fe22053f8b1a8b">~DocumentHandler</a> ()</td></tr>
|
|
<tr class="memdesc:a64348e5ec164b667c1fe22053f8b1a8b"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#a64348e5ec164b667c1fe22053f8b1a8b">More...</a><br /></td></tr>
|
|
<tr class="separator:a64348e5ec164b667c1fe22053f8b1a8b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr><td colspan="2"><div class="groupHeader">The virtual document handler interface</div></td></tr>
|
|
<tr class="memitem:a11b895cf26b39d894529830cd988b579"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classDocumentHandler.html#a11b895cf26b39d894529830cd988b579">characters</a> (const <a class="el" href="Xerces__autoconf__config_8borland_8hpp.html#a8cb107980a360c490ad7661f5d27cc0e">XMLCh</a> *const chars, const <a class="el" href="Xerces__autoconf__config_8borland_8hpp.html#ac0f7e36996cd03eb43bcee10321f77cd">XMLSize_t</a> length)=0</td></tr>
|
|
<tr class="memdesc:a11b895cf26b39d894529830cd988b579"><td class="mdescLeft"> </td><td class="mdescRight">Receive notification of character data. <a href="#a11b895cf26b39d894529830cd988b579">More...</a><br /></td></tr>
|
|
<tr class="separator:a11b895cf26b39d894529830cd988b579"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a87e8fefd7fa90cbbd629ce45aa82c736"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classDocumentHandler.html#a87e8fefd7fa90cbbd629ce45aa82c736">endDocument</a> ()=0</td></tr>
|
|
<tr class="memdesc:a87e8fefd7fa90cbbd629ce45aa82c736"><td class="mdescLeft"> </td><td class="mdescRight">Receive notification of the end of a document. <a href="#a87e8fefd7fa90cbbd629ce45aa82c736">More...</a><br /></td></tr>
|
|
<tr class="separator:a87e8fefd7fa90cbbd629ce45aa82c736"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad3b6e82b8d674030b0b9b34173524af3"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classDocumentHandler.html#ad3b6e82b8d674030b0b9b34173524af3">endElement</a> (const <a class="el" href="Xerces__autoconf__config_8borland_8hpp.html#a8cb107980a360c490ad7661f5d27cc0e">XMLCh</a> *const name)=0</td></tr>
|
|
<tr class="memdesc:ad3b6e82b8d674030b0b9b34173524af3"><td class="mdescLeft"> </td><td class="mdescRight">Receive notification of the end of an element. <a href="#ad3b6e82b8d674030b0b9b34173524af3">More...</a><br /></td></tr>
|
|
<tr class="separator:ad3b6e82b8d674030b0b9b34173524af3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af2732a86367efbc82c8ebaec1f041276"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classDocumentHandler.html#af2732a86367efbc82c8ebaec1f041276">ignorableWhitespace</a> (const <a class="el" href="Xerces__autoconf__config_8borland_8hpp.html#a8cb107980a360c490ad7661f5d27cc0e">XMLCh</a> *const chars, const <a class="el" href="Xerces__autoconf__config_8borland_8hpp.html#ac0f7e36996cd03eb43bcee10321f77cd">XMLSize_t</a> length)=0</td></tr>
|
|
<tr class="memdesc:af2732a86367efbc82c8ebaec1f041276"><td class="mdescLeft"> </td><td class="mdescRight">Receive notification of ignorable whitespace in element content. <a href="#af2732a86367efbc82c8ebaec1f041276">More...</a><br /></td></tr>
|
|
<tr class="separator:af2732a86367efbc82c8ebaec1f041276"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a546c9915fbb6e926b7313c05772ca17c"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classDocumentHandler.html#a546c9915fbb6e926b7313c05772ca17c">processingInstruction</a> (const <a class="el" href="Xerces__autoconf__config_8borland_8hpp.html#a8cb107980a360c490ad7661f5d27cc0e">XMLCh</a> *const target, const <a class="el" href="Xerces__autoconf__config_8borland_8hpp.html#a8cb107980a360c490ad7661f5d27cc0e">XMLCh</a> *const data)=0</td></tr>
|
|
<tr class="memdesc:a546c9915fbb6e926b7313c05772ca17c"><td class="mdescLeft"> </td><td class="mdescRight">Receive notification of a processing instruction. <a href="#a546c9915fbb6e926b7313c05772ca17c">More...</a><br /></td></tr>
|
|
<tr class="separator:a546c9915fbb6e926b7313c05772ca17c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab74ecca443af07aa9e75e23846fb5868"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classDocumentHandler.html#ab74ecca443af07aa9e75e23846fb5868">resetDocument</a> ()=0</td></tr>
|
|
<tr class="memdesc:ab74ecca443af07aa9e75e23846fb5868"><td class="mdescLeft"> </td><td class="mdescRight">Reset the Document object on its reuse. <a href="#ab74ecca443af07aa9e75e23846fb5868">More...</a><br /></td></tr>
|
|
<tr class="separator:ab74ecca443af07aa9e75e23846fb5868"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad9e42f7996fc226800c2e445f32f4f6c"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classDocumentHandler.html#ad9e42f7996fc226800c2e445f32f4f6c">setDocumentLocator</a> (const <a class="el" href="classLocator.html">Locator</a> *const locator)=0</td></tr>
|
|
<tr class="memdesc:ad9e42f7996fc226800c2e445f32f4f6c"><td class="mdescLeft"> </td><td class="mdescRight">Receive an object for locating the origin of SAX document events. <a href="#ad9e42f7996fc226800c2e445f32f4f6c">More...</a><br /></td></tr>
|
|
<tr class="separator:ad9e42f7996fc226800c2e445f32f4f6c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a286dec815391a19130674d4f389f5db4"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classDocumentHandler.html#a286dec815391a19130674d4f389f5db4">startDocument</a> ()=0</td></tr>
|
|
<tr class="memdesc:a286dec815391a19130674d4f389f5db4"><td class="mdescLeft"> </td><td class="mdescRight">Receive notification of the beginning of a document. <a href="#a286dec815391a19130674d4f389f5db4">More...</a><br /></td></tr>
|
|
<tr class="separator:a286dec815391a19130674d4f389f5db4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a15fb4581aec4828d3ee85b658f7ceb69"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classDocumentHandler.html#a15fb4581aec4828d3ee85b658f7ceb69">startElement</a> (const <a class="el" href="Xerces__autoconf__config_8borland_8hpp.html#a8cb107980a360c490ad7661f5d27cc0e">XMLCh</a> *const name, <a class="el" href="classAttributeList.html">AttributeList</a> &attrs)=0</td></tr>
|
|
<tr class="memdesc:a15fb4581aec4828d3ee85b658f7ceb69"><td class="mdescLeft"> </td><td class="mdescRight">Receive notification of the beginning of an element. <a href="#a15fb4581aec4828d3ee85b658f7ceb69">More...</a><br /></td></tr>
|
|
<tr class="separator:a15fb4581aec4828d3ee85b658f7ceb69"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Receive notification of general document events. </p>
|
|
<p>This is the main interface that most SAX applications implement: if the application needs to be informed of basic parsing events, it implements this interface and registers an instance with the SAX parser using the setDocumentHandler method. The parser uses the instance to report basic document-related events like the start and end of elements and character data.</p>
|
|
<p>The order of events in this interface is very important, and mirrors the order of information in the document itself. For example, all of an element's content (character data, processing instructions, and/or subelements) will appear, in order, between the startElement event and the corresponding endElement event.</p>
|
|
<p>Application writers who do not want to implement the entire interface while can derive a class from <a class="el" href="classHandlerBase.html" title="Default base class for handlers. ">HandlerBase</a>, which implements the default functionality; parser writers can instantiate <a class="el" href="classHandlerBase.html" title="Default base class for handlers. ">HandlerBase</a> to obtain a default handler. The application can find the location of any document event using the <a class="el" href="classLocator.html" title="Interface for associating a SAX event with a document location. ">Locator</a> interface supplied by the <a class="el" href="classParser.html" title="Basic interface for SAX (Simple API for XML) parsers. ">Parser</a> through the setDocumentLocator method.</p>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classParser.html#a2038c09146fff3b0ec66143630736bdb" title="Allow an application to register a document event handler. ">Parser::setDocumentHandler</a> </dd>
|
|
<dd>
|
|
<a class="el" href="classLocator.html#a309b4d4180297ebe1a15c3ddff22bb0a" title="Default constructor. ">Locator::Locator</a> </dd>
|
|
<dd>
|
|
<a class="el" href="classHandlerBase.html#aa9bbcdb7958bace9296940ab702ef367">HandlerBase::HandlerBase</a> </dd></dl>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a class="anchor" id="ac24bb98e06d7db2b0823816eec2f6c19"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">DocumentHandler::DocumentHandler </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Default constructor. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a64348e5ec164b667c1fe22053f8b1a8b"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual DocumentHandler::~DocumentHandler </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Destructor. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a class="anchor" id="a11b895cf26b39d894529830cd988b579"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual void DocumentHandler::characters </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="Xerces__autoconf__config_8borland_8hpp.html#a8cb107980a360c490ad7661f5d27cc0e">XMLCh</a> *const </td>
|
|
<td class="paramname"><em>chars</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="Xerces__autoconf__config_8borland_8hpp.html#ac0f7e36996cd03eb43bcee10321f77cd">XMLSize_t</a> </td>
|
|
<td class="paramname"><em>length</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">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Receive notification of character data. </p>
|
|
<p>The <a class="el" href="classParser.html" title="Basic interface for SAX (Simple API for XML) parsers. ">Parser</a> will call this method to report each chunk of character data. SAX parsers may return all contiguous character data in a single chunk, or they may split it into several chunks; however, all of the characters in any single event must come from the same external entity, so that the <a class="el" href="classLocator.html" title="Interface for associating a SAX event with a document location. ">Locator</a> provides useful information.</p>
|
|
<p>The application must not attempt to read from the array outside of the specified range.</p>
|
|
<p>Note that some parsers will report whitespace using the <a class="el" href="classDocumentHandler.html#af2732a86367efbc82c8ebaec1f041276" title="Receive notification of ignorable whitespace in element content. ">ignorableWhitespace()</a> method rather than this one (validating parsers must do so).</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">chars</td><td>The characters from the XML document. </td></tr>
|
|
<tr><td class="paramname">length</td><td>The number of characters to read from the array. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="exception"><dt>Exceptions</dt><dd>
|
|
<table class="exception">
|
|
<tr><td class="paramname"><a class="el" href="classSAXException.html" title="Encapsulate a general SAX error or warning. ">SAXException</a></td><td>Any SAX exception, possibly wrapping another exception. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classDocumentHandler.html#af2732a86367efbc82c8ebaec1f041276" title="Receive notification of ignorable whitespace in element content. ">ignorableWhitespace</a> </dd>
|
|
<dd>
|
|
<a class="el" href="classLocator.html#a309b4d4180297ebe1a15c3ddff22bb0a" title="Default constructor. ">Locator::Locator</a> </dd></dl>
|
|
|
|
<p>Implemented in <a class="el" href="classHandlerBase.html#a662e6528eacda8192816cb4ce110a173">HandlerBase</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a87e8fefd7fa90cbbd629ce45aa82c736"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual void DocumentHandler::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>Receive notification of the end of a document. </p>
|
|
<p>The SAX parser will invoke this method only once, and it will be the last method invoked during the parse. The parser shall not invoke this method until it has either abandoned parsing (because of an unrecoverable error) or reached the end of input.</p>
|
|
<dl class="exception"><dt>Exceptions</dt><dd>
|
|
<table class="exception">
|
|
<tr><td class="paramname"><a class="el" href="classSAXException.html" title="Encapsulate a general SAX error or warning. ">SAXException</a></td><td>Any SAX exception, possibly wrapping another exception. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p>Implemented in <a class="el" href="classHandlerBase.html#a0902ca7ae75dae9d06a2525db4eb3cac">HandlerBase</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ad3b6e82b8d674030b0b9b34173524af3"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual void DocumentHandler::endElement </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="Xerces__autoconf__config_8borland_8hpp.html#a8cb107980a360c490ad7661f5d27cc0e">XMLCh</a> *const </td>
|
|
<td class="paramname"><em>name</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>Receive notification of the end of an element. </p>
|
|
<p>The SAX parser will invoke this method at the end of every element in the XML document; there will be a corresponding <a class="el" href="classDocumentHandler.html#a15fb4581aec4828d3ee85b658f7ceb69" title="Receive notification of the beginning of an element. ">startElement()</a> event for every <a class="el" href="classDocumentHandler.html#ad3b6e82b8d674030b0b9b34173524af3" title="Receive notification of the end of an element. ">endElement()</a> event (even when the element is empty).</p>
|
|
<p>If the element name has a namespace prefix, the prefix will still be attached to the name.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">name</td><td>The element type name </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="exception"><dt>Exceptions</dt><dd>
|
|
<table class="exception">
|
|
<tr><td class="paramname"><a class="el" href="classSAXException.html" title="Encapsulate a general SAX error or warning. ">SAXException</a></td><td>Any SAX exception, possibly wrapping another exception. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p>Implemented in <a class="el" href="classHandlerBase.html#ac37346b7da927c89c4459450b9bc1c7c">HandlerBase</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="af2732a86367efbc82c8ebaec1f041276"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual void DocumentHandler::ignorableWhitespace </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="Xerces__autoconf__config_8borland_8hpp.html#a8cb107980a360c490ad7661f5d27cc0e">XMLCh</a> *const </td>
|
|
<td class="paramname"><em>chars</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="Xerces__autoconf__config_8borland_8hpp.html#ac0f7e36996cd03eb43bcee10321f77cd">XMLSize_t</a> </td>
|
|
<td class="paramname"><em>length</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">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Receive notification of ignorable whitespace in element content. </p>
|
|
<p>Validating Parsers must use this method to report each chunk of ignorable whitespace (see the W3C XML 1.0 recommendation, section 2.10): non-validating parsers may also use this method if they are capable of parsing and using content models.</p>
|
|
<p>SAX parsers may return all contiguous whitespace in a single chunk, or they may split it into several chunks; however, all of the characters in any single event must come from the same external entity, so that the <a class="el" href="classLocator.html" title="Interface for associating a SAX event with a document location. ">Locator</a> provides useful information.</p>
|
|
<p>The application must not attempt to read from the array outside of the specified range.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">chars</td><td>The characters from the XML document. </td></tr>
|
|
<tr><td class="paramname">length</td><td>The number of characters to read from the array. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="exception"><dt>Exceptions</dt><dd>
|
|
<table class="exception">
|
|
<tr><td class="paramname"><a class="el" href="classSAXException.html" title="Encapsulate a general SAX error or warning. ">SAXException</a></td><td>Any SAX exception, possibly wrapping another exception. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classDocumentHandler.html#a11b895cf26b39d894529830cd988b579" title="Receive notification of character data. ">characters</a> </dd></dl>
|
|
|
|
<p>Implemented in <a class="el" href="classHandlerBase.html#a05eceb92182b6df7ef5589ab29f85892">HandlerBase</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a546c9915fbb6e926b7313c05772ca17c"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual void DocumentHandler::processingInstruction </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="Xerces__autoconf__config_8borland_8hpp.html#a8cb107980a360c490ad7661f5d27cc0e">XMLCh</a> *const </td>
|
|
<td class="paramname"><em>target</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="Xerces__autoconf__config_8borland_8hpp.html#a8cb107980a360c490ad7661f5d27cc0e">XMLCh</a> *const </td>
|
|
<td class="paramname"><em>data</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">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Receive notification of a processing instruction. </p>
|
|
<p>The <a class="el" href="classParser.html" title="Basic interface for SAX (Simple API for XML) parsers. ">Parser</a> will invoke this method once for each processing instruction found: note that processing instructions may occur before or after the main document element.</p>
|
|
<p>A SAX parser should never report an XML declaration (XML 1.0, section 2.8) or a text declaration (XML 1.0, section 4.3.1) using this method.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">target</td><td>The processing instruction target. </td></tr>
|
|
<tr><td class="paramname">data</td><td>The processing instruction data, or null if none was supplied. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="exception"><dt>Exceptions</dt><dd>
|
|
<table class="exception">
|
|
<tr><td class="paramname"><a class="el" href="classSAXException.html" title="Encapsulate a general SAX error or warning. ">SAXException</a></td><td>Any SAX exception, possibly wrapping another exception. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p>Implemented in <a class="el" href="classHandlerBase.html#a99e381277cc9d8daa44a990d1d0244ae">HandlerBase</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ab74ecca443af07aa9e75e23846fb5868"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual void DocumentHandler::resetDocument </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>Reset the Document object on its reuse. </p>
|
|
<p>This method helps in reseting the document implementation defaults each time the document is begun.</p>
|
|
|
|
<p>Implemented in <a class="el" href="classHandlerBase.html#a27d5aa7a1fca56f35fc9ef5d74aad57b">HandlerBase</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ad9e42f7996fc226800c2e445f32f4f6c"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual void DocumentHandler::setDocumentLocator </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classLocator.html">Locator</a> *const </td>
|
|
<td class="paramname"><em>locator</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>Receive an object for locating the origin of SAX document events. </p>
|
|
<p>SAX parsers are strongly encouraged (though not absolutely required) to supply a locator: if it does so, it must supply the locator to the application by invoking this method before invoking any of the other methods in the <a class="el" href="classDocumentHandler.html" title="Receive notification of general document events. ">DocumentHandler</a> interface.</p>
|
|
<p>The locator allows the application to determine the end position of any document-related event, even if the parser is not reporting an error. Typically, the application will use this information for reporting its own errors (such as character content that does not match an application's business rules). The information returned by the locator is probably not sufficient for use with a search engine.</p>
|
|
<p>Note that the locator will return correct information only during the invocation of the events in this interface. The application should not attempt to use it at any other time.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">locator</td><td>An object that can return the location of any SAX document event. The object is only 'on loan' to the client code and they are not to attempt to delete or modify it in any way!</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classLocator.html#a309b4d4180297ebe1a15c3ddff22bb0a" title="Default constructor. ">Locator::Locator</a> </dd></dl>
|
|
|
|
<p>Implemented in <a class="el" href="classHandlerBase.html#af1109bc43e42025f985480f8369d7db3">HandlerBase</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a286dec815391a19130674d4f389f5db4"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual void DocumentHandler::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>Receive notification of the beginning of a document. </p>
|
|
<p>The SAX parser will invoke this method only once, before any other methods in this interface or in <a class="el" href="classDTDHandler.html" title="Receive notification of basic DTD-related events. ">DTDHandler</a> (except for setDocumentLocator).</p>
|
|
<dl class="exception"><dt>Exceptions</dt><dd>
|
|
<table class="exception">
|
|
<tr><td class="paramname"><a class="el" href="classSAXException.html" title="Encapsulate a general SAX error or warning. ">SAXException</a></td><td>Any SAX exception, possibly wrapping another exception. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p>Implemented in <a class="el" href="classHandlerBase.html#a5459be20011e9d25b6471b2a8e5f053d">HandlerBase</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a15fb4581aec4828d3ee85b658f7ceb69"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual void DocumentHandler::startElement </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="Xerces__autoconf__config_8borland_8hpp.html#a8cb107980a360c490ad7661f5d27cc0e">XMLCh</a> *const </td>
|
|
<td class="paramname"><em>name</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classAttributeList.html">AttributeList</a> & </td>
|
|
<td class="paramname"><em>attrs</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">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Receive notification of the beginning of an element. </p>
|
|
<p>The <a class="el" href="classParser.html" title="Basic interface for SAX (Simple API for XML) parsers. ">Parser</a> will invoke this method at the beginning of every element in the XML document; there will be a corresponding <a class="el" href="classDocumentHandler.html#ad3b6e82b8d674030b0b9b34173524af3" title="Receive notification of the end of an element. ">endElement()</a> event for every <a class="el" href="classDocumentHandler.html#a15fb4581aec4828d3ee85b658f7ceb69" title="Receive notification of the beginning of an element. ">startElement()</a> event (even when the element is empty). All of the element's content will be reported, in order, before the corresponding <a class="el" href="classDocumentHandler.html#ad3b6e82b8d674030b0b9b34173524af3" title="Receive notification of the end of an element. ">endElement()</a> event.</p>
|
|
<p>If the element name has a namespace prefix, the prefix will still be attached. Note that the attribute list provided will contain only attributes with explicit values (specified or defaulted): #IMPLIED attributes will be omitted.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">name</td><td>The element type name. </td></tr>
|
|
<tr><td class="paramname">attrs</td><td>The attributes attached to the element, if any. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="exception"><dt>Exceptions</dt><dd>
|
|
<table class="exception">
|
|
<tr><td class="paramname"><a class="el" href="classSAXException.html" title="Encapsulate a general SAX error or warning. ">SAXException</a></td><td>Any SAX exception, possibly wrapping another exception. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classDocumentHandler.html#ad3b6e82b8d674030b0b9b34173524af3" title="Receive notification of the end of an element. ">endElement</a> </dd>
|
|
<dd>
|
|
<a class="el" href="classAttributeList.html#a192435ac438fe36a41a978bced27a7dc" title="Default constructor. ">AttributeList::AttributeList</a> </dd></dl>
|
|
|
|
<p>Implemented in <a class="el" href="classHandlerBase.html#a3f6d8a77ea81cc65e4f6ad9dda352cea">HandlerBase</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following file:<ul>
|
|
<li><a class="el" href="DocumentHandler_8hpp_source.html">DocumentHandler.hpp</a></li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated on Wed Mar 18 2015 10:43:37 for Xerces-C++ by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.9.1
|
|
</small></address>
|
|
</body>
|
|
</html>
|