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.

566 lines
31 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++: DOMConfiguration 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="#pub-methods">Public Member Functions</a> &#124;
  50. <a href="classDOMConfiguration-members.html">List of all members</a> </div>
  51. <div class="headertitle">
  52. <div class="title">DOMConfiguration Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
  53. </div><!--header-->
  54. <div class="contents">
  55. <p>The <a class="el" href="classDOMConfiguration.html" title="The DOMConfiguration interface represents the configuration of a document and maintains a table of re...">DOMConfiguration</a> interface represents the configuration of a document and maintains a table of recognized parameters.
  56. <a href="classDOMConfiguration.html#details">More...</a></p>
  57. <table class="memberdecls">
  58. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  59. Public Member Functions</h2></td></tr>
  60. <tr class="memitem:a6a183ae4da769fe6f3eb40ee9becda3d"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDOMConfiguration.html#a6a183ae4da769fe6f3eb40ee9becda3d">setParameter</a> (const <a class="el" href="Xerces__autoconf__config_8borland_8hpp.html#a8cb107980a360c490ad7661f5d27cc0e">XMLCh</a> *name, const void *value)=0</td></tr>
  61. <tr class="memdesc:a6a183ae4da769fe6f3eb40ee9becda3d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the value of a parameter. <a href="#a6a183ae4da769fe6f3eb40ee9becda3d">More...</a><br /></td></tr>
  62. <tr class="separator:a6a183ae4da769fe6f3eb40ee9becda3d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  63. <tr class="memitem:a16233c220296b2821b423f58ba2a14a4"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDOMConfiguration.html#a16233c220296b2821b423f58ba2a14a4">setParameter</a> (const <a class="el" href="Xerces__autoconf__config_8borland_8hpp.html#a8cb107980a360c490ad7661f5d27cc0e">XMLCh</a> *name, bool value)=0</td></tr>
  64. <tr class="separator:a16233c220296b2821b423f58ba2a14a4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  65. <tr class="memitem:aa6810645f4a72fbca7050973a533ddb5"><td class="memItemLeft" align="right" valign="top">virtual const void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDOMConfiguration.html#aa6810645f4a72fbca7050973a533ddb5">getParameter</a> (const <a class="el" href="Xerces__autoconf__config_8borland_8hpp.html#a8cb107980a360c490ad7661f5d27cc0e">XMLCh</a> *name) const =0</td></tr>
  66. <tr class="memdesc:aa6810645f4a72fbca7050973a533ddb5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the value of a parameter if known. <a href="#aa6810645f4a72fbca7050973a533ddb5">More...</a><br /></td></tr>
  67. <tr class="separator:aa6810645f4a72fbca7050973a533ddb5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  68. <tr class="memitem:a2a1576a73552ed0c14c97edeba0e54fb"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDOMConfiguration.html#a2a1576a73552ed0c14c97edeba0e54fb">canSetParameter</a> (const <a class="el" href="Xerces__autoconf__config_8borland_8hpp.html#a8cb107980a360c490ad7661f5d27cc0e">XMLCh</a> *name, const void *value) const =0</td></tr>
  69. <tr class="memdesc:a2a1576a73552ed0c14c97edeba0e54fb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if setting a parameter to a specific value is supported. <a href="#a2a1576a73552ed0c14c97edeba0e54fb">More...</a><br /></td></tr>
  70. <tr class="separator:a2a1576a73552ed0c14c97edeba0e54fb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  71. <tr class="memitem:aa299ff0d5aac2192dfed9c76204bfcc6"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDOMConfiguration.html#aa299ff0d5aac2192dfed9c76204bfcc6">canSetParameter</a> (const <a class="el" href="Xerces__autoconf__config_8borland_8hpp.html#a8cb107980a360c490ad7661f5d27cc0e">XMLCh</a> *name, bool value) const =0</td></tr>
  72. <tr class="separator:aa299ff0d5aac2192dfed9c76204bfcc6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  73. <tr class="memitem:a68c69d08a125ec13eed74fa7405989d6"><td class="memItemLeft" align="right" valign="top">virtual const <a class="el" href="classDOMStringList.html">DOMStringList</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDOMConfiguration.html#a68c69d08a125ec13eed74fa7405989d6">getParameterNames</a> () const =0</td></tr>
  74. <tr class="memdesc:a68c69d08a125ec13eed74fa7405989d6"><td class="mdescLeft">&#160;</td><td class="mdescRight">The list of the parameters supported by this <a class="el" href="classDOMConfiguration.html" title="The DOMConfiguration interface represents the configuration of a document and maintains a table of re...">DOMConfiguration</a> object and for which at least one value can be set by the application. <a href="#a68c69d08a125ec13eed74fa7405989d6">More...</a><br /></td></tr>
  75. <tr class="separator:a68c69d08a125ec13eed74fa7405989d6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  76. <tr><td colspan="2"><div class="groupHeader">Destructor</div></td></tr>
  77. <tr class="memitem:a42d0b82d5ddbaae795ffbdbb15ed38ef"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDOMConfiguration.html#a42d0b82d5ddbaae795ffbdbb15ed38ef">~DOMConfiguration</a> ()</td></tr>
  78. <tr class="memdesc:a42d0b82d5ddbaae795ffbdbb15ed38ef"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor. <a href="#a42d0b82d5ddbaae795ffbdbb15ed38ef">More...</a><br /></td></tr>
  79. <tr class="separator:a42d0b82d5ddbaae795ffbdbb15ed38ef"><td class="memSeparator" colspan="2">&#160;</td></tr>
  80. </table><table class="memberdecls">
  81. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
  82. Protected Member Functions</h2></td></tr>
  83. <tr><td colspan="2"><div class="groupHeader">Hidden constructors</div></td></tr>
  84. <tr class="memitem:afa77dad79085286f13ea1506ec564d90"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDOMConfiguration.html#afa77dad79085286f13ea1506ec564d90">DOMConfiguration</a> ()</td></tr>
  85. <tr class="separator:afa77dad79085286f13ea1506ec564d90"><td class="memSeparator" colspan="2">&#160;</td></tr>
  86. </table>
  87. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  88. <div class="textblock"><p>The <a class="el" href="classDOMConfiguration.html" title="The DOMConfiguration interface represents the configuration of a document and maintains a table of re...">DOMConfiguration</a> interface represents the configuration of a document and maintains a table of recognized parameters. </p>
  89. <p>Using the configuration, it is possible to change Document.normalizeDocument behavior, such as replacing CDATASection nodes with Text nodes or specifying the type of the schema that must be used when the validation of the Document is requested. <a class="el" href="classDOMConfiguration.html" title="The DOMConfiguration interface represents the configuration of a document and maintains a table of re...">DOMConfiguration</a> objects are also used in [DOM Level 3 Load and Save] in the <a class="el" href="classDOMLSParser.html" title="DOMLSParser provides an API for parsing XML documents and building the corresponding DOM document tre...">DOMLSParser</a> and <a class="el" href="classDOMLSSerializer.html">DOMLSSerializer</a> interfaces.</p>
  90. <p>The <a class="el" href="classDOMConfiguration.html" title="The DOMConfiguration interface represents the configuration of a document and maintains a table of re...">DOMConfiguration</a> distinguish two types of parameters: boolean (boolean parameters) and DOMUserData (parameters). The names used by the <a class="el" href="classDOMConfiguration.html" title="The DOMConfiguration interface represents the configuration of a document and maintains a table of re...">DOMConfiguration</a> object are defined throughout the DOM Level 3 specifications. Names are case-insensitive. To avoid possible conflicts, as a convention, names referring to boolean parameters and parameters defined outside the DOM specification should be made unique. Names are recommended to follow the XML name production rule but it is not enforced by the DOM implementation. DOM Level 3 Core Implementations are required to recognize all boolean parameters and parameters defined in this specification. Each boolean parameter state or parameter value may then be supported or not by the implementation. Refer to their definition to know if a state or a value must be supported or not.</p>
  91. <p>Note: Parameters are similar to features and properties used in SAX2 [SAX].</p>
  92. <p>The following list of parameters defined in the DOM:</p>
  93. <p>"error-handler" [required] A <a class="el" href="classDOMErrorHandler.html" title="Basic interface for DOM error handlers. ">DOMErrorHandler</a> object. If an error is encountered in the document, the implementation will call back the <a class="el" href="classDOMErrorHandler.html" title="Basic interface for DOM error handlers. ">DOMErrorHandler</a> registered using this parameter. When called, DOMError.relatedData will contain the closest node to where the error occured. If the implementation is unable to determine the node where the error occurs, DOMError.relatedData will contain the Document node. Mutations to the document from within an error handler will result in implementation dependent behaviour.</p>
  94. <p>"schema-type" [optional] A DOMString object containing an absolute URI and representing the type of the schema language used to validate a document against. Note that no lexical checking is done on the absolute URI. If this parameter is not set, a default value may be provided by the implementation, based on the schema languages supported and on the schema language used at load time.</p>
  95. <p>Note: For XML Schema [XML Schema Part 1], applications must use the value "http://www.w3.org/2001/XMLSchema". For XML DTD [XML 1.0], applications must use the value "http://www.w3.org/TR/REC-xml". Other schema languages are outside the scope of the W3C and therefore should recommend an absolute URI in order to use this method.</p>
  96. <p>"schema-location" [optional] A DOMString object containing a list of URIs, separated by white spaces (characters matching the nonterminal production S defined in section 2.3 [XML 1.0]), that represents the schemas against which validation should occur. The types of schemas referenced in this list must match the type specified with schema-type, otherwise the behaviour of an implementation is undefined. If the schema type is XML Schema [XML Schema Part 1], only one of the XML Schemas in the list can be with no namespace. If validation occurs against a namespace aware schema, i.e. XML Schema, and the targetNamespace of a schema (specified using this property) matches the targetNamespace of a schema occurring in the instance document, i.e in schemaLocation attribute, the schema specified by the user using this property will be used (i.e., in XML Schema the schemaLocation attribute in the instance document or on the import element will be effectively ignored).</p>
  97. <p>Note: It is illegal to set the schema-location parameter if the schema-type parameter value is not set. It is strongly recommended that DOMInputSource.baseURI will be set, so that an implementation can successfully resolve any external entities referenced.</p>
  98. <p>The following list of boolean parameters (features) defined in the DOM:</p>
  99. <p>"canonical-form" </p><pre class="fragment"> true
  100. [optional]
  101. Canonicalize the document according to the rules
  102. specified in [Canonical XML]. Note that this
  103. is limited to what can be represented in the DOM.
  104. In particular, there is no way to specify the order
  105. of the attributes in the DOM.
  106. false
  107. [required] (default)
  108. Do not canonicalize the document.
  109. </pre><p>"cdata-sections" </p><pre class="fragment"> true
  110. [required] (default)
  111. Keep CDATASection nodes in the document.
  112. false
  113. [required]
  114. Transform CDATASection nodes in the document
  115. into Text nodes. The new Text node is
  116. then combined with any adjacent Text node.
  117. </pre><p>"comments" </p><pre class="fragment"> true
  118. [required] (default)
  119. Keep Comment nodes in the document.
  120. false
  121. [required]
  122. Discard Comment nodes in the Document.
  123. </pre><p>"datatype-normalization" </p><pre class="fragment"> true
  124. [required]
  125. Exposed normalized values in the tree.
  126. false
  127. [required] (default)
  128. Do not perform normalization on the tree.
  129. </pre><p>"discard-default-content" </p><pre class="fragment"> true
  130. [required] (default)
  131. Use whatever information available to the
  132. implementation (i.e. XML schema, DTD, the specified
  133. flag on Attr nodes, and so on) to decide what
  134. attributes and content should be discarded or not.
  135. Note that the specified flag on Attr nodes in
  136. itself is not always reliable, it is only reliable
  137. when it is set to false since the only case where
  138. it can be set to false is if the attribute was
  139. created by the implementation. The default content
  140. won't be removed if an implementation does not have
  141. any information available.
  142. false
  143. [required]
  144. Keep all attributes and all content.
  145. </pre><p>"entities" </p><pre class="fragment"> true
  146. [required]
  147. Keep EntityReference and Entity nodes
  148. in the document.
  149. false
  150. [required] (default)
  151. Remove all EntityReference and Entity
  152. nodes from the document, putting the entity
  153. expansions directly in their place. Text
  154. nodes are into "normal" form. Only
  155. EntityReference nodes to non-defined entities
  156. are kept in the document.
  157. </pre><p>"infoset" </p><pre class="fragment"> true
  158. [required]
  159. Only keep in the document the information defined
  160. in the XML Information Set [XML Information
  161. set].
  162. This forces the following features to false:
  163. namespace-declarations, validate-if-schema,
  164. entities, datatype-normalization, cdata-sections.
  165. This forces the following features to true:
  166. whitespace-in-element-content, comments,
  167. namespaces.
  168. Other features are not changed unless explicitly
  169. specified in the description of the features.
  170. Note that querying this feature with getFeature
  171. returns true only if the individual features
  172. specified above are appropriately set.
  173. false
  174. Setting infoset to false has no effect.
  175. </pre><p>"namespaces" </p><pre class="fragment"> true
  176. [required] (default)
  177. Perform the namespace processing as defined in
  178. [XML Namespaces].
  179. false
  180. [optional]
  181. Do not perform the namespace processing.
  182. </pre><p>"namespace-declarations" </p><pre class="fragment"> true
  183. [required] (default)
  184. Include namespace declaration attributes, specified
  185. or defaulted from the schema or the DTD, in the
  186. document. See also the section Declaring
  187. Namespaces in [XML Namespaces].
  188. false
  189. [required]
  190. Discard all namespace declaration attributes. The
  191. Namespace prefixes are retained even if this
  192. feature is set to false.
  193. </pre><p>"normalize-characters" </p><pre class="fragment"> true
  194. [optional]
  195. Perform the W3C Text Normalization of the
  196. characters [CharModel] in the document.
  197. false
  198. [required] (default)
  199. Do not perform character normalization.
  200. </pre><p>"split-cdata-sections" </p><pre class="fragment"> true
  201. [required] (default)
  202. Split CDATA sections containing the CDATA section
  203. termination marker ']]&gt;'. When a CDATA section is
  204. split a warning is issued.
  205. false
  206. [required]
  207. Signal an error if a CDATASection contains an
  208. unrepresentable character.
  209. </pre><p>"validate" </p><pre class="fragment"> true
  210. [optional]
  211. Require the validation against a schema (i.e. XML
  212. schema, DTD, any other type or representation of
  213. schema) of the document as it is being normalized
  214. as defined by [XML 1.0]. If validation errors
  215. are found, or no schema was found, the error
  216. handler is notified. Note also that normalized
  217. values will not be exposed to the schema in used
  218. unless the feature datatype-normalization is true.
  219. Note: validate-if-schema and validate are mutually
  220. exclusive, setting one of them to true will set the
  221. other one to false.
  222. false
  223. [required] (default)
  224. Only XML 1.0 non-validating processing must be
  225. done. Note that validation might still happen if
  226. validate-if-schema is true.
  227. </pre><p>"validate-if-schema" </p><pre class="fragment"> true
  228. [optional]
  229. Enable validation only if a declaration for the
  230. document element can be found (independently of
  231. where it is found, i.e. XML schema, DTD, or any
  232. other type or representation of schema). If
  233. validation errors are found, the error handler is
  234. notified. Note also that normalized values will not
  235. be exposed to the schema in used unless the feature
  236. datatype-normalization is true.
  237. Note: validate-if-schema and validate are mutually
  238. exclusive, setting one of them to true will set the
  239. other one to false.
  240. false
  241. [required] (default)
  242. No validation should be performed if the document
  243. has a schema. Note that validation must still
  244. happen if validate is true.
  245. </pre><p>"element-content-whitespace" </p><pre class="fragment"> true
  246. [required] (default)
  247. Keep all white spaces in the document.
  248. false
  249. [optional]
  250. Discard white space in element content while
  251. normalizing. The implementation is expected to use
  252. the isWhitespaceInElementContent flag on Text
  253. nodes to determine if a text node should be written
  254. out or not.
  255. </pre><p>The resolutions of entities is done using Document.baseURI. However, when the features "LS-Load" or "LS-Save" defined in [DOM Level 3 Load and Save] are supported by the DOM implementation, the parameter "entity-resolver" can also be used on <a class="el" href="classDOMConfiguration.html" title="The DOMConfiguration interface represents the configuration of a document and maintains a table of re...">DOMConfiguration</a> objects attached to Document nodes. If this parameter is set, Document.normalizeDocument will invoke the entity resolver instead of using Document.baseURI. </p>
  256. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  257. <a class="anchor" id="afa77dad79085286f13ea1506ec564d90"></a>
  258. <div class="memitem">
  259. <div class="memproto">
  260. <table class="mlabels">
  261. <tr>
  262. <td class="mlabels-left">
  263. <table class="memname">
  264. <tr>
  265. <td class="memname">DOMConfiguration::DOMConfiguration </td>
  266. <td>(</td>
  267. <td class="paramname"></td><td>)</td>
  268. <td></td>
  269. </tr>
  270. </table>
  271. </td>
  272. <td class="mlabels-right">
  273. <span class="mlabels"><span class="mlabel">protected</span></span> </td>
  274. </tr>
  275. </table>
  276. </div><div class="memdoc">
  277. </div>
  278. </div>
  279. <a class="anchor" id="a42d0b82d5ddbaae795ffbdbb15ed38ef"></a>
  280. <div class="memitem">
  281. <div class="memproto">
  282. <table class="mlabels">
  283. <tr>
  284. <td class="mlabels-left">
  285. <table class="memname">
  286. <tr>
  287. <td class="memname">virtual DOMConfiguration::~DOMConfiguration </td>
  288. <td>(</td>
  289. <td class="paramname"></td><td>)</td>
  290. <td></td>
  291. </tr>
  292. </table>
  293. </td>
  294. <td class="mlabels-right">
  295. <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
  296. </tr>
  297. </table>
  298. </div><div class="memdoc">
  299. <p>Destructor. </p>
  300. </div>
  301. </div>
  302. <h2 class="groupheader">Member Function Documentation</h2>
  303. <a class="anchor" id="a2a1576a73552ed0c14c97edeba0e54fb"></a>
  304. <div class="memitem">
  305. <div class="memproto">
  306. <table class="mlabels">
  307. <tr>
  308. <td class="mlabels-left">
  309. <table class="memname">
  310. <tr>
  311. <td class="memname">virtual bool DOMConfiguration::canSetParameter </td>
  312. <td>(</td>
  313. <td class="paramtype">const <a class="el" href="Xerces__autoconf__config_8borland_8hpp.html#a8cb107980a360c490ad7661f5d27cc0e">XMLCh</a> *&#160;</td>
  314. <td class="paramname"><em>name</em>, </td>
  315. </tr>
  316. <tr>
  317. <td class="paramkey"></td>
  318. <td></td>
  319. <td class="paramtype">const void *&#160;</td>
  320. <td class="paramname"><em>value</em>&#160;</td>
  321. </tr>
  322. <tr>
  323. <td></td>
  324. <td>)</td>
  325. <td></td><td> const</td>
  326. </tr>
  327. </table>
  328. </td>
  329. <td class="mlabels-right">
  330. <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
  331. </tr>
  332. </table>
  333. </div><div class="memdoc">
  334. <p>Check if setting a parameter to a specific value is supported. </p>
  335. <dl class="params"><dt>Parameters</dt><dd>
  336. <table class="params">
  337. <tr><td class="paramname">name</td><td>The name of the parameter to check. </td></tr>
  338. <tr><td class="paramname">value</td><td>An object. if null, the returned value is true. </td></tr>
  339. </table>
  340. </dd>
  341. </dl>
  342. <dl class="section return"><dt>Returns</dt><dd>true if the parameter could be successfully set to the specified value, or false if the parameter is not recognized or the requested value is not supported. This does not change the current value of the parameter itself. </dd></dl>
  343. <dl class="section since"><dt>Since</dt><dd>DOM level 3 </dd></dl>
  344. </div>
  345. </div>
  346. <a class="anchor" id="aa299ff0d5aac2192dfed9c76204bfcc6"></a>
  347. <div class="memitem">
  348. <div class="memproto">
  349. <table class="mlabels">
  350. <tr>
  351. <td class="mlabels-left">
  352. <table class="memname">
  353. <tr>
  354. <td class="memname">virtual bool DOMConfiguration::canSetParameter </td>
  355. <td>(</td>
  356. <td class="paramtype">const <a class="el" href="Xerces__autoconf__config_8borland_8hpp.html#a8cb107980a360c490ad7661f5d27cc0e">XMLCh</a> *&#160;</td>
  357. <td class="paramname"><em>name</em>, </td>
  358. </tr>
  359. <tr>
  360. <td class="paramkey"></td>
  361. <td></td>
  362. <td class="paramtype">bool&#160;</td>
  363. <td class="paramname"><em>value</em>&#160;</td>
  364. </tr>
  365. <tr>
  366. <td></td>
  367. <td>)</td>
  368. <td></td><td> const</td>
  369. </tr>
  370. </table>
  371. </td>
  372. <td class="mlabels-right">
  373. <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
  374. </tr>
  375. </table>
  376. </div><div class="memdoc">
  377. </div>
  378. </div>
  379. <a class="anchor" id="aa6810645f4a72fbca7050973a533ddb5"></a>
  380. <div class="memitem">
  381. <div class="memproto">
  382. <table class="mlabels">
  383. <tr>
  384. <td class="mlabels-left">
  385. <table class="memname">
  386. <tr>
  387. <td class="memname">virtual const void* DOMConfiguration::getParameter </td>
  388. <td>(</td>
  389. <td class="paramtype">const <a class="el" href="Xerces__autoconf__config_8borland_8hpp.html#a8cb107980a360c490ad7661f5d27cc0e">XMLCh</a> *&#160;</td>
  390. <td class="paramname"><em>name</em></td><td>)</td>
  391. <td> const</td>
  392. </tr>
  393. </table>
  394. </td>
  395. <td class="mlabels-right">
  396. <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
  397. </tr>
  398. </table>
  399. </div><div class="memdoc">
  400. <p>Return the value of a parameter if known. </p>
  401. <dl class="params"><dt>Parameters</dt><dd>
  402. <table class="params">
  403. <tr><td class="paramname">name</td><td>The name of the parameter. </td></tr>
  404. </table>
  405. </dd>
  406. </dl>
  407. <dl class="section return"><dt>Returns</dt><dd>The current object associated with the specified parameter or null if no object has been associated or if the parameter is not supported. </dd></dl>
  408. <dl class="exception"><dt>Exceptions</dt><dd>
  409. <table class="exception">
  410. <tr><td class="paramname"><a class="el" href="classDOMException.html">DOMException</a></td><td>(NOT_FOUND_ERR) Raised when the i boolean parameter name is not recognized. </td></tr>
  411. </table>
  412. </dd>
  413. </dl>
  414. <dl class="section since"><dt>Since</dt><dd>DOM level 3 </dd></dl>
  415. </div>
  416. </div>
  417. <a class="anchor" id="a68c69d08a125ec13eed74fa7405989d6"></a>
  418. <div class="memitem">
  419. <div class="memproto">
  420. <table class="mlabels">
  421. <tr>
  422. <td class="mlabels-left">
  423. <table class="memname">
  424. <tr>
  425. <td class="memname">virtual const <a class="el" href="classDOMStringList.html">DOMStringList</a>* DOMConfiguration::getParameterNames </td>
  426. <td>(</td>
  427. <td class="paramname"></td><td>)</td>
  428. <td> const</td>
  429. </tr>
  430. </table>
  431. </td>
  432. <td class="mlabels-right">
  433. <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
  434. </tr>
  435. </table>
  436. </div><div class="memdoc">
  437. <p>The list of the parameters supported by this <a class="el" href="classDOMConfiguration.html" title="The DOMConfiguration interface represents the configuration of a document and maintains a table of re...">DOMConfiguration</a> object and for which at least one value can be set by the application. </p>
  438. <p>Note that this list can also contain parameter names defined outside this specification.</p>
  439. <dl class="section return"><dt>Returns</dt><dd>The list of parameters that can be used with setParameter/getParameter </dd></dl>
  440. <dl class="section since"><dt>Since</dt><dd>DOM level 3 </dd></dl>
  441. </div>
  442. </div>
  443. <a class="anchor" id="a6a183ae4da769fe6f3eb40ee9becda3d"></a>
  444. <div class="memitem">
  445. <div class="memproto">
  446. <table class="mlabels">
  447. <tr>
  448. <td class="mlabels-left">
  449. <table class="memname">
  450. <tr>
  451. <td class="memname">virtual void DOMConfiguration::setParameter </td>
  452. <td>(</td>
  453. <td class="paramtype">const <a class="el" href="Xerces__autoconf__config_8borland_8hpp.html#a8cb107980a360c490ad7661f5d27cc0e">XMLCh</a> *&#160;</td>
  454. <td class="paramname"><em>name</em>, </td>
  455. </tr>
  456. <tr>
  457. <td class="paramkey"></td>
  458. <td></td>
  459. <td class="paramtype">const void *&#160;</td>
  460. <td class="paramname"><em>value</em>&#160;</td>
  461. </tr>
  462. <tr>
  463. <td></td>
  464. <td>)</td>
  465. <td></td><td></td>
  466. </tr>
  467. </table>
  468. </td>
  469. <td class="mlabels-right">
  470. <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
  471. </tr>
  472. </table>
  473. </div><div class="memdoc">
  474. <p>Set the value of a parameter. </p>
  475. <dl class="params"><dt>Parameters</dt><dd>
  476. <table class="params">
  477. <tr><td class="paramname">name</td><td>The name of the parameter to set. </td></tr>
  478. <tr><td class="paramname">value</td><td>The new value or null if the user wishes to unset the parameter. While the type of the value parameter is defined as <code>DOMUserData</code>, the object type must match the type defined by the definition of the parameter. For example, if the parameter is "error-handler", the value must be of type <code><a class="el" href="classDOMErrorHandler.html" title="Basic interface for DOM error handlers. ">DOMErrorHandler</a></code> </td></tr>
  479. </table>
  480. </dd>
  481. </dl>
  482. <dl class="exception"><dt>Exceptions</dt><dd>
  483. <table class="exception">
  484. <tr><td class="paramname"><a class="el" href="classDOMException.html">DOMException</a></td><td>(NOT_SUPPORTED_ERR) Raised when the parameter name is recognized but the requested value cannot be set. </td></tr>
  485. <tr><td class="paramname"><a class="el" href="classDOMException.html">DOMException</a></td><td>(NOT_FOUND_ERR) Raised when the parameter name is not recognized. </td></tr>
  486. </table>
  487. </dd>
  488. </dl>
  489. <dl class="section since"><dt>Since</dt><dd>DOM level 3 </dd></dl>
  490. </div>
  491. </div>
  492. <a class="anchor" id="a16233c220296b2821b423f58ba2a14a4"></a>
  493. <div class="memitem">
  494. <div class="memproto">
  495. <table class="mlabels">
  496. <tr>
  497. <td class="mlabels-left">
  498. <table class="memname">
  499. <tr>
  500. <td class="memname">virtual void DOMConfiguration::setParameter </td>
  501. <td>(</td>
  502. <td class="paramtype">const <a class="el" href="Xerces__autoconf__config_8borland_8hpp.html#a8cb107980a360c490ad7661f5d27cc0e">XMLCh</a> *&#160;</td>
  503. <td class="paramname"><em>name</em>, </td>
  504. </tr>
  505. <tr>
  506. <td class="paramkey"></td>
  507. <td></td>
  508. <td class="paramtype">bool&#160;</td>
  509. <td class="paramname"><em>value</em>&#160;</td>
  510. </tr>
  511. <tr>
  512. <td></td>
  513. <td>)</td>
  514. <td></td><td></td>
  515. </tr>
  516. </table>
  517. </td>
  518. <td class="mlabels-right">
  519. <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
  520. </tr>
  521. </table>
  522. </div><div class="memdoc">
  523. </div>
  524. </div>
  525. <hr/>The documentation for this class was generated from the following file:<ul>
  526. <li><a class="el" href="DOMConfiguration_8hpp_source.html">DOMConfiguration.hpp</a></li>
  527. </ul>
  528. </div><!-- contents -->
  529. <!-- start footer part -->
  530. <hr class="footer"/><address class="footer"><small>
  531. Generated on Wed Mar 18 2015 10:43:37 for Xerces-C++ by &#160;<a href="http://www.doxygen.org/index.html">
  532. <img class="footer" src="doxygen.png" alt="doxygen"/>
  533. </a> 1.8.9.1
  534. </small></address>
  535. </body>
  536. </html>