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.

470 lines
26 KiB

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.9.1"/>
  7. <title>Xerces-C++: Parser Class Reference</title>
  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  9. <script type="text/javascript" src="jquery.js"></script>
  10. <script type="text/javascript" src="dynsections.js"></script>
  11. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  12. </head>
  13. <body>
  14. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  15. <div id="titlearea">
  16. <table cellspacing="0" cellpadding="0">
  17. <tbody>
  18. <tr style="height: 56px;">
  19. <td style="padding-left: 0.5em;">
  20. <div id="projectname">Xerces-C++
  21. &#160;<span id="projectnumber">3.1.2</span>
  22. </div>
  23. </td>
  24. </tr>
  25. </tbody>
  26. </table>
  27. </div>
  28. <!-- end header part -->
  29. <!-- Generated by Doxygen 1.8.9.1 -->
  30. <div id="navrow1" class="tabs">
  31. <ul class="tablist">
  32. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  33. <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
  34. <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
  35. <li><a href="files.html"><span>Files</span></a></li>
  36. </ul>
  37. </div>
  38. <div id="navrow2" class="tabs2">
  39. <ul class="tablist">
  40. <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
  41. <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
  42. <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
  43. <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
  44. </ul>
  45. </div>
  46. </div><!-- top -->
  47. <div class="header">
  48. <div class="summary">
  49. <a href="classParser-members.html">List of all members</a> </div>
  50. <div class="headertitle">
  51. <div class="title">Parser Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
  52. </div><!--header-->
  53. <div class="contents">
  54. <p>Basic interface for SAX (Simple API for XML) parsers.
  55. <a href="classParser.html#details">More...</a></p>
  56. <div class="dynheader">
  57. Inheritance diagram for Parser:</div>
  58. <div class="dyncontent">
  59. <div class="center">
  60. <img src="classParser.png" usemap="#Parser_map" alt=""/>
  61. <map id="Parser_map" name="Parser_map">
  62. <area href="classSAXParser.html" title="This class implements the SAX &#39;Parser&#39; interface and should be used by applications wishing to parse ..." alt="SAXParser" shape="rect" coords="0,56,76,80"/>
  63. </map>
  64. </div></div>
  65. <table class="memberdecls">
  66. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  67. Public Member Functions</h2></td></tr>
  68. <tr><td colspan="2"><div class="groupHeader">Constructors and Destructor</div></td></tr>
  69. <tr class="memitem:a12234f6cd36b61af4b50c94a179422c1"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classParser.html#a12234f6cd36b61af4b50c94a179422c1">Parser</a> ()</td></tr>
  70. <tr class="memdesc:a12234f6cd36b61af4b50c94a179422c1"><td class="mdescLeft">&#160;</td><td class="mdescRight">The default constructor. <a href="#a12234f6cd36b61af4b50c94a179422c1">More...</a><br /></td></tr>
  71. <tr class="separator:a12234f6cd36b61af4b50c94a179422c1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  72. <tr class="memitem:ad576b92b9cc324f6f41b0269a9a1a546"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classParser.html#ad576b92b9cc324f6f41b0269a9a1a546">~Parser</a> ()</td></tr>
  73. <tr class="memdesc:ad576b92b9cc324f6f41b0269a9a1a546"><td class="mdescLeft">&#160;</td><td class="mdescRight">The destructor. <a href="#ad576b92b9cc324f6f41b0269a9a1a546">More...</a><br /></td></tr>
  74. <tr class="separator:ad576b92b9cc324f6f41b0269a9a1a546"><td class="memSeparator" colspan="2">&#160;</td></tr>
  75. <tr><td colspan="2"><div class="groupHeader">The parser interfaces</div></td></tr>
  76. <tr class="memitem:a62435895e0615380f3017090ac232594"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classParser.html#a62435895e0615380f3017090ac232594">setEntityResolver</a> (<a class="el" href="classEntityResolver.html">EntityResolver</a> *const resolver)=0</td></tr>
  77. <tr class="memdesc:a62435895e0615380f3017090ac232594"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allow an application to register a custom entity resolver. <a href="#a62435895e0615380f3017090ac232594">More...</a><br /></td></tr>
  78. <tr class="separator:a62435895e0615380f3017090ac232594"><td class="memSeparator" colspan="2">&#160;</td></tr>
  79. <tr class="memitem:ad97184f9e4397e360903e2fdb72d23bf"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classParser.html#ad97184f9e4397e360903e2fdb72d23bf">setDTDHandler</a> (<a class="el" href="classDTDHandler.html">DTDHandler</a> *const handler)=0</td></tr>
  80. <tr class="memdesc:ad97184f9e4397e360903e2fdb72d23bf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allow an application to register a DTD event handler. <a href="#ad97184f9e4397e360903e2fdb72d23bf">More...</a><br /></td></tr>
  81. <tr class="separator:ad97184f9e4397e360903e2fdb72d23bf"><td class="memSeparator" colspan="2">&#160;</td></tr>
  82. <tr class="memitem:a2038c09146fff3b0ec66143630736bdb"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classParser.html#a2038c09146fff3b0ec66143630736bdb">setDocumentHandler</a> (<a class="el" href="classDocumentHandler.html">DocumentHandler</a> *const handler)=0</td></tr>
  83. <tr class="memdesc:a2038c09146fff3b0ec66143630736bdb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allow an application to register a document event handler. <a href="#a2038c09146fff3b0ec66143630736bdb">More...</a><br /></td></tr>
  84. <tr class="separator:a2038c09146fff3b0ec66143630736bdb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  85. <tr class="memitem:aacd0f62732e363faeb4e5ee5b0a6e12a"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classParser.html#aacd0f62732e363faeb4e5ee5b0a6e12a">setErrorHandler</a> (<a class="el" href="classErrorHandler.html">ErrorHandler</a> *const handler)=0</td></tr>
  86. <tr class="memdesc:aacd0f62732e363faeb4e5ee5b0a6e12a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allow an application to register an error event handler. <a href="#aacd0f62732e363faeb4e5ee5b0a6e12a">More...</a><br /></td></tr>
  87. <tr class="separator:aacd0f62732e363faeb4e5ee5b0a6e12a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  88. <tr class="memitem:a624fc687a49b917c11ef632367568b60"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classParser.html#a624fc687a49b917c11ef632367568b60">parse</a> (const <a class="el" href="classInputSource.html">InputSource</a> &amp;source)=0</td></tr>
  89. <tr class="memdesc:a624fc687a49b917c11ef632367568b60"><td class="mdescLeft">&#160;</td><td class="mdescRight">Parse an XML document. <a href="#a624fc687a49b917c11ef632367568b60">More...</a><br /></td></tr>
  90. <tr class="separator:a624fc687a49b917c11ef632367568b60"><td class="memSeparator" colspan="2">&#160;</td></tr>
  91. <tr class="memitem:a37d4db3b3e88307b0aad780a685d76fd"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classParser.html#a37d4db3b3e88307b0aad780a685d76fd">parse</a> (const <a class="el" href="Xerces__autoconf__config_8borland_8hpp.html#a8cb107980a360c490ad7661f5d27cc0e">XMLCh</a> *const systemId)=0</td></tr>
  92. <tr class="memdesc:a37d4db3b3e88307b0aad780a685d76fd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Parse an XML document from a system identifier (URI). <a href="#a37d4db3b3e88307b0aad780a685d76fd">More...</a><br /></td></tr>
  93. <tr class="separator:a37d4db3b3e88307b0aad780a685d76fd"><td class="memSeparator" colspan="2">&#160;</td></tr>
  94. <tr class="memitem:a802e068db2ca0b11d8f6365d8a3267c6"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classParser.html#a802e068db2ca0b11d8f6365d8a3267c6">parse</a> (const char *const systemId)=0</td></tr>
  95. <tr class="memdesc:a802e068db2ca0b11d8f6365d8a3267c6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Parse an XML document from a system identifier (URI). <a href="#a802e068db2ca0b11d8f6365d8a3267c6">More...</a><br /></td></tr>
  96. <tr class="separator:a802e068db2ca0b11d8f6365d8a3267c6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  97. </table>
  98. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  99. <div class="textblock"><p>Basic interface for SAX (Simple API for XML) parsers. </p>
  100. <p>All SAX parsers must implement this basic interface: it allows applications to register handlers for different types of events and to initiate a parse from a URI, or a character stream.</p>
  101. <p>All SAX parsers must also implement a zero-argument constructor (though other constructors are also allowed).</p>
  102. <p>SAX parsers are reusable but not re-entrant: the application may reuse a parser object (possibly with a different input source) once the first parse has completed successfully, but it may not invoke the <a class="el" href="classParser.html#a624fc687a49b917c11ef632367568b60" title="Parse an XML document. ">parse()</a> methods recursively within a parse.</p>
  103. <dl class="section see"><dt>See also</dt><dd><a class="el" href="classEntityResolver.html#a14e534eb2170015056ccd71458e1058c" title="Default Constructor. ">EntityResolver::EntityResolver</a> </dd>
  104. <dd>
  105. <a class="el" href="classDTDHandler.html#a1d17e15d976164f6d55f542759eea182" title="Default Constructor. ">DTDHandler::DTDHandler</a> </dd>
  106. <dd>
  107. <a class="el" href="classDocumentHandler.html#ac24bb98e06d7db2b0823816eec2f6c19" title="Default constructor. ">DocumentHandler::DocumentHandler</a> </dd>
  108. <dd>
  109. <a class="el" href="classErrorHandler.html#a7e5f379bd231442b898cef94556b2107" title="Default constructor. ">ErrorHandler::ErrorHandler</a> </dd>
  110. <dd>
  111. <a class="el" href="classHandlerBase.html#aa9bbcdb7958bace9296940ab702ef367">HandlerBase::HandlerBase</a> </dd>
  112. <dd>
  113. <a class="el" href="classInputSource.html#a601a7aa7124e2d8e9664eda9aea6b622" title="Default constructor. ">InputSource::InputSource</a> </dd></dl>
  114. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  115. <a class="anchor" id="a12234f6cd36b61af4b50c94a179422c1"></a>
  116. <div class="memitem">
  117. <div class="memproto">
  118. <table class="memname">
  119. <tr>
  120. <td class="memname">Parser::Parser </td>
  121. <td>(</td>
  122. <td class="paramname"></td><td>)</td>
  123. <td></td>
  124. </tr>
  125. </table>
  126. </div><div class="memdoc">
  127. <p>The default constructor. </p>
  128. </div>
  129. </div>
  130. <a class="anchor" id="ad576b92b9cc324f6f41b0269a9a1a546"></a>
  131. <div class="memitem">
  132. <div class="memproto">
  133. <table class="mlabels">
  134. <tr>
  135. <td class="mlabels-left">
  136. <table class="memname">
  137. <tr>
  138. <td class="memname">virtual Parser::~Parser </td>
  139. <td>(</td>
  140. <td class="paramname"></td><td>)</td>
  141. <td></td>
  142. </tr>
  143. </table>
  144. </td>
  145. <td class="mlabels-right">
  146. <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
  147. </tr>
  148. </table>
  149. </div><div class="memdoc">
  150. <p>The destructor. </p>
  151. </div>
  152. </div>
  153. <h2 class="groupheader">Member Function Documentation</h2>
  154. <a class="anchor" id="a624fc687a49b917c11ef632367568b60"></a>
  155. <div class="memitem">
  156. <div class="memproto">
  157. <table class="mlabels">
  158. <tr>
  159. <td class="mlabels-left">
  160. <table class="memname">
  161. <tr>
  162. <td class="memname">virtual void Parser::parse </td>
  163. <td>(</td>
  164. <td class="paramtype">const <a class="el" href="classInputSource.html">InputSource</a> &amp;&#160;</td>
  165. <td class="paramname"><em>source</em></td><td>)</td>
  166. <td></td>
  167. </tr>
  168. </table>
  169. </td>
  170. <td class="mlabels-right">
  171. <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
  172. </tr>
  173. </table>
  174. </div><div class="memdoc">
  175. <p>Parse an XML document. </p>
  176. <p>The application can use this method to instruct the SAX parser to begin parsing an XML document from any valid input source (a character stream, a byte stream, or a URI).</p>
  177. <p>Applications may not invoke this method while a parse is in progress (they should create a new <a class="el" href="classParser.html" title="Basic interface for SAX (Simple API for XML) parsers. ">Parser</a> instead for each additional XML document). Once a parse is complete, an application may reuse the same <a class="el" href="classParser.html" title="Basic interface for SAX (Simple API for XML) parsers. ">Parser</a> object, possibly with a different input source.</p>
  178. <dl class="params"><dt>Parameters</dt><dd>
  179. <table class="params">
  180. <tr><td class="paramname">source</td><td>The input source for the top-level of the XML document. </td></tr>
  181. </table>
  182. </dd>
  183. </dl>
  184. <dl class="exception"><dt>Exceptions</dt><dd>
  185. <table class="exception">
  186. <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>
  187. <tr><td class="paramname"><a class="el" href="classXMLException.html">XMLException</a></td><td>An exception from the parser or client handler code. </td></tr>
  188. </table>
  189. </dd>
  190. </dl>
  191. <dl class="section see"><dt>See also</dt><dd><a class="el" href="classInputSource.html#a601a7aa7124e2d8e9664eda9aea6b622" title="Default constructor. ">InputSource::InputSource</a> </dd>
  192. <dd>
  193. <a class="el" href="classParser.html#a62435895e0615380f3017090ac232594" title="Allow an application to register a custom entity resolver. ">setEntityResolver</a> </dd>
  194. <dd>
  195. <a class="el" href="classParser.html#ad97184f9e4397e360903e2fdb72d23bf" title="Allow an application to register a DTD event handler. ">setDTDHandler</a> </dd>
  196. <dd>
  197. <a class="el" href="classParser.html#a2038c09146fff3b0ec66143630736bdb" title="Allow an application to register a document event handler. ">setDocumentHandler</a> </dd>
  198. <dd>
  199. <a class="el" href="classParser.html#aacd0f62732e363faeb4e5ee5b0a6e12a" title="Allow an application to register an error event handler. ">setErrorHandler</a> </dd></dl>
  200. <p>Implemented in <a class="el" href="classSAXParser.html#ad684882ed98a172675553abe68109666">SAXParser</a>.</p>
  201. </div>
  202. </div>
  203. <a class="anchor" id="a37d4db3b3e88307b0aad780a685d76fd"></a>
  204. <div class="memitem">
  205. <div class="memproto">
  206. <table class="mlabels">
  207. <tr>
  208. <td class="mlabels-left">
  209. <table class="memname">
  210. <tr>
  211. <td class="memname">virtual void Parser::parse </td>
  212. <td>(</td>
  213. <td class="paramtype">const <a class="el" href="Xerces__autoconf__config_8borland_8hpp.html#a8cb107980a360c490ad7661f5d27cc0e">XMLCh</a> *const&#160;</td>
  214. <td class="paramname"><em>systemId</em></td><td>)</td>
  215. <td></td>
  216. </tr>
  217. </table>
  218. </td>
  219. <td class="mlabels-right">
  220. <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
  221. </tr>
  222. </table>
  223. </div><div class="memdoc">
  224. <p>Parse an XML document from a system identifier (URI). </p>
  225. <p>This method is a shortcut for the common case of reading a document from a system identifier. It is the exact equivalent of the following:</p>
  226. <p>parse(new URLInputSource(systemId));</p>
  227. <p>If the system identifier is a URL, it must be fully resolved by the application before it is passed to the parser.</p>
  228. <dl class="params"><dt>Parameters</dt><dd>
  229. <table class="params">
  230. <tr><td class="paramname">systemId</td><td>The system identifier (URI). </td></tr>
  231. </table>
  232. </dd>
  233. </dl>
  234. <dl class="exception"><dt>Exceptions</dt><dd>
  235. <table class="exception">
  236. <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>
  237. <tr><td class="paramname"><a class="el" href="classXMLException.html">XMLException</a></td><td>An exception from the parser or client handler code. </td></tr>
  238. </table>
  239. </dd>
  240. </dl>
  241. <dl class="section see"><dt>See also</dt><dd><a class="el" href="classParser.html#a624fc687a49b917c11ef632367568b60" title="Parse an XML document. ">parse(const InputSource&amp;)</a> </dd></dl>
  242. <p>Implemented in <a class="el" href="classSAXParser.html#a4a5146bda42a0ba972a6fbd77146e828">SAXParser</a>.</p>
  243. </div>
  244. </div>
  245. <a class="anchor" id="a802e068db2ca0b11d8f6365d8a3267c6"></a>
  246. <div class="memitem">
  247. <div class="memproto">
  248. <table class="mlabels">
  249. <tr>
  250. <td class="mlabels-left">
  251. <table class="memname">
  252. <tr>
  253. <td class="memname">virtual void Parser::parse </td>
  254. <td>(</td>
  255. <td class="paramtype">const char *const&#160;</td>
  256. <td class="paramname"><em>systemId</em></td><td>)</td>
  257. <td></td>
  258. </tr>
  259. </table>
  260. </td>
  261. <td class="mlabels-right">
  262. <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
  263. </tr>
  264. </table>
  265. </div><div class="memdoc">
  266. <p>Parse an XML document from a system identifier (URI). </p>
  267. <p>This method is a shortcut for the common case of reading a document from a system identifier. It is the exact equivalent of the following:</p>
  268. <p>parse(new URLInputSource(systemId));</p>
  269. <p>If the system identifier is a URL, it must be fully resolved by the application before it is passed to the parser.</p>
  270. <dl class="params"><dt>Parameters</dt><dd>
  271. <table class="params">
  272. <tr><td class="paramname">systemId</td><td>The system identifier (URI). </td></tr>
  273. </table>
  274. </dd>
  275. </dl>
  276. <dl class="exception"><dt>Exceptions</dt><dd>
  277. <table class="exception">
  278. <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>
  279. <tr><td class="paramname"><a class="el" href="classXMLException.html">XMLException</a></td><td>An exception from the parser or client handler code. </td></tr>
  280. </table>
  281. </dd>
  282. </dl>
  283. <dl class="section see"><dt>See also</dt><dd><a class="el" href="classParser.html#a624fc687a49b917c11ef632367568b60" title="Parse an XML document. ">parse(const InputSource&amp;)</a> </dd></dl>
  284. <p>Implemented in <a class="el" href="classSAXParser.html#a6e928e936c15ef184fd286380e9f8c14">SAXParser</a>.</p>
  285. </div>
  286. </div>
  287. <a class="anchor" id="a2038c09146fff3b0ec66143630736bdb"></a>
  288. <div class="memitem">
  289. <div class="memproto">
  290. <table class="mlabels">
  291. <tr>
  292. <td class="mlabels-left">
  293. <table class="memname">
  294. <tr>
  295. <td class="memname">virtual void Parser::setDocumentHandler </td>
  296. <td>(</td>
  297. <td class="paramtype"><a class="el" href="classDocumentHandler.html">DocumentHandler</a> *const&#160;</td>
  298. <td class="paramname"><em>handler</em></td><td>)</td>
  299. <td></td>
  300. </tr>
  301. </table>
  302. </td>
  303. <td class="mlabels-right">
  304. <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
  305. </tr>
  306. </table>
  307. </div><div class="memdoc">
  308. <p>Allow an application to register a document event handler. </p>
  309. <p>If the application does not register a document handler, all document events reported by the SAX parser will be silently ignored (this is the default behaviour implemented by <a class="el" href="classHandlerBase.html" title="Default base class for handlers. ">HandlerBase</a>).</p>
  310. <p>Applications may register a new or different handler in the middle of a parse, and the SAX parser must begin using the new handler immediately.</p>
  311. <dl class="params"><dt>Parameters</dt><dd>
  312. <table class="params">
  313. <tr><td class="paramname">handler</td><td>The document handler. </td></tr>
  314. </table>
  315. </dd>
  316. </dl>
  317. <dl class="section see"><dt>See also</dt><dd><a class="el" href="classDocumentHandler.html#ac24bb98e06d7db2b0823816eec2f6c19" title="Default constructor. ">DocumentHandler::DocumentHandler</a> </dd>
  318. <dd>
  319. <a class="el" href="classHandlerBase.html#aa9bbcdb7958bace9296940ab702ef367">HandlerBase::HandlerBase</a> </dd></dl>
  320. <p>Implemented in <a class="el" href="classSAXParser.html#af8593f6ca5ebb7c96d63eaea6935b1a9">SAXParser</a>.</p>
  321. </div>
  322. </div>
  323. <a class="anchor" id="ad97184f9e4397e360903e2fdb72d23bf"></a>
  324. <div class="memitem">
  325. <div class="memproto">
  326. <table class="mlabels">
  327. <tr>
  328. <td class="mlabels-left">
  329. <table class="memname">
  330. <tr>
  331. <td class="memname">virtual void Parser::setDTDHandler </td>
  332. <td>(</td>
  333. <td class="paramtype"><a class="el" href="classDTDHandler.html">DTDHandler</a> *const&#160;</td>
  334. <td class="paramname"><em>handler</em></td><td>)</td>
  335. <td></td>
  336. </tr>
  337. </table>
  338. </td>
  339. <td class="mlabels-right">
  340. <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
  341. </tr>
  342. </table>
  343. </div><div class="memdoc">
  344. <p>Allow an application to register a DTD event handler. </p>
  345. <p>If the application does not register a DTD handler, all DTD events reported by the SAX parser will be silently ignored (this is the default behaviour implemented by <a class="el" href="classHandlerBase.html" title="Default base class for handlers. ">HandlerBase</a>).</p>
  346. <p>Applications may register a new or different handler in the middle of a parse, and the SAX parser must begin using the new handler immediately.</p>
  347. <dl class="params"><dt>Parameters</dt><dd>
  348. <table class="params">
  349. <tr><td class="paramname">handler</td><td>The DTD handler. </td></tr>
  350. </table>
  351. </dd>
  352. </dl>
  353. <dl class="section see"><dt>See also</dt><dd><a class="el" href="classDTDHandler.html#a1d17e15d976164f6d55f542759eea182" title="Default Constructor. ">DTDHandler::DTDHandler</a> </dd>
  354. <dd>
  355. <a class="el" href="classHandlerBase.html#aa9bbcdb7958bace9296940ab702ef367">HandlerBase::HandlerBase</a> </dd></dl>
  356. <p>Implemented in <a class="el" href="classSAXParser.html#a718d0f982508496ac008a1b4f20eba06">SAXParser</a>.</p>
  357. </div>
  358. </div>
  359. <a class="anchor" id="a62435895e0615380f3017090ac232594"></a>
  360. <div class="memitem">
  361. <div class="memproto">
  362. <table class="mlabels">
  363. <tr>
  364. <td class="mlabels-left">
  365. <table class="memname">
  366. <tr>
  367. <td class="memname">virtual void Parser::setEntityResolver </td>
  368. <td>(</td>
  369. <td class="paramtype"><a class="el" href="classEntityResolver.html">EntityResolver</a> *const&#160;</td>
  370. <td class="paramname"><em>resolver</em></td><td>)</td>
  371. <td></td>
  372. </tr>
  373. </table>
  374. </td>
  375. <td class="mlabels-right">
  376. <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
  377. </tr>
  378. </table>
  379. </div><div class="memdoc">
  380. <p>Allow an application to register a custom entity resolver. </p>
  381. <p>If the application does not register an entity resolver, the SAX parser will resolve system identifiers and open connections to entities itself (this is the default behaviour implemented in <a class="el" href="classHandlerBase.html" title="Default base class for handlers. ">HandlerBase</a>).</p>
  382. <p>Applications may register a new or different entity resolver in the middle of a parse, and the SAX parser must begin using the new resolver immediately.</p>
  383. <dl class="params"><dt>Parameters</dt><dd>
  384. <table class="params">
  385. <tr><td class="paramname">resolver</td><td>The object for resolving entities. </td></tr>
  386. </table>
  387. </dd>
  388. </dl>
  389. <dl class="section see"><dt>See also</dt><dd><a class="el" href="classEntityResolver.html#a14e534eb2170015056ccd71458e1058c" title="Default Constructor. ">EntityResolver::EntityResolver</a> </dd>
  390. <dd>
  391. <a class="el" href="classHandlerBase.html#aa9bbcdb7958bace9296940ab702ef367">HandlerBase::HandlerBase</a> </dd></dl>
  392. <p>Implemented in <a class="el" href="classSAXParser.html#a55ca3032890cc8893cfcfc15753db57b">SAXParser</a>.</p>
  393. </div>
  394. </div>
  395. <a class="anchor" id="aacd0f62732e363faeb4e5ee5b0a6e12a"></a>
  396. <div class="memitem">
  397. <div class="memproto">
  398. <table class="mlabels">
  399. <tr>
  400. <td class="mlabels-left">
  401. <table class="memname">
  402. <tr>
  403. <td class="memname">virtual void Parser::setErrorHandler </td>
  404. <td>(</td>
  405. <td class="paramtype"><a class="el" href="classErrorHandler.html">ErrorHandler</a> *const&#160;</td>
  406. <td class="paramname"><em>handler</em></td><td>)</td>
  407. <td></td>
  408. </tr>
  409. </table>
  410. </td>
  411. <td class="mlabels-right">
  412. <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
  413. </tr>
  414. </table>
  415. </div><div class="memdoc">
  416. <p>Allow an application to register an error event handler. </p>
  417. <p>If the application does not register an error event handler, all error events reported by the SAX parser will be silently ignored, except for fatalError, which will throw a <a class="el" href="classSAXException.html" title="Encapsulate a general SAX error or warning. ">SAXException</a> (this is the default behaviour implemented by <a class="el" href="classHandlerBase.html" title="Default base class for handlers. ">HandlerBase</a>).</p>
  418. <p>Applications may register a new or different handler in the middle of a parse, and the SAX parser must begin using the new handler immediately.</p>
  419. <dl class="params"><dt>Parameters</dt><dd>
  420. <table class="params">
  421. <tr><td class="paramname">handler</td><td>The error handler. </td></tr>
  422. </table>
  423. </dd>
  424. </dl>
  425. <dl class="section see"><dt>See also</dt><dd><a class="el" href="classErrorHandler.html#a7e5f379bd231442b898cef94556b2107" title="Default constructor. ">ErrorHandler::ErrorHandler</a> </dd>
  426. <dd>
  427. <a class="el" href="classSAXException.html#ae1c8ab9b99e3c43572c1567e72c652e4" title="Default constructor. ">SAXException::SAXException</a> </dd>
  428. <dd>
  429. <a class="el" href="classHandlerBase.html#aa9bbcdb7958bace9296940ab702ef367">HandlerBase::HandlerBase</a> </dd></dl>
  430. <p>Implemented in <a class="el" href="classSAXParser.html#a4f473c91401970cfaed6147caaa41cbd">SAXParser</a>.</p>
  431. </div>
  432. </div>
  433. <hr/>The documentation for this class was generated from the following file:<ul>
  434. <li><a class="el" href="Parser_8hpp_source.html">Parser.hpp</a></li>
  435. </ul>
  436. </div><!-- contents -->
  437. <!-- start footer part -->
  438. <hr class="footer"/><address class="footer"><small>
  439. Generated on Wed Mar 18 2015 10:43:38 for Xerces-C++ by &#160;<a href="http://www.doxygen.org/index.html">
  440. <img class="footer" src="doxygen.png" alt="doxygen"/>
  441. </a> 1.8.9.1
  442. </small></address>
  443. </body>
  444. </html>