240 lines
12 KiB
HTML
240 lines
12 KiB
HTML
<!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&type=2" border="0" alt="SourceForge.net Logo" /></a>
|
|
<!-- Generated by Doxygen 1.3.9.1 -->
|
|
<div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical List</a> | <a class="qindex" href="annotated.html">Class List</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="namespacemembers.html">Namespace Members</a> | <a class="qindex" href="functions.html">Class Members</a> | <a class="qindex" href="globals.html">File Members</a> | <a class="qindex" href="examples.html">Examples</a></div>
|
|
<h1>xercesc::DOMStringList Class Reference</h1>The <code><a class="el" href="classxercesc_1_1DOMStringList.html">DOMStringList</a></code> interface provides the abstraction of an ordered collection of strings, without defining or constraining how this collection is implemented.
|
|
<a href="#_details">More...</a>
|
|
<p>
|
|
<code>#include <<a class="el" href="DOMStringList_8hpp-source.html">DOMStringList.hpp</a>></code>
|
|
<p>
|
|
<a href="classxercesc_1_1DOMStringList-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
|
|
<tr><td></td></tr>
|
|
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
|
|
<tr><td colspan="2"><div class="groupHeader">Destructor</div></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMStringList.html#z421_0">~DOMStringList</a> ()</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#z421_0"></a><br></td></tr>
|
|
<tr><td colspan="2"><div class="groupHeader">Functions introduced in DOM Level 3</div></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const XMLCh * </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMStringList.html#z423_0">item</a> (XMLSize_t index) const =0</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the <code>index</code> item in the collection. <a href="#z423_0"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual XMLSize_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMStringList.html#z423_1">getLength</a> () const =0</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of strings in the list. <a href="#z423_1"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMStringList.html#z423_2">contains</a> (const XMLCh *) const =0</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Test if a string is part of this <a class="el" href="classxercesc_1_1DOMStringList.html">DOMStringList</a>. <a href="#z423_2"></a><br></td></tr>
|
|
<tr><td colspan="2"><div class="groupHeader">Non-standard Extension</div></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMStringList.html#z425_0">release</a> ()=0</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </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="#z425_0"></a><br></td></tr>
|
|
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
|
|
<tr><td colspan="2"><div class="groupHeader">Hidden constructors</div></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMStringList.html#z417_0">DOMStringList</a> ()</td></tr>
|
|
|
|
</table>
|
|
<hr><a name="_details"></a><h2>Detailed Description</h2>
|
|
The <code><a class="el" href="classxercesc_1_1DOMStringList.html">DOMStringList</a></code> interface provides the abstraction of an ordered collection of strings, without defining or constraining how this collection is implemented.
|
|
<p>
|
|
The items in the <code><a class="el" href="classxercesc_1_1DOMStringList.html">DOMStringList</a></code> are accessible via an integral index, starting from 0.
|
|
<p>
|
|
<hr><h2>Constructor & Destructor Documentation</h2>
|
|
<a class="anchor" name="z417_0" doxytag="xercesc::DOMStringList::DOMStringList"></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">xercesc::DOMStringList::DOMStringList </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="mdname1" valign="top" nowrap> </td>
|
|
<td class="md" valign="top"> ) </td>
|
|
<td class="md" nowrap><code> [inline, protected]</code></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="z421_0" doxytag="xercesc::DOMStringList::~DOMStringList"></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">virtual xercesc::DOMStringList::~<a class="el" href="classxercesc_1_1DOMStringList.html">DOMStringList</a> </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="mdname1" valign="top" nowrap> </td>
|
|
<td class="md" valign="top"> ) </td>
|
|
<td class="md" nowrap><code> [inline, virtual]</code></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Destructor.
|
|
<p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<hr><h2>Member Function Documentation</h2>
|
|
<a class="anchor" name="z423_2" doxytag="xercesc::DOMStringList::contains"></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">virtual bool xercesc::DOMStringList::contains </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top">const XMLCh * </td>
|
|
<td class="mdname1" valign="top" nowrap> </td>
|
|
<td class="md" valign="top"> ) </td>
|
|
<td class="md" nowrap> const<code> [pure virtual]</code></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Test if a string is part of this <a class="el" href="classxercesc_1_1DOMStringList.html">DOMStringList</a>.
|
|
<p>
|
|
<dl compact><dt><b>Returns:</b></dt><dd><code>true</code> if the string has been found, <code>false</code> otherwise.</dd></dl>
|
|
<dl compact><dt><b>Since:</b></dt><dd>DOM Level 3 </dd></dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="z423_1" doxytag="xercesc::DOMStringList::getLength"></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">virtual XMLSize_t xercesc::DOMStringList::getLength </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="mdname1" valign="top" nowrap> </td>
|
|
<td class="md" valign="top"> ) </td>
|
|
<td class="md" nowrap> const<code> [pure virtual]</code></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Returns the number of strings in the list.
|
|
<p>
|
|
The range of valid child node indices is 0 to <code>length-1</code> inclusive.<p>
|
|
<dl compact><dt><b>Since:</b></dt><dd>DOM Level 3 </dd></dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="z423_0" doxytag="xercesc::DOMStringList::item"></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">virtual const XMLCh* xercesc::DOMStringList::item </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top">XMLSize_t </td>
|
|
<td class="mdname1" valign="top" nowrap> <em>index</em> </td>
|
|
<td class="md" valign="top"> ) </td>
|
|
<td class="md" nowrap> const<code> [pure virtual]</code></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Returns the <code>index</code> item in the collection.
|
|
<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 compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>index</em> </td><td>Index into the collection. </td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl compact><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">DOMStringList</a></code>, or <code>null</code> if that is not a valid index. </dd></dl>
|
|
<dl compact><dt><b>Since:</b></dt><dd>DOM Level 3 </dd></dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="z425_0" doxytag="xercesc::DOMStringList::release"></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">virtual void xercesc::DOMStringList::release </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="mdname1" valign="top" nowrap> </td>
|
|
<td class="md" valign="top"> ) </td>
|
|
<td class="md" nowrap><code> [pure virtual]</code></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<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>
|
|
Access to a released object will lead to unexpected result. </td>
|
|
</tr>
|
|
</table>
|
|
<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></ul>
|
|
<hr size="1"><address style="align: right;"><small>Generated on Fri Sep 25 06:55:56 2009 for XQilla DOM Level 3 API by
|
|
<a href="http://www.doxygen.org/index.html">
|
|
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.3.9.1 </small></address>
|
|
</body>
|
|
</html>
|