XQuilla/docs/dom3-api/classxercesc_1_1DOMStringList.html

202 lines
12 KiB
HTML
Raw Normal View History

2020-02-17 21:17:06 +00:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>XQilla DOM3 API Documentation</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<a style="float:right;" href="http://sourceforge.net/projects/xqilla"><img src="http://sflogo.sourceforge.net/sflogo.php?group_id=152021&amp;type=2" border="0" alt="SourceForge.net Logo" /></a>
2020-02-17 21:22:42 +00:00
<!-- Generated by Doxygen 1.7.3 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
2020-02-17 21:19:57 +00:00
<li><a href="namespaces.html"><span>Namespaces</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>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul>
</div>
2020-02-17 21:22:42 +00:00
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
2020-02-17 21:19:57 +00:00
</ul>
</div>
2020-02-17 21:22:42 +00:00
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacexercesc.html">xercesc</a> </li>
<li class="navelem"><a class="el" href="classxercesc_1_1DOMStringList.html">DOMStringList</a> </li>
</ul>
2020-02-17 21:19:57 +00:00
</div>
</div>
2020-02-17 21:22:42 +00:00
<div class="header">
<div class="headertitle">
<h1>xercesc::DOMStringList Class Reference</h1> </div>
</div>
2020-02-17 21:19:57 +00:00
<div class="contents">
2020-02-17 21:22:42 +00:00
<!-- doxytag: class="xercesc::DOMStringList" -->
<p>The <code><a class="el" href="classxercesc_1_1DOMStringList.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.
2020-02-17 21:19:57 +00:00
<a href="#_details">More...</a></p>
2020-02-17 21:17:06 +00:00
2020-02-17 21:19:57 +00:00
<p><code>#include &lt;<a class="el" href="DOMStringList_8hpp_source.html">DOMStringList.hpp</a>&gt;</code></p>
2020-02-17 21:17:06 +00:00
2020-02-17 21:19:57 +00:00
<p><a href="classxercesc_1_1DOMStringList-members.html">List of all members.</a></p>
2020-02-17 21:22:42 +00:00
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
2020-02-17 21:19:57 +00:00
<tr><td colspan="2"><div class="groupHeader">Destructor</div></td></tr>
2020-02-17 21:22:42 +00:00
<tr><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMStringList.html#aff769c2ea4c3562329270a1d701d154f">~DOMStringList</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor. <a href="#aff769c2ea4c3562329270a1d701d154f"></a><br/></td></tr>
2020-02-17 21:19:57 +00:00
<tr><td colspan="2"><div class="groupHeader">Functions introduced in DOM Level 3</div></td></tr>
2020-02-17 21:22:42 +00:00
<tr><td class="memItemLeft" align="right" valign="top">virtual const XMLCh *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMStringList.html#adfc5ea722d290b1dabe3c4fa72eae4a6">item</a> (XMLSize_t index) const =0</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the <code>index</code> item in the collection. <a href="#adfc5ea722d290b1dabe3c4fa72eae4a6"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual XMLSize_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMStringList.html#a269486b8136603a3ac3698da66755455">getLength</a> () const =0</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the number of strings in the list. <a href="#a269486b8136603a3ac3698da66755455"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMStringList.html#a7a1f738b927608dc7b33ce32b5c7a3e6">contains</a> (const XMLCh *) const =0</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Test if a string is part of this <a class="el" href="classxercesc_1_1DOMStringList.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="#a7a1f738b927608dc7b33ce32b5c7a3e6"></a><br/></td></tr>
2020-02-17 21:17:06 +00:00
<tr><td colspan="2"><div class="groupHeader">Non-standard Extension</div></td></tr>
2020-02-17 21:22:42 +00:00
<tr><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMStringList.html#a9f8128dbe51906785ee9a76397e74ebf">release</a> ()=0</td></tr>
<tr><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="#a9f8128dbe51906785ee9a76397e74ebf"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
2020-02-17 21:17:06 +00:00
<tr><td colspan="2"><div class="groupHeader">Hidden constructors</div></td></tr>
2020-02-17 21:22:42 +00:00
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMStringList.html#a7082395b322e662288034234e24c4a52">DOMStringList</a> ()</td></tr>
2020-02-17 21:17:06 +00:00
</table>
2020-02-17 21:19:57 +00:00
<hr/><a name="_details"></a><h2>Detailed Description</h2>
2020-02-17 21:22:42 +00:00
<div class="textblock"><p>The <code><a class="el" href="classxercesc_1_1DOMStringList.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>
<p>The items in the <code><a class="el" href="classxercesc_1_1DOMStringList.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>
</div><hr/><h2>Constructor &amp; Destructor Documentation</h2>
2020-02-17 21:19:57 +00:00
<a class="anchor" id="a7082395b322e662288034234e24c4a52"></a><!-- doxytag: member="xercesc::DOMStringList::DOMStringList" ref="a7082395b322e662288034234e24c4a52" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
2020-02-17 21:17:06 +00:00
<tr>
2020-02-17 21:19:57 +00:00
<td class="memname">xercesc::DOMStringList::DOMStringList </td>
<td>(</td>
2020-02-17 21:22:42 +00:00
<td class="paramname"></td><td>)</td>
2020-02-17 21:19:57 +00:00
<td><code> [inline, protected]</code></td>
2020-02-17 21:17:06 +00:00
</tr>
</table>
2020-02-17 21:19:57 +00:00
</div>
<div class="memdoc">
2020-02-17 21:17:06 +00:00
2020-02-17 21:19:57 +00:00
</div>
</div>
<a class="anchor" id="aff769c2ea4c3562329270a1d701d154f"></a><!-- doxytag: member="xercesc::DOMStringList::~DOMStringList" ref="aff769c2ea4c3562329270a1d701d154f" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
2020-02-17 21:17:06 +00:00
<tr>
2020-02-17 21:19:57 +00:00
<td class="memname">virtual xercesc::DOMStringList::~DOMStringList </td>
<td>(</td>
2020-02-17 21:22:42 +00:00
<td class="paramname"></td><td>)</td>
2020-02-17 21:19:57 +00:00
<td><code> [inline, virtual]</code></td>
2020-02-17 21:17:06 +00:00
</tr>
</table>
2020-02-17 21:19:57 +00:00
</div>
<div class="memdoc">
2020-02-17 21:17:06 +00:00
2020-02-17 21:19:57 +00:00
<p>Destructor. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a7a1f738b927608dc7b33ce32b5c7a3e6"></a><!-- doxytag: member="xercesc::DOMStringList::contains" ref="a7a1f738b927608dc7b33ce32b5c7a3e6" args="(const XMLCh *) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
2020-02-17 21:17:06 +00:00
<tr>
2020-02-17 21:19:57 +00:00
<td class="memname">virtual bool xercesc::DOMStringList::contains </td>
<td>(</td>
2020-02-17 21:22:42 +00:00
<td class="paramtype">const XMLCh *&#160;</td>
<td class="paramname"></td><td>)</td>
2020-02-17 21:19:57 +00:00
<td> const<code> [pure virtual]</code></td>
2020-02-17 21:17:06 +00:00
</tr>
</table>
2020-02-17 21:19:57 +00:00
</div>
<div class="memdoc">
2020-02-17 21:17:06 +00:00
2020-02-17 21:22:42 +00:00
<p>Test if a string is part of this <a class="el" href="classxercesc_1_1DOMStringList.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>
2020-02-17 21:19:57 +00:00
<dl class="return"><dt><b>Returns:</b></dt><dd><code>true</code> if the string has been found, <code>false</code> otherwise.</dd></dl>
<dl class="since"><dt><b>Since:</b></dt><dd>DOM Level 3 </dd></dl>
</div>
</div>
<a class="anchor" id="a269486b8136603a3ac3698da66755455"></a><!-- doxytag: member="xercesc::DOMStringList::getLength" ref="a269486b8136603a3ac3698da66755455" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
2020-02-17 21:17:06 +00:00
<tr>
2020-02-17 21:19:57 +00:00
<td class="memname">virtual XMLSize_t xercesc::DOMStringList::getLength </td>
<td>(</td>
2020-02-17 21:22:42 +00:00
<td class="paramname"></td><td>)</td>
2020-02-17 21:19:57 +00:00
<td> const<code> [pure virtual]</code></td>
2020-02-17 21:17:06 +00:00
</tr>
</table>
2020-02-17 21:19:57 +00:00
</div>
<div class="memdoc">
2020-02-17 21:17:06 +00:00
2020-02-17 21:19:57 +00:00
<p>Returns the number of strings in the list. </p>
<p>The range of valid child node indices is 0 to <code>length-1</code> inclusive.</p>
<dl class="since"><dt><b>Since:</b></dt><dd>DOM Level 3 </dd></dl>
</div>
</div>
<a class="anchor" id="adfc5ea722d290b1dabe3c4fa72eae4a6"></a><!-- doxytag: member="xercesc::DOMStringList::item" ref="adfc5ea722d290b1dabe3c4fa72eae4a6" args="(XMLSize_t index) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
2020-02-17 21:17:06 +00:00
<tr>
2020-02-17 21:19:57 +00:00
<td class="memname">virtual const XMLCh* xercesc::DOMStringList::item </td>
<td>(</td>
2020-02-17 21:22:42 +00:00
<td class="paramtype">XMLSize_t&#160;</td>
<td class="paramname"><em>index</em></td><td>)</td>
2020-02-17 21:19:57 +00:00
<td> const<code> [pure virtual]</code></td>
2020-02-17 21:17:06 +00:00
</tr>
</table>
2020-02-17 21:19:57 +00:00
</div>
<div class="memdoc">
2020-02-17 21:17:06 +00:00
2020-02-17 21:19:57 +00:00
<p>Returns the <code>index</code> item in the collection. </p>
<p>If <code>index</code> is greater than or equal to the number of strings in the list, this returns <code>null</code>.</p>
<dl><dt><b>Parameters:</b></dt><dd>
2020-02-17 21:22:42 +00:00
<table class="params">
<tr><td class="paramname">index</td><td>Index into the collection. </td></tr>
2020-02-17 21:19:08 +00:00
</table>
2020-02-17 21:19:57 +00:00
</dd>
2020-02-17 21:19:08 +00:00
</dl>
2020-02-17 21:22:42 +00:00
<dl class="return"><dt><b>Returns:</b></dt><dd>The string at the <code>index</code>th position in the <code><a class="el" href="classxercesc_1_1DOMStringList.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>
2020-02-17 21:19:57 +00:00
<dl class="since"><dt><b>Since:</b></dt><dd>DOM Level 3 </dd></dl>
</div>
</div>
<a class="anchor" id="a9f8128dbe51906785ee9a76397e74ebf"></a><!-- doxytag: member="xercesc::DOMStringList::release" ref="a9f8128dbe51906785ee9a76397e74ebf" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
2020-02-17 21:17:06 +00:00
<tr>
2020-02-17 21:19:57 +00:00
<td class="memname">virtual void xercesc::DOMStringList::release </td>
<td>(</td>
2020-02-17 21:22:42 +00:00
<td class="paramname"></td><td>)</td>
2020-02-17 21:19:57 +00:00
<td><code> [pure virtual]</code></td>
2020-02-17 21:17:06 +00:00
</tr>
</table>
2020-02-17 21:19:57 +00:00
</div>
<div class="memdoc">
2020-02-17 21:17:06 +00:00
2020-02-17 21:19:57 +00:00
<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>
<p>Access to a released object will lead to unexpected result. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="DOMStringList_8hpp_source.html">DOMStringList.hpp</a></li>
</ul>
</div>
2020-02-17 21:22:42 +00:00
<hr class="footer"/><address class="footer"><small>Generated on Mon Oct 31 2011 19:08:37 for XQilla DOM Level 3 API by&#160;
2020-02-17 21:17:06 +00:00
<a href="http://www.doxygen.org/index.html">
2020-02-17 21:22:42 +00:00
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </small></address>
2020-02-17 21:17:06 +00:00
</body>
</html>