|
|
<!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++: DTDHandler 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="classDTDHandler-members.html">List of all members</a> </div> <div class="headertitle"><div class="title">DTDHandler Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div></div><!--header--><div class="contents">
<p>Receive notification of basic DTD-related events. <a href="classDTDHandler.html#details">More...</a></p><div class="dynheader">Inheritance diagram for DTDHandler:</div><div class="dyncontent"> <div class="center"> <img src="classDTDHandler.png" usemap="#DTDHandler_map" alt=""/> <map id="DTDHandler_map" name="DTDHandler_map"><area href="classDefaultHandler.html" title="Default base class for SAX2 handlers. " alt="DefaultHandler" shape="rect" coords="0,56,97,80"/><area href="classHandlerBase.html" title="Default base class for handlers. " alt="HandlerBase" shape="rect" coords="107,56,204,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:a1d17e15d976164f6d55f542759eea182"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classDTDHandler.html#a1d17e15d976164f6d55f542759eea182">DTDHandler</a> ()</td></tr><tr class="memdesc:a1d17e15d976164f6d55f542759eea182"><td class="mdescLeft"> </td><td class="mdescRight">Default Constructor. <a href="#a1d17e15d976164f6d55f542759eea182">More...</a><br /></td></tr><tr class="separator:a1d17e15d976164f6d55f542759eea182"><td class="memSeparator" colspan="2"> </td></tr><tr class="memitem:aa8158333e0faf2e0850f3f7363d7f37e"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classDTDHandler.html#aa8158333e0faf2e0850f3f7363d7f37e">~DTDHandler</a> ()</td></tr><tr class="memdesc:aa8158333e0faf2e0850f3f7363d7f37e"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#aa8158333e0faf2e0850f3f7363d7f37e">More...</a><br /></td></tr><tr class="separator:aa8158333e0faf2e0850f3f7363d7f37e"><td class="memSeparator" colspan="2"> </td></tr><tr><td colspan="2"><div class="groupHeader">The DTD handler interface</div></td></tr><tr class="memitem:aaafc15a4880f41e9e44904be254cb70d"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classDTDHandler.html#aaafc15a4880f41e9e44904be254cb70d">notationDecl</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:aaafc15a4880f41e9e44904be254cb70d"><td class="mdescLeft"> </td><td class="mdescRight">Receive notification of a notation declaration event. <a href="#aaafc15a4880f41e9e44904be254cb70d">More...</a><br /></td></tr><tr class="separator:aaafc15a4880f41e9e44904be254cb70d"><td class="memSeparator" colspan="2"> </td></tr><tr class="memitem:a713d4ba5348319077a8d9b8f2d0948d6"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classDTDHandler.html#a713d4ba5348319077a8d9b8f2d0948d6">unparsedEntityDecl</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, const <a class="el" href="Xerces__autoconf__config_8borland_8hpp.html#a8cb107980a360c490ad7661f5d27cc0e">XMLCh</a> *const notationName)=0</td></tr><tr class="memdesc:a713d4ba5348319077a8d9b8f2d0948d6"><td class="mdescLeft"> </td><td class="mdescRight">Receive notification of an unparsed entity declaration event. <a href="#a713d4ba5348319077a8d9b8f2d0948d6">More...</a><br /></td></tr><tr class="separator:a713d4ba5348319077a8d9b8f2d0948d6"><td class="memSeparator" colspan="2"> </td></tr><tr class="memitem:a4eebace32128b2215f51a5c73a9437ad"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classDTDHandler.html#a4eebace32128b2215f51a5c73a9437ad">resetDocType</a> ()=0</td></tr><tr class="memdesc:a4eebace32128b2215f51a5c73a9437ad"><td class="mdescLeft"> </td><td class="mdescRight">Reset the DocType object on its reuse. <a href="#a4eebace32128b2215f51a5c73a9437ad">More...</a><br /></td></tr><tr class="separator:a4eebace32128b2215f51a5c73a9437ad"><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 basic DTD-related events. </p><p>If a SAX application needs information about notations and unparsed entities, then the application implements this interface and registers an instance with the SAX parser using the parser's setDTDHandler method. The parser uses the instance to report notation and unparsed entity declarations to the application.</p><p>The SAX parser may report these events in any order, regardless of the order in which the notations and unparsed entities were declared; however, all DTD events must be reported after the document handler's startDocument event, and before the first startElement event.</p><p>It is up to the application to store the information for future use (perhaps in a hash table or object tree). If the application encounters attributes of type "NOTATION", "ENTITY", or "ENTITIES", it can use the information that it obtained through this interface to find the entity and/or notation corresponding with the attribute value.</p><p>The <a class="el" href="classHandlerBase.html" title="Default base class for handlers. ">HandlerBase</a> class provides a default implementation of this interface, which simply ignores the events.</p><dl class="section see"><dt>See also</dt><dd><a class="el" href="classParser.html#ad97184f9e4397e360903e2fdb72d23bf" title="Allow an application to register a DTD event handler. ">Parser::setDTDHandler</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="a1d17e15d976164f6d55f542759eea182"></a><div class="memitem"><div class="memproto"> <table class="memname"> <tr> <td class="memname">DTDHandler::DTDHandler </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="aa8158333e0faf2e0850f3f7363d7f37e"></a><div class="memitem"><div class="memproto"><table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">virtual DTDHandler::~DTDHandler </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="aaafc15a4880f41e9e44904be254cb70d"></a><div class="memitem"><div class="memproto"><table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">virtual void DTDHandler::notationDecl </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 a notation declaration event. </p><p>It is up to the application to record the notation for later reference, if necessary.</p><p>If a system identifier is present, and it is a URL, the SAX parser must resolve it fully before passing it to the application.</p><dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">name</td><td>The notation name. </td></tr> <tr><td class="paramname">publicId</td><td>The notation's public identifier, or null if none was given. </td></tr> <tr><td class="paramname">systemId</td><td>The notation's system identifier, or null if none was given. </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="classDTDHandler.html#a713d4ba5348319077a8d9b8f2d0948d6" title="Receive notification of an unparsed entity declaration event. ">unparsedEntityDecl</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="classDefaultHandler.html#ad65445c39515705673b258c3c5bff816">DefaultHandler</a>, and <a class="el" href="classHandlerBase.html#a5f7df4e12baac8cd33ba56ea0f49fcdc">HandlerBase</a>.</p>
</div></div><a class="anchor" id="a4eebace32128b2215f51a5c73a9437ad"></a><div class="memitem"><div class="memproto"><table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">virtual void DTDHandler::resetDocType </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 DocType object on its reuse. </p><p>This method helps in reseting the DTD object implementation defaults each time the DTD is begun.</p>
<p>Implemented in <a class="el" href="classDefaultHandler.html#aab6378da1da5f80ee254d9c9fbc0e73f">DefaultHandler</a>, and <a class="el" href="classHandlerBase.html#a22cb17b641774f7eba0a717da6657195">HandlerBase</a>.</p>
</div></div><a class="anchor" id="a713d4ba5348319077a8d9b8f2d0948d6"></a><div class="memitem"><div class="memproto"><table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">virtual void DTDHandler::unparsedEntityDecl </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 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>notationName</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 an unparsed entity declaration event. </p><p>Note that the notation name corresponds to a notation reported by the <a class="el" href="classDTDHandler.html#aaafc15a4880f41e9e44904be254cb70d" title="Receive notification of a notation declaration event. ">notationDecl()</a> event. It is up to the application to record the entity for later reference, if necessary.</p><p>If the system identifier is a URL, the parser must resolve it fully before passing it to the application.</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><dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">name</td><td>The unparsed entity's name. </td></tr> <tr><td class="paramname">publicId</td><td>The entity's public identifier, or null if none was given. </td></tr> <tr><td class="paramname">systemId</td><td>The entity's system identifier (it must always have one). </td></tr> <tr><td class="paramname">notationName</td><td>The name of the associated notation. </td></tr> </table> </dd></dl><dl class="section see"><dt>See also</dt><dd><a class="el" href="classDTDHandler.html#aaafc15a4880f41e9e44904be254cb70d" title="Receive notification of a notation declaration event. ">notationDecl</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="classDefaultHandler.html#a00c42bf6af7327af2eb1704bf57121cf">DefaultHandler</a>, and <a class="el" href="classHandlerBase.html#a29bf492b4a6253b21f7f9bafcef03b9a">HandlerBase</a>.</p>
</div></div><hr/>The documentation for this class was generated from the following file:<ul><li><a class="el" href="DTDHandler_8hpp_source.html">DTDHandler.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>
|
