blob: eeac11b785b0234402720625b1062607e75308d1 [file] [log] [blame]
<HTML><HEAD><TITLE>Xalan-C++ API Documentation</TITLE></HEAD>
<BODY>
<h2 align="center">Xalan-C++ API Documentation</h2>
<h3 align="center">The Xalan C++ XSLT Processor Version 1.10</h3>
</BODY>
<!-- Generated by Doxygen 1.2.8.1 -->
<center>
<a class="qindex" href="index.html">Main Page</a> &nbsp; <a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; <a class="qindex" href="classes.html">Alphabetical List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
<hr><h1>NodeRefListBase Class Reference</h1>Local implementation of <a class="el" href="classNodeRefList.html">NodeRefList</a>.
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="NodeRefListBase_8hpp-source.html">NodeRefListBase.hpp</a>&gt;</code>
<p>
Inheritance diagram for NodeRefListBase:<p><center><img src="classNodeRefListBase__inherit__graph.gif" border="0" usemap="#NodeRefListBase_inherit_map" alt="Inheritance graph"></center>
<map name="NodeRefListBase_inherit_map">
<area href="classNodeRefList.html" shape="rect" coords="30,117,116,93">
<area href="classXalanDocumentFragmentNodeRefListBaseProxy.html" shape="rect" coords="140,117,433,93">
<area href="classXNodeSetNodeProxy_1_1Proxy.html" shape="rect" coords="457,117,633,93">
<area href="classMutableNodeRefList.html" shape="rect" coords="6,192,140,168">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classNodeRefListBase-members.html">List of all members.</a><h2>Public Types</h2>
<ul>
<li>typedef unsigned int <a class="el" href="classNodeRefListBase.html#s0">size_type</a>
</ul>
<h2>Public Methods</h2>
<ul>
<li><a class="el" href="classNodeRefListBase.html#a0">NodeRefListBase</a> ()
<li>virtual <a class="el" href="classNodeRefListBase.html#a1">~NodeRefListBase</a> ()
<li>virtual <a class="el" href="classXalanNode.html">XalanNode</a>* <a class="el" href="classNodeRefListBase.html#a2">item</a> (<a class="el" href="classNodeRefListBase.html#s0">size_type</a> index) const=0
<dl class="el"><dd><font size=-1><em>Returns the <code>index</code>th item in the collection.</em> <a href="#a2">More...</a><em><br><br></em></font></dl><li>virtual <a class="el" href="classNodeRefListBase.html#s0">size_type</a> <a class="el" href="classNodeRefListBase.html#a3">getLength</a> () const=0
<dl class="el"><dd><font size=-1><em>Determine the number of nodes in the list.</em> <a href="#a3">More...</a><em><br><br></em></font></dl><li>virtual <a class="el" href="classNodeRefListBase.html#s0">size_type</a> <a class="el" href="classNodeRefListBase.html#a4">indexOf</a> (const <a class="el" href="classXalanNode.html">XalanNode</a> *theNode) const=0
<dl class="el"><dd><font size=-1><em>Retrieve the zero based index of the node in the list.</em> <a href="#a4">More...</a><em><br><br></em></font></dl></ul>
<h2>Static Public Attributes</h2>
<ul>
<li>const <a class="el" href="classNodeRefListBase.html#s0">size_type</a> <a class="el" href="classNodeRefListBase.html#p0">npos</a>
</ul>
<h2>Protected Methods</h2>
<ul>
<li><a class="el" href="classNodeRefListBase.html#b0">NodeRefListBase</a> (const NodeRefListBase &amp;)
<li>NodeRefListBase&amp; <a class="el" href="classNodeRefListBase.html#b1">operator=</a> (const NodeRefListBase &amp;)
</ul>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Local implementation of <a class="el" href="classNodeRefList.html">NodeRefList</a>.
<p>
This class is for internal use only.
<p>
<hr><h2>Member Typedef Documentation</h2>
<a name="s0" doxytag="NodeRefListBase::size_type"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
typedef unsigned int NodeRefListBase::size_type
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a name="a0" doxytag="NodeRefListBase::NodeRefListBase"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
NodeRefListBase::NodeRefListBase (
</b></td>
<td valign="bottom"><b>
)
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a1" doxytag="NodeRefListBase::~NodeRefListBase"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
NodeRefListBase::~NodeRefListBase (
</b></td>
<td valign="bottom"><b>
)<code> [virtual]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="b0" doxytag="NodeRefListBase::NodeRefListBase"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
NodeRefListBase::NodeRefListBase (
</b></td>
<td valign="bottom"><b>
const NodeRefListBase &amp;&nbsp;)<code> [protected]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a name="a3" doxytag="NodeRefListBase::getLength"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
<a class="el" href="classNodeRefListBase.html#s0">size_type</a> NodeRefListBase::getLength (
</b></td>
<td valign="bottom"><b>
) const<code> [pure virtual]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Determine the number of nodes in the list.
<p>
The range of valid child node indices is 0 to <code>length-1</code> inclusive.
<p>
<dl compact><dt>
<b>Returns: </b><dd>
number of nodes </dl>
<p>
Reimplemented in <a class="el" href="classNodeRefList.html#a9">NodeRefList</a>, <a class="el" href="classXalanDocumentFragmentNodeRefListBaseProxy.html#a4">XalanDocumentFragmentNodeRefListBaseProxy</a>, and <a class="el" href="classXNodeSetNodeProxy_1_1Proxy.html#a3">XNodeSetNodeProxy::Proxy</a>. </td>
</tr>
</table>
<a name="a4" doxytag="NodeRefListBase::indexOf"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
<a class="el" href="classNodeRefListBase.html#s0">size_type</a> NodeRefListBase::indexOf (
</b></td>
<td valign="bottom"><b>
const <a class="el" href="classXalanNode.html">XalanNode</a> * <em>theNode</em>&nbsp;) const<code> [pure virtual]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Retrieve the zero based index of the node in the list.
<p>
<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>theNode</em>
&nbsp;</td><td>
node whose index to find </td></tr>
</table>
</dl><dl compact><dt>
<b>Returns: </b><dd>
index of node </dl>
<p>
Reimplemented in <a class="el" href="classNodeRefList.html#a10">NodeRefList</a>, <a class="el" href="classXalanDocumentFragmentNodeRefListBaseProxy.html#a5">XalanDocumentFragmentNodeRefListBaseProxy</a>, and <a class="el" href="classXNodeSetNodeProxy_1_1Proxy.html#a4">XNodeSetNodeProxy::Proxy</a>. </td>
</tr>
</table>
<a name="a2" doxytag="NodeRefListBase::item"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
<a class="el" href="classXalanNode.html">XalanNode</a> * NodeRefListBase::item (
</b></td>
<td valign="bottom"><b>
<a class="el" href="classNodeRefListBase.html#s0">size_type</a> <em>index</em>&nbsp;) const<code> [pure virtual]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Returns the <code>index</code>th item in the collection.
<p>
If <code>index</code> is greater than or equal to the number of nodes in the list, this returns <code>null</code>.<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>index</em>
&nbsp;</td><td>
index into the collection </td></tr>
</table>
</dl><dl compact><dt>
<b>Returns: </b><dd>
node at the <code>index</code>th position in the <code>NodeList</code>, or <code>null</code> if that is not a valid index </dl>
<p>
Reimplemented in <a class="el" href="classNodeRefList.html#a8">NodeRefList</a>, <a class="el" href="classXalanDocumentFragmentNodeRefListBaseProxy.html#a3">XalanDocumentFragmentNodeRefListBaseProxy</a>, and <a class="el" href="classXNodeSetNodeProxy_1_1Proxy.html#a2">XNodeSetNodeProxy::Proxy</a>. </td>
</tr>
</table>
<a name="b1" doxytag="NodeRefListBase::operator="></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
NodeRefListBase &amp; NodeRefListBase::operator= (
</b></td>
<td valign="bottom"><b>
const NodeRefListBase &amp; <em>theRHS</em>&nbsp;)<code> [protected]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
<p>
Reimplemented in <a class="el" href="classMutableNodeRefList.html#a6">MutableNodeRefList</a>, and <a class="el" href="classNodeRefList.html#a5">NodeRefList</a>. </td>
</tr>
</table>
<hr><h2>Member Data Documentation</h2>
<a name="p0" doxytag="NodeRefListBase::npos"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
const <a class="el" href="classNodeRefListBase.html#s0">size_type</a> NodeRefListBase::npos<code> [static]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="NodeRefListBase_8hpp-source.html">NodeRefListBase.hpp</a></ul>
<p align="center"><a href="diagramnotes.html">Interpreting class diagrams</a></p>
<p><FONT color="#000000" face="arial,helvetica,sanserif" size="-1">
<i><A href="http://www.stack.nl/~dimitri/doxygen/">Doxygen</A> and
<A href="http://www.research.att.com/sw/tools/graphviz/">GraphViz</A> are used to generate this API documentation from the Xalan-C header files.</I></FONT></p>
<TABLE border="0" cellpadding="0" cellspacing="0" width="820"><TR><TD bgcolor="#0086b2"><IMG height="1" src="../resources/dot.gif" width="1" alt="dot"></TD></TR></TABLE>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" WIDTH="80%">
<TR>
<TD WIDTH="80%" VALIGN="TOP">
<P ALIGN="CENTER"><B>Xalan-C++ XSLT Processor Version 1.10</B><BR>
Copyright &copy; 1999-2004 The Apache Software Foundation. All Rights Reserved.</i></p>
</TD>
</TR>
<TR>
<TD WIDTH="100%">
<P ALIGN="CENTER"><IMG SRC="ApacheLogo.jpg" WIDTH="387" HEIGHT="100" ALIGN="BOTTOM" BORDER="0" ALT="Apache Logo">
</TD>
</TR>
</TABLE>