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.

265 lines
14 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++: DOMStringList 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="classDOMStringList-members.html">List of all members</a> </div>
  50. <div class="headertitle">
  51. <div class="title">DOMStringList Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
  52. </div><!--header-->
  53. <div class="contents">
  54. <p>The <code><a class="el" href="classDOMStringList.html" title="The DOMStringList interface provides the abstraction of an ordered collection of strings, without defining or constraining how this collection is implemented. ">DOMStringList</a></code> interface provides the abstraction of an ordered collection of strings, without defining or constraining how this collection is implemented.
  55. <a href="classDOMStringList.html#details">More...</a></p>
  56. <table class="memberdecls">
  57. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  58. Public Member Functions</h2></td></tr>
  59. <tr><td colspan="2"><div class="groupHeader">Destructor</div></td></tr>
  60. <tr class="memitem:a44f200a0849531f86121b7f917d51f5c"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDOMStringList.html#a44f200a0849531f86121b7f917d51f5c">~DOMStringList</a> ()</td></tr>
  61. <tr class="memdesc:a44f200a0849531f86121b7f917d51f5c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor. <a href="#a44f200a0849531f86121b7f917d51f5c">More...</a><br /></td></tr>
  62. <tr class="separator:a44f200a0849531f86121b7f917d51f5c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  63. <tr><td colspan="2"><div class="groupHeader">Functions introduced in DOM Level 3</div></td></tr>
  64. <tr class="memitem:aea932ce2a1776f349aa9b03ecd8ea999"><td class="memItemLeft" align="right" valign="top">virtual const <a class="el" href="Xerces__autoconf__config_8borland_8hpp.html#a8cb107980a360c490ad7661f5d27cc0e">XMLCh</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDOMStringList.html#aea932ce2a1776f349aa9b03ecd8ea999">item</a> (<a class="el" href="Xerces__autoconf__config_8borland_8hpp.html#ac0f7e36996cd03eb43bcee10321f77cd">XMLSize_t</a> index) const =0</td></tr>
  65. <tr class="memdesc:aea932ce2a1776f349aa9b03ecd8ea999"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the <code>index</code> item in the collection. <a href="#aea932ce2a1776f349aa9b03ecd8ea999">More...</a><br /></td></tr>
  66. <tr class="separator:aea932ce2a1776f349aa9b03ecd8ea999"><td class="memSeparator" colspan="2">&#160;</td></tr>
  67. <tr class="memitem:ad61c613084922aa1e35c1bedd90136f9"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="Xerces__autoconf__config_8borland_8hpp.html#ac0f7e36996cd03eb43bcee10321f77cd">XMLSize_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDOMStringList.html#ad61c613084922aa1e35c1bedd90136f9">getLength</a> () const =0</td></tr>
  68. <tr class="memdesc:ad61c613084922aa1e35c1bedd90136f9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the number of strings in the list. <a href="#ad61c613084922aa1e35c1bedd90136f9">More...</a><br /></td></tr>
  69. <tr class="separator:ad61c613084922aa1e35c1bedd90136f9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  70. <tr class="memitem:a7514cc55558227626f2a4d48f96b015a"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDOMStringList.html#a7514cc55558227626f2a4d48f96b015a">contains</a> (const <a class="el" href="Xerces__autoconf__config_8borland_8hpp.html#a8cb107980a360c490ad7661f5d27cc0e">XMLCh</a> *) const =0</td></tr>
  71. <tr class="memdesc:a7514cc55558227626f2a4d48f96b015a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Test if a string is part of this <a class="el" href="classDOMStringList.html" title="The DOMStringList interface provides the abstraction of an ordered collection of strings, without defining or constraining how this collection is implemented. ">DOMStringList</a>. <a href="#a7514cc55558227626f2a4d48f96b015a">More...</a><br /></td></tr>
  72. <tr class="separator:a7514cc55558227626f2a4d48f96b015a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  73. <tr><td colspan="2"><div class="groupHeader">Non-standard Extension</div></td></tr>
  74. <tr class="memitem:a16bb861f9e169a20b02dce08e57b9278"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDOMStringList.html#a16bb861f9e169a20b02dce08e57b9278">release</a> ()=0</td></tr>
  75. <tr class="memdesc:a16bb861f9e169a20b02dce08e57b9278"><td class="mdescLeft">&#160;</td><td class="mdescRight">Called to indicate that this list is no longer in use and that the implementation may relinquish any resources associated with it and its associated children. <a href="#a16bb861f9e169a20b02dce08e57b9278">More...</a><br /></td></tr>
  76. <tr class="separator:a16bb861f9e169a20b02dce08e57b9278"><td class="memSeparator" colspan="2">&#160;</td></tr>
  77. </table><table class="memberdecls">
  78. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
  79. Protected Member Functions</h2></td></tr>
  80. <tr><td colspan="2"><div class="groupHeader">Hidden constructors</div></td></tr>
  81. <tr class="memitem:ad22f47d41c002c1a0e08795bf877a8f3"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDOMStringList.html#ad22f47d41c002c1a0e08795bf877a8f3">DOMStringList</a> ()</td></tr>
  82. <tr class="separator:ad22f47d41c002c1a0e08795bf877a8f3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  83. </table>
  84. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  85. <div class="textblock"><p>The <code><a class="el" href="classDOMStringList.html" title="The DOMStringList interface provides the abstraction of an ordered collection of strings, without defining or constraining how this collection is implemented. ">DOMStringList</a></code> interface provides the abstraction of an ordered collection of strings, without defining or constraining how this collection is implemented. </p>
  86. <p>The items in the <code><a class="el" href="classDOMStringList.html" title="The DOMStringList interface provides the abstraction of an ordered collection of strings, without defining or constraining how this collection is implemented. ">DOMStringList</a></code> are accessible via an integral index, starting from 0. </p>
  87. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  88. <a class="anchor" id="ad22f47d41c002c1a0e08795bf877a8f3"></a>
  89. <div class="memitem">
  90. <div class="memproto">
  91. <table class="mlabels">
  92. <tr>
  93. <td class="mlabels-left">
  94. <table class="memname">
  95. <tr>
  96. <td class="memname">DOMStringList::DOMStringList </td>
  97. <td>(</td>
  98. <td class="paramname"></td><td>)</td>
  99. <td></td>
  100. </tr>
  101. </table>
  102. </td>
  103. <td class="mlabels-right">
  104. <span class="mlabels"><span class="mlabel">protected</span></span> </td>
  105. </tr>
  106. </table>
  107. </div><div class="memdoc">
  108. </div>
  109. </div>
  110. <a class="anchor" id="a44f200a0849531f86121b7f917d51f5c"></a>
  111. <div class="memitem">
  112. <div class="memproto">
  113. <table class="mlabels">
  114. <tr>
  115. <td class="mlabels-left">
  116. <table class="memname">
  117. <tr>
  118. <td class="memname">virtual DOMStringList::~DOMStringList </td>
  119. <td>(</td>
  120. <td class="paramname"></td><td>)</td>
  121. <td></td>
  122. </tr>
  123. </table>
  124. </td>
  125. <td class="mlabels-right">
  126. <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
  127. </tr>
  128. </table>
  129. </div><div class="memdoc">
  130. <p>Destructor. </p>
  131. </div>
  132. </div>
  133. <h2 class="groupheader">Member Function Documentation</h2>
  134. <a class="anchor" id="a7514cc55558227626f2a4d48f96b015a"></a>
  135. <div class="memitem">
  136. <div class="memproto">
  137. <table class="mlabels">
  138. <tr>
  139. <td class="mlabels-left">
  140. <table class="memname">
  141. <tr>
  142. <td class="memname">virtual bool DOMStringList::contains </td>
  143. <td>(</td>
  144. <td class="paramtype">const <a class="el" href="Xerces__autoconf__config_8borland_8hpp.html#a8cb107980a360c490ad7661f5d27cc0e">XMLCh</a> *&#160;</td>
  145. <td class="paramname"></td><td>)</td>
  146. <td> const</td>
  147. </tr>
  148. </table>
  149. </td>
  150. <td class="mlabels-right">
  151. <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
  152. </tr>
  153. </table>
  154. </div><div class="memdoc">
  155. <p>Test if a string is part of this <a class="el" href="classDOMStringList.html" title="The DOMStringList interface provides the abstraction of an ordered collection of strings, without defining or constraining how this collection is implemented. ">DOMStringList</a>. </p>
  156. <dl class="section return"><dt>Returns</dt><dd><code>true</code> if the string has been found, <code>false</code> otherwise.</dd></dl>
  157. <dl class="section since"><dt>Since</dt><dd>DOM Level 3 </dd></dl>
  158. </div>
  159. </div>
  160. <a class="anchor" id="ad61c613084922aa1e35c1bedd90136f9"></a>
  161. <div class="memitem">
  162. <div class="memproto">
  163. <table class="mlabels">
  164. <tr>
  165. <td class="mlabels-left">
  166. <table class="memname">
  167. <tr>
  168. <td class="memname">virtual <a class="el" href="Xerces__autoconf__config_8borland_8hpp.html#ac0f7e36996cd03eb43bcee10321f77cd">XMLSize_t</a> DOMStringList::getLength </td>
  169. <td>(</td>
  170. <td class="paramname"></td><td>)</td>
  171. <td> const</td>
  172. </tr>
  173. </table>
  174. </td>
  175. <td class="mlabels-right">
  176. <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
  177. </tr>
  178. </table>
  179. </div><div class="memdoc">
  180. <p>Returns the number of strings in the list. </p>
  181. <p>The range of valid child node indices is 0 to <code>length-1</code> inclusive.</p>
  182. <dl class="section since"><dt>Since</dt><dd>DOM Level 3 </dd></dl>
  183. </div>
  184. </div>
  185. <a class="anchor" id="aea932ce2a1776f349aa9b03ecd8ea999"></a>
  186. <div class="memitem">
  187. <div class="memproto">
  188. <table class="mlabels">
  189. <tr>
  190. <td class="mlabels-left">
  191. <table class="memname">
  192. <tr>
  193. <td class="memname">virtual const <a class="el" href="Xerces__autoconf__config_8borland_8hpp.html#a8cb107980a360c490ad7661f5d27cc0e">XMLCh</a>* DOMStringList::item </td>
  194. <td>(</td>
  195. <td class="paramtype"><a class="el" href="Xerces__autoconf__config_8borland_8hpp.html#ac0f7e36996cd03eb43bcee10321f77cd">XMLSize_t</a>&#160;</td>
  196. <td class="paramname"><em>index</em></td><td>)</td>
  197. <td> const</td>
  198. </tr>
  199. </table>
  200. </td>
  201. <td class="mlabels-right">
  202. <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
  203. </tr>
  204. </table>
  205. </div><div class="memdoc">
  206. <p>Returns the <code>index</code> item in the collection. </p>
  207. <p>If <code>index</code> is greater than or equal to the number of strings in the list, this returns <code>null</code>.</p>
  208. <dl class="params"><dt>Parameters</dt><dd>
  209. <table class="params">
  210. <tr><td class="paramname">index</td><td>Index into the collection. </td></tr>
  211. </table>
  212. </dd>
  213. </dl>
  214. <dl class="section return"><dt>Returns</dt><dd>The string at the <code>index</code>th position in the <code><a class="el" href="classDOMStringList.html" title="The DOMStringList interface provides the abstraction of an ordered collection of strings, without defining or constraining how this collection is implemented. ">DOMStringList</a></code>, or <code>null</code> if that is not a valid index. </dd></dl>
  215. <dl class="section since"><dt>Since</dt><dd>DOM Level 3 </dd></dl>
  216. </div>
  217. </div>
  218. <a class="anchor" id="a16bb861f9e169a20b02dce08e57b9278"></a>
  219. <div class="memitem">
  220. <div class="memproto">
  221. <table class="mlabels">
  222. <tr>
  223. <td class="mlabels-left">
  224. <table class="memname">
  225. <tr>
  226. <td class="memname">virtual void DOMStringList::release </td>
  227. <td>(</td>
  228. <td class="paramname"></td><td>)</td>
  229. <td></td>
  230. </tr>
  231. </table>
  232. </td>
  233. <td class="mlabels-right">
  234. <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
  235. </tr>
  236. </table>
  237. </div><div class="memdoc">
  238. <p>Called to indicate that this list is no longer in use and that the implementation may relinquish any resources associated with it and its associated children. </p>
  239. <p>Access to a released object will lead to unexpected result. </p>
  240. </div>
  241. </div>
  242. <hr/>The documentation for this class was generated from the following file:<ul>
  243. <li><a class="el" href="DOMStringList_8hpp_source.html">DOMStringList.hpp</a></li>
  244. </ul>
  245. </div><!-- contents -->
  246. <!-- start footer part -->
  247. <hr class="footer"/><address class="footer"><small>
  248. Generated on Wed Mar 18 2015 10:43:38 for Xerces-C++ by &#160;<a href="http://www.doxygen.org/index.html">
  249. <img class="footer" src="doxygen.png" alt="doxygen"/>
  250. </a> 1.8.9.1
  251. </small></address>
  252. </body>
  253. </html>