blob: 1bbe69f02d3a7483f0e3868dfdf12caa93fdb4ef [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Xalan-C++ API : Main Page</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<!-- The head section is copied from Doxygen 1.7.1 generated default output -->
<body>
<h2 align="center">Xalan-C++ API Documentation</h2>
<h3 align="center"><a href="../index.html">The Xalan C++ XSLT Processor Version 1.11</a></h3>
<hr/>
<!-- Generated by Doxygen 1.7.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
<li><a href="pages.html"><span>Related&nbsp;Pages</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>
</ul>
</div>
<div class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
<li><a href="classes.html"><span>Class&nbsp;Index</span></a></li>
<li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-attribs">Static Public Attributes</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> </div>
<div class="headertitle">
<h1>NodeRefListBase Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="NodeRefListBase" -->
<p>Local implementation of <a class="el" href="classNodeRefList.html" title="Local implementation of NodeRefList.">NodeRefList</a>.
<a href="#_details">More...</a></p>
<p><code>#include &lt;<a class="el" href="NodeRefListBase_8hpp_source.html">NodeRefListBase.hpp</a>&gt;</code></p>
<p>Inherited by <a class="el" href="classNodeRefList.html">NodeRefList</a>, <a class="el" href="classXalanDocumentFragmentNodeRefListBaseProxy.html">XalanDocumentFragmentNodeRefListBaseProxy</a>, and <a class="el" href="classXNodeSetNodeProxy_1_1Proxy.html">XNodeSetNodeProxy::Proxy</a>.</p>
<p><a href="classNodeRefListBase-members.html">List of all members.</a></p>
<h2><a name="pub-types"></a>
Public Types</h2>
<ul>
<li>typedef XalanSize_t <a class="el" href="classNodeRefListBase.html#a4a4343b0f47a5f789bb00f5fb3556337">size_type</a>
</ul>
<h2><a name="pub-methods"></a>
Public Member Functions</h2>
<ul>
<li><a class="el" href="classNodeRefListBase.html#aedac2ab1636463e33f6541df173d9765">NodeRefListBase</a> ()
<li>virtual <a class="el" href="classNodeRefListBase.html#a665d30b7998dc9eda63cad79f2cd6cb8">~NodeRefListBase</a> ()
<li>virtual <a class="el" href="classXalanNode.html">XalanNode</a> * <a class="el" href="classNodeRefListBase.html#af7d09fe70245ed1f46a6bb2cc19b9beb">item</a> (<a class="el" href="classNodeRefListBase.html#a4a4343b0f47a5f789bb00f5fb3556337">size_type</a> index) const =0
<dl class="el"><dd class="mdescRight">Returns the <code>index</code>th item in the collection. <a href="#af7d09fe70245ed1f46a6bb2cc19b9beb"></a><br/></dl><li>virtual <a class="el" href="classNodeRefListBase.html#a4a4343b0f47a5f789bb00f5fb3556337">size_type</a> <a class="el" href="classNodeRefListBase.html#a11a496f0763708e15d10808732c97085">getLength</a> () const =0
<dl class="el"><dd class="mdescRight">Determine the number of nodes in the list. <a href="#a11a496f0763708e15d10808732c97085"></a><br/></dl><li>virtual <a class="el" href="classNodeRefListBase.html#a4a4343b0f47a5f789bb00f5fb3556337">size_type</a> <a class="el" href="classNodeRefListBase.html#a1e52907f4dc98047befa9686b9fd176e">indexOf</a> (const <a class="el" href="classXalanNode.html">XalanNode</a> *theNode) const =0
<dl class="el"><dd class="mdescRight">Retrieve the zero based index of the node in the list. <a href="#a1e52907f4dc98047befa9686b9fd176e"></a><br/></dl></ul>
<h2><a name="pub-static-attribs"></a>
Static Public Attributes</h2>
<ul>
<li>static const <a class="el" href="classNodeRefListBase.html#a4a4343b0f47a5f789bb00f5fb3556337">size_type</a> <a class="el" href="classNodeRefListBase.html#a2a9a63deb601f6b10897667488c4e6b5">npos</a>
</ul>
<h2><a name="pro-methods"></a>
Protected Member Functions</h2>
<ul>
<li><a class="el" href="classNodeRefListBase.html#a66717ab877a33d52927c90eb32f625e0">NodeRefListBase</a> (const <a class="el" href="classNodeRefListBase.html">NodeRefListBase</a> &amp;)
<li><a class="el" href="classNodeRefListBase.html">NodeRefListBase</a> &amp; <a class="el" href="classNodeRefListBase.html#a093a6ac4a7a9734439f4ad383f6ee2ed">operator=</a> (const <a class="el" href="classNodeRefListBase.html">NodeRefListBase</a> &amp;)
</ul>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Local implementation of <a class="el" href="classNodeRefList.html" title="Local implementation of NodeRefList.">NodeRefList</a>. </p>
<p>This class is for internal use only. </p>
<p>Definition at line <a class="el" href="NodeRefListBase_8hpp_source.html#l00044">44</a> of file <a class="el" href="NodeRefListBase_8hpp_source.html">NodeRefListBase.hpp</a>.</p>
<hr/><h2>Member Typedef Documentation</h2>
<a class="anchor" id="a4a4343b0f47a5f789bb00f5fb3556337"></a><!-- doxytag: member="NodeRefListBase::size_type" ref="a4a4343b0f47a5f789bb00f5fb3556337" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef XalanSize_t <a class="el" href="classNodeRefListBase.html#a4a4343b0f47a5f789bb00f5fb3556337">NodeRefListBase::size_type</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="NodeRefListBase_8hpp_source.html#l00053">53</a> of file <a class="el" href="NodeRefListBase_8hpp_source.html">NodeRefListBase.hpp</a>.</p>
</div>
</div>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="aedac2ab1636463e33f6541df173d9765"></a><!-- doxytag: member="NodeRefListBase::NodeRefListBase" ref="aedac2ab1636463e33f6541df173d9765" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">NodeRefListBase::NodeRefListBase </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a665d30b7998dc9eda63cad79f2cd6cb8"></a><!-- doxytag: member="NodeRefListBase::~NodeRefListBase" ref="a665d30b7998dc9eda63cad79f2cd6cb8" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual NodeRefListBase::~NodeRefListBase </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a66717ab877a33d52927c90eb32f625e0"></a><!-- doxytag: member="NodeRefListBase::NodeRefListBase" ref="a66717ab877a33d52927c90eb32f625e0" args="(const NodeRefListBase &amp;)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">NodeRefListBase::NodeRefListBase </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classNodeRefListBase.html">NodeRefListBase</a> &amp;&nbsp;</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [inline, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="NodeRefListBase_8hpp_source.html#l00094">94</a> of file <a class="el" href="NodeRefListBase_8hpp_source.html">NodeRefListBase.hpp</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a11a496f0763708e15d10808732c97085"></a><!-- doxytag: member="NodeRefListBase::getLength" ref="a11a496f0763708e15d10808732c97085" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classNodeRefListBase.html#a4a4343b0f47a5f789bb00f5fb3556337">size_type</a> NodeRefListBase::getLength </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Determine the number of nodes in the list. </p>
<p>The range of valid child node indices is 0 to <code>length-1</code> inclusive.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>number of nodes </dd></dl>
<p>Implemented in <a class="el" href="classNodeRefList.html#a8b3fe14e12e239d91a7209877978b219">NodeRefList</a>, <a class="el" href="classXalanDocumentFragmentNodeRefListBaseProxy.html#a0e485501089e247c2eaade75f3af202a">XalanDocumentFragmentNodeRefListBaseProxy</a>, and <a class="el" href="classXNodeSetNodeProxy_1_1Proxy.html#a33c0c00a56cf598705b25ca229b32d5e">XNodeSetNodeProxy::Proxy</a>.</p>
</div>
</div>
<a class="anchor" id="a1e52907f4dc98047befa9686b9fd176e"></a><!-- doxytag: member="NodeRefListBase::indexOf" ref="a1e52907f4dc98047befa9686b9fd176e" args="(const XalanNode *theNode) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classNodeRefListBase.html#a4a4343b0f47a5f789bb00f5fb3556337">size_type</a> NodeRefListBase::indexOf </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classXalanNode.html">XalanNode</a> *&nbsp;</td>
<td class="paramname"> <em>theNode</em></td>
<td>&nbsp;)&nbsp;</td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Retrieve the zero based index of the node in the list. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>theNode</em>&nbsp;</td><td>node whose index to find </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>index of node </dd></dl>
<p>Implemented in <a class="el" href="classNodeRefList.html#a5ef85db20fd9f8a80ad13771c67e7294">NodeRefList</a>, <a class="el" href="classXalanDocumentFragmentNodeRefListBaseProxy.html#a21a04bc0e10e03380938ac0c65ee2dfd">XalanDocumentFragmentNodeRefListBaseProxy</a>, and <a class="el" href="classXNodeSetNodeProxy_1_1Proxy.html#a604158ec7a2974cf78608e10197b910d">XNodeSetNodeProxy::Proxy</a>.</p>
</div>
</div>
<a class="anchor" id="af7d09fe70245ed1f46a6bb2cc19b9beb"></a><!-- doxytag: member="NodeRefListBase::item" ref="af7d09fe70245ed1f46a6bb2cc19b9beb" args="(size_type index) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classXalanNode.html">XalanNode</a>* NodeRefListBase::item </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classNodeRefListBase.html#a4a4343b0f47a5f789bb00f5fb3556337">size_type</a>&nbsp;</td>
<td class="paramname"> <em>index</em></td>
<td>&nbsp;)&nbsp;</td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the <code>index</code>th item in the collection. </p>
<p>If <code>index</code> is greater than or equal to the number of nodes in the list, this returns <code>null</code>.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>index</em>&nbsp;</td><td>index into the collection </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><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 </dd></dl>
<p>Implemented in <a class="el" href="classNodeRefList.html#ae99fb9250b3a955ac965bbd84fe2400f">NodeRefList</a>, <a class="el" href="classXalanDocumentFragmentNodeRefListBaseProxy.html#aa40b788b13cd1a8fa058207e3987f244">XalanDocumentFragmentNodeRefListBaseProxy</a>, and <a class="el" href="classXNodeSetNodeProxy_1_1Proxy.html#a818641e8de274e221732eae928a79498">XNodeSetNodeProxy::Proxy</a>.</p>
</div>
</div>
<a class="anchor" id="a093a6ac4a7a9734439f4ad383f6ee2ed"></a><!-- doxytag: member="NodeRefListBase::operator=" ref="a093a6ac4a7a9734439f4ad383f6ee2ed" args="(const NodeRefListBase &amp;)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classNodeRefListBase.html">NodeRefListBase</a>&amp; NodeRefListBase::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classNodeRefListBase.html">NodeRefListBase</a> &amp;&nbsp;</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [inline, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reimplemented in <a class="el" href="classMutableNodeRefList.html#a327161d145133a9cdf67307010428582">MutableNodeRefList</a>, and <a class="el" href="classNodeRefList.html#a8e9969b57f09b4eed03822d5fa8d2728">NodeRefList</a>.</p>
<p>Definition at line <a class="el" href="NodeRefListBase_8hpp_source.html#l00099">99</a> of file <a class="el" href="NodeRefListBase_8hpp_source.html">NodeRefListBase.hpp</a>.</p>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="a2a9a63deb601f6b10897667488c4e6b5"></a><!-- doxytag: member="NodeRefListBase::npos" ref="a2a9a63deb601f6b10897667488c4e6b5" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classNodeRefListBase.html#a4a4343b0f47a5f789bb00f5fb3556337">size_type</a> <a class="el" href="classNodeRefListBase.html#a2a9a63deb601f6b10897667488c4e6b5">NodeRefListBase::npos</a><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="NodeRefListBase_8hpp_source.html#l00089">89</a> of file <a class="el" href="NodeRefListBase_8hpp_source.html">NodeRefListBase.hpp</a>.</p>
</div>
</div>
<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></li>
</ul>
</div>
<p align="center"><a href="graph_legend.html">Interpreting class diagrams</a></p>
<p><font color="#000000" face="arial,helvetica,sanserif" size="-1">
<i><a href="http://www.doxygen.org/">Doxygen</a> and
<a href="http://www.graphviz.org/">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="80%">
<tr>
<td width="80%" valign="top">
<p align="center"><b>Xalan-C++ XSLT Processor Version 1.11</b><br/>
Copyright &copy; 1999-2012 The Apache Software Foundation.<br/>
All Rights Reserved.</p>
</td>
</tr>
<tr>
<td width="100%">
<p align="center"><img src="asf_logo_wide.gif" width="268" height="25" align="bottom" border="0" alt="Apache Logo">
</td>
</tr>
</table>
</body>
</html>