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.
|
|
<!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++: LexicalHandler 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="classLexicalHandler-members.html">List of all members</a> </div> <div class="headertitle"><div class="title">LexicalHandler Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div></div><!--header--><div class="contents">
<p>Receive notification of lexical events. <a href="classLexicalHandler.html#details">More...</a></p><div class="dynheader">Inheritance diagram for LexicalHandler:</div><div class="dyncontent"> <div class="center"> <img src="classLexicalHandler.png" usemap="#LexicalHandler_map" alt=""/> <map id="LexicalHandler_map" name="LexicalHandler_map"><area href="classDefaultHandler.html" title="Default base class for SAX2 handlers. " alt="DefaultHandler" shape="rect" coords="0,56,97,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:a355f99e04837f54f0041a29c86530fa0"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classLexicalHandler.html#a355f99e04837f54f0041a29c86530fa0">LexicalHandler</a> ()</td></tr><tr class="memdesc:a355f99e04837f54f0041a29c86530fa0"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="#a355f99e04837f54f0041a29c86530fa0">More...</a><br /></td></tr><tr class="separator:a355f99e04837f54f0041a29c86530fa0"><td class="memSeparator" colspan="2"> </td></tr><tr class="memitem:a9a69c15cea4160ec8b555959c4e8cde5"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classLexicalHandler.html#a9a69c15cea4160ec8b555959c4e8cde5">~LexicalHandler</a> ()</td></tr><tr class="memdesc:a9a69c15cea4160ec8b555959c4e8cde5"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#a9a69c15cea4160ec8b555959c4e8cde5">More...</a><br /></td></tr><tr class="separator:a9a69c15cea4160ec8b555959c4e8cde5"><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:afa118e57acd501eeb68502418a3f7d29"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classLexicalHandler.html#afa118e57acd501eeb68502418a3f7d29">comment</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:afa118e57acd501eeb68502418a3f7d29"><td class="mdescLeft"> </td><td class="mdescRight">Receive notification of comments. <a href="#afa118e57acd501eeb68502418a3f7d29">More...</a><br /></td></tr><tr class="separator:afa118e57acd501eeb68502418a3f7d29"><td class="memSeparator" colspan="2"> </td></tr><tr class="memitem:a8609c86c920f8c4e0d194f82d9a4087d"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classLexicalHandler.html#a8609c86c920f8c4e0d194f82d9a4087d">endCDATA</a> ()=0</td></tr><tr class="memdesc:a8609c86c920f8c4e0d194f82d9a4087d"><td class="mdescLeft"> </td><td class="mdescRight">Receive notification of the end of a CDATA section. <a href="#a8609c86c920f8c4e0d194f82d9a4087d">More...</a><br /></td></tr><tr class="separator:a8609c86c920f8c4e0d194f82d9a4087d"><td class="memSeparator" colspan="2"> </td></tr><tr class="memitem:a1cb667e6f9070cb3570d44c1025d9792"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classLexicalHandler.html#a1cb667e6f9070cb3570d44c1025d9792">endDTD</a> ()=0</td></tr><tr class="memdesc:a1cb667e6f9070cb3570d44c1025d9792"><td class="mdescLeft"> </td><td class="mdescRight">Receive notification of the end of the DTD declarations. <a href="#a1cb667e6f9070cb3570d44c1025d9792">More...</a><br /></td></tr><tr class="separator:a1cb667e6f9070cb3570d44c1025d9792"><td class="memSeparator" colspan="2"> </td></tr><tr class="memitem:a1cb805a2bd1c80320a7cdc54a99e03a0"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classLexicalHandler.html#a1cb805a2bd1c80320a7cdc54a99e03a0">endEntity</a> (const <a class="el" href="Xerces__autoconf__config_8borland_8hpp.html#a8cb107980a360c490ad7661f5d27cc0e">XMLCh</a> *const name)=0</td></tr><tr class="memdesc:a1cb805a2bd1c80320a7cdc54a99e03a0"><td class="mdescLeft"> </td><td class="mdescRight">Receive notification of the end of an entity. <a href="#a1cb805a2bd1c80320a7cdc54a99e03a0">More...</a><br /></td></tr><tr class="separator:a1cb805a2bd1c80320a7cdc54a99e03a0"><td class="memSeparator" colspan="2"> </td></tr><tr class="memitem:a7eee2fa16d2eb2b7fa0accf4cce68442"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classLexicalHandler.html#a7eee2fa16d2eb2b7fa0accf4cce68442">startCDATA</a> ()=0</td></tr><tr class="memdesc:a7eee2fa16d2eb2b7fa0accf4cce68442"><td class="mdescLeft"> </td><td class="mdescRight">Receive notification of the start of a CDATA section. <a href="#a7eee2fa16d2eb2b7fa0accf4cce68442">More...</a><br /></td></tr><tr class="separator:a7eee2fa16d2eb2b7fa0accf4cce68442"><td class="memSeparator" colspan="2"> </td></tr><tr class="memitem:a0d4c4c6e8cd2a1d459c54e3bb644f3b7"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classLexicalHandler.html#a0d4c4c6e8cd2a1d459c54e3bb644f3b7">startDTD</a> (const <a class="el" href="Xerces__autoconf__config_8borland_8hpp.html#a8cb107980a360c490ad7661f5d27cc0e">XMLCh</a> *const name, const <a class="el" href="Xerces__autoconf__config_8borland_8hpp.html#a8cb107980a360c490ad7661f5d27cc0e">XMLCh</a> *const publicId, const <a class="el" href="Xerces__autoconf__config_8borland_8hpp.html#a8cb107980a360c490ad7661f5d27cc0e">XMLCh</a> *const systemId)=0</td></tr><tr class="memdesc:a0d4c4c6e8cd2a1d459c54e3bb644f3b7"><td class="mdescLeft"> </td><td class="mdescRight">Receive notification of the start of the DTD declarations. <a href="#a0d4c4c6e8cd2a1d459c54e3bb644f3b7">More...</a><br /></td></tr><tr class="separator:a0d4c4c6e8cd2a1d459c54e3bb644f3b7"><td class="memSeparator" colspan="2"> </td></tr><tr class="memitem:af9038d10ebb57009523aebd73781d1b2"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classLexicalHandler.html#af9038d10ebb57009523aebd73781d1b2">startEntity</a> (const <a class="el" href="Xerces__autoconf__config_8borland_8hpp.html#a8cb107980a360c490ad7661f5d27cc0e">XMLCh</a> *const name)=0</td></tr><tr class="memdesc:af9038d10ebb57009523aebd73781d1b2"><td class="mdescLeft"> </td><td class="mdescRight">Receive notification of the start of an entity. <a href="#af9038d10ebb57009523aebd73781d1b2">More...</a><br /></td></tr><tr class="separator:af9038d10ebb57009523aebd73781d1b2"><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 lexical events. </p><p>This is an extension handler for that provides lexical information about an XML document. It does not provide information about document content. For those events, an application must register an instance of a <a class="el" href="classContentHandler.html" title="Receive notification of general document events. ">ContentHandler</a>.</p><p>The order of events in this interface is very important, and mirrors the order of information in the document itself. For example, <a class="el" href="classLexicalHandler.html#a0d4c4c6e8cd2a1d459c54e3bb644f3b7" title="Receive notification of the start of the DTD declarations. ">startDTD()</a> and <a class="el" href="classLexicalHandler.html#a1cb667e6f9070cb3570d44c1025d9792" title="Receive notification of the end of the DTD declarations. ">endDTD()</a> events will occur before the first element in the document.</p><dl class="section see"><dt>See also</dt><dd><a class="el" href="classSAX2XMLReader.html#a397fd37a21987186c6e4e63211f5d118" title="Allow an application to register a lexical event handler. ">SAX2XMLReader::setLexicalHandler</a> </dd><dd><a class="el" href="classSAX2XMLReader.html#aa1885becac34443e9648ccaeeed733f5" title="Allow an application to register a document event handler. ">SAX2XMLReader::setContentHandler</a> </dd></dl></div><h2 class="groupheader">Constructor & Destructor Documentation</h2><a class="anchor" id="a355f99e04837f54f0041a29c86530fa0"></a><div class="memitem"><div class="memproto"> <table class="memname"> <tr> <td class="memname">LexicalHandler::LexicalHandler </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="a9a69c15cea4160ec8b555959c4e8cde5"></a><div class="memitem"><div class="memproto"><table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">virtual LexicalHandler::~LexicalHandler </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="afa118e57acd501eeb68502418a3f7d29"></a><div class="memitem"><div class="memproto"><table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">virtual void LexicalHandler::comment </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 comments. </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 occurrence of a comment in the XML document.</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>
<p>Implemented in <a class="el" href="classDefaultHandler.html#acaef2cb8e680ae7a4a356f8e253ae401">DefaultHandler</a>.</p>
</div></div><a class="anchor" id="a8609c86c920f8c4e0d194f82d9a4087d"></a><div class="memitem"><div class="memproto"><table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">virtual void LexicalHandler::endCDATA </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 CDATA section. </p><p>The SAX parser will invoke this method at the end of each CDATA parsed.</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="classDefaultHandler.html#af35a07e77f5f22f4118fa9af93e41664">DefaultHandler</a>.</p>
</div></div><a class="anchor" id="a1cb667e6f9070cb3570d44c1025d9792"></a><div class="memitem"><div class="memproto"><table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">virtual void LexicalHandler::endDTD </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 the DTD declarations. </p><p>The SAX parser will invoke this method at the end of the DTD</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="classDefaultHandler.html#ad5c97eedfa56518b329ba5fabfc6d947">DefaultHandler</a>.</p>
</div></div><a class="anchor" id="a1cb805a2bd1c80320a7cdc54a99e03a0"></a><div class="memitem"><div class="memproto"><table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">virtual void LexicalHandler::endEntity </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 entity. </p><p>The SAX parser will invoke this method at the end of an entity</p><dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">name</td><td>The name of the entity that is ending. </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="classDefaultHandler.html#af8878dc6a70b85d2b697570392293874">DefaultHandler</a>.</p>
</div></div><a class="anchor" id="a7eee2fa16d2eb2b7fa0accf4cce68442"></a><div class="memitem"><div class="memproto"><table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">virtual void LexicalHandler::startCDATA </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 start of a CDATA section. </p><p>The SAX parser will invoke this method at the start of each CDATA parsed.</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="classDefaultHandler.html#a3d563ab646fb550e6c041c584f52cc60">DefaultHandler</a>.</p>
</div></div><a class="anchor" id="a0d4c4c6e8cd2a1d459c54e3bb644f3b7"></a><div class="memitem"><div class="memproto"><table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">virtual void LexicalHandler::startDTD </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">const <a class="el" href="Xerces__autoconf__config_8borland_8hpp.html#a8cb107980a360c490ad7661f5d27cc0e">XMLCh</a> *const </td> <td class="paramname"><em>publicId</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>systemId</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 start of the DTD declarations. </p><p>The SAX parser will invoke this method at the start of the DTD</p><dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">name</td><td>The document type name. </td></tr> <tr><td class="paramname">publicId</td><td>The declared public identifier for the external DTD subset, or null if none was declared. </td></tr> <tr><td class="paramname">systemId</td><td>The declared system identifier for the external DTD subset, or null if none was declared. </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="classDefaultHandler.html#a0356f7c9aa7416eec0918d885896d74c">DefaultHandler</a>.</p>
</div></div><a class="anchor" id="af9038d10ebb57009523aebd73781d1b2"></a><div class="memitem"><div class="memproto"><table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">virtual void LexicalHandler::startEntity </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 start of an entity. </p><p>The SAX parser will invoke this method at the start of an entity</p><dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">name</td><td>The name of the entity that is starting. </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="classDefaultHandler.html#a4906bc9239e3fce1fab572d02c616004">DefaultHandler</a>.</p>
</div></div><hr/>The documentation for this class was generated from the following file:<ul><li><a class="el" href="LexicalHandler_8hpp_source.html">LexicalHandler.hpp</a></li></ul></div><!-- contents --><!-- start footer part --><hr class="footer"/><address class="footer"><small>Generated on Wed Mar 18 2015 10:43:38 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>
|
