Sophie

Sophie

distrib > Mandriva > 2010.0 > i586 > media > contrib-release > by-pkgid > bad97183153701b09df5fae1052b1c30 > files > 264

crystalspace-doc-1.2.1-5mdv2010.0.i586.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>Crystal Space 1.2.1: csArray&lt; T, ElementHandler, MemoryAllocator, CapacityHandler &gt;::Iterator Class Reference (Crystal Space 1.2.1 Public API Reference)</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<table border="0" cellpadding="0" cellspacing="0" width="100%" class="head">
 <tr height="59">
  <td class="head" width="202" valign="bottom" style="padding-left:0;"><a href="http://www.crystalspace3d.org/"><img src="csblur.png" width="236" height="59" alt="CrystalSpace" border="0"></a></td>
  <td class="head"><h2>Public API Reference</h2></td>
 </tr>
 <tr height="11">
  <td colspan="2" class="headshadow" valign="top" style="padding-left:0;"><img src="csblurb.png" width="236" height="11" alt="" border="0"></td>
 </tr>
</table>
<div class="content">
<!-- Generated by Doxygen 1.5.3 -->
<div class="tabs">
  <ul>
    <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
    <li><a href="modules.html"><span>Modules</span></a></li>
    <li><a href="namespaces.html"><span>Namespaces</span></a></li>
    <li class="current"><a href="classes.html"><span>Classes</span></a></li>
    <li><a href="files.html"><span>Files</span></a></li>
    <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
  </ul>
</div>
<div class="tabs">
  <ul>
    <li><a href="classes.html"><span>Alphabetical&nbsp;List</span></a></li>
    <li><a href="annotated.html"><span>Class&nbsp;List</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 class="nav">
<a class="el" href="classcsArray.html">csArray</a>::<a class="el" href="classcsArray_1_1Iterator.html">Iterator</a></div>
<h1>csArray&lt; T, ElementHandler, MemoryAllocator, CapacityHandler &gt;::Iterator Class Reference</h1><!-- doxytag: class="csArray::Iterator" --><a class="el" href="classcsArray_1_1Iterator.html" title="Iterator for the Array&lt;&gt; class.">Iterator</a> for the Array&lt;&gt; class.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="csutil_2array_8h-source.html">csutil/array.h</a>&gt;</code>
<p>

<p>
<a href="classcsArray_1_1Iterator-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 class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsArray_1_1Iterator.html#d7a2da9d2ef978fb5d14a6a749b0ea13">HasNext</a> () const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns true if the next <a class="el" href="classcsArray_1_1Iterator.html#a83db1103b09caff76e6c7493feb0629" title="Returns the next element in the array.">Next()</a> call will return an element.  <a href="#d7a2da9d2ef978fb5d14a6a749b0ea13"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsArray_1_1Iterator.html#0b8a3448f379841606849b1d9af27fcc">Iterator</a> (<a class="el" href="classcsArray_1_1Iterator.html">Iterator</a> const &amp;r)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Copy constructor.  <a href="#0b8a3448f379841606849b1d9af27fcc"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">T &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsArray_1_1Iterator.html#a83db1103b09caff76e6c7493feb0629">Next</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the next element in the array.  <a href="#a83db1103b09caff76e6c7493feb0629"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classcsArray_1_1Iterator.html">Iterator</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsArray_1_1Iterator.html#fb4c4cd108c00d5905fc6fbd904e44e9">operator=</a> (<a class="el" href="classcsArray_1_1Iterator.html">Iterator</a> const &amp;r)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Assignment operator.  <a href="#fb4c4cd108c00d5905fc6fbd904e44e9"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsArray_1_1Iterator.html#cbf17a1f1976be28c2538a858bdb955e">Reset</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Reset the array to the first element.  <a href="#cbf17a1f1976be28c2538a858bdb955e"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="60cedcab386bcf78f63f52253296806c"></a><!-- doxytag: member="csArray::Iterator::Iterator" ref="60cedcab386bcf78f63f52253296806c" args="(csArray&lt; T, ElementHandler, MemoryAllocator, CapacityHandler &gt; &amp;newarray)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsArray_1_1Iterator.html#60cedcab386bcf78f63f52253296806c">Iterator</a> (<a class="el" href="classcsArray.html">csArray</a>&lt; T, ElementHandler, MemoryAllocator, CapacityHandler &gt; &amp;newarray)</td></tr>

<tr><td colspan="2"><br><h2>Friends</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ff4f613b969d93508791c502b07831ee"></a><!-- doxytag: member="csArray::Iterator::csArray&lt; T, ElementHandler, MemoryAllocator, CapacityHandler &gt;" ref="ff4f613b969d93508791c502b07831ee" args="" -->
class&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsArray_1_1Iterator.html#ff4f613b969d93508791c502b07831ee">csArray&lt; T, ElementHandler, MemoryAllocator, CapacityHandler &gt;</a></td></tr>

</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<h3>template&lt;class T, class ElementHandler = csArrayElementHandler&lt;T&gt;, class MemoryAllocator = CS::Memory::AllocatorMalloc, class CapacityHandler = csArrayCapacityDefault&gt;<br>
 class csArray&lt; T, ElementHandler, MemoryAllocator, CapacityHandler &gt;::Iterator</h3>

<a class="el" href="classcsArray_1_1Iterator.html" title="Iterator for the Array&lt;&gt; class.">Iterator</a> for the Array&lt;&gt; class. 
<p>Definition at line <a class="el" href="csutil_2array_8h-source.html#l01074">1074</a> of file <a class="el" href="csutil_2array_8h-source.html">array.h</a>.</p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="0b8a3448f379841606849b1d9af27fcc"></a><!-- doxytag: member="csArray::Iterator::Iterator" ref="0b8a3448f379841606849b1d9af27fcc" args="(Iterator const &amp;r)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T, class ElementHandler = csArrayElementHandler&lt;T&gt;, class MemoryAllocator = CS::Memory::AllocatorMalloc, class CapacityHandler = csArrayCapacityDefault&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classcsArray.html">csArray</a>&lt; T, ElementHandler, MemoryAllocator, CapacityHandler &gt;::Iterator::Iterator           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classcsArray_1_1Iterator.html">Iterator</a> const &amp;&nbsp;</td>
          <td class="paramname"> <em>r</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Copy constructor. 
<p>

<p>Definition at line <a class="el" href="csutil_2array_8h-source.html#l01078">1078</a> of file <a class="el" href="csutil_2array_8h-source.html">array.h</a>.</p>

</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="d7a2da9d2ef978fb5d14a6a749b0ea13"></a><!-- doxytag: member="csArray::Iterator::HasNext" ref="d7a2da9d2ef978fb5d14a6a749b0ea13" args="() const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T, class ElementHandler = csArrayElementHandler&lt;T&gt;, class MemoryAllocator = CS::Memory::AllocatorMalloc, class CapacityHandler = csArrayCapacityDefault&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">bool <a class="el" href="classcsArray.html">csArray</a>&lt; T, ElementHandler, MemoryAllocator, CapacityHandler &gt;::Iterator::HasNext           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Returns true if the next <a class="el" href="classcsArray_1_1Iterator.html#a83db1103b09caff76e6c7493feb0629" title="Returns the next element in the array.">Next()</a> call will return an element. 
<p>

<p>Definition at line <a class="el" href="csutil_2array_8h-source.html#l01086">1086</a> of file <a class="el" href="csutil_2array_8h-source.html">array.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="a83db1103b09caff76e6c7493feb0629"></a><!-- doxytag: member="csArray::Iterator::Next" ref="a83db1103b09caff76e6c7493feb0629" args="()" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T, class ElementHandler = csArrayElementHandler&lt;T&gt;, class MemoryAllocator = CS::Memory::AllocatorMalloc, class CapacityHandler = csArrayCapacityDefault&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">T&amp; <a class="el" href="classcsArray.html">csArray</a>&lt; T, ElementHandler, MemoryAllocator, CapacityHandler &gt;::Iterator::Next           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Returns the next element in the array. 
<p>

<p>Definition at line <a class="el" href="csutil_2array_8h-source.html#l01090">1090</a> of file <a class="el" href="csutil_2array_8h-source.html">array.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="fb4c4cd108c00d5905fc6fbd904e44e9"></a><!-- doxytag: member="csArray::Iterator::operator=" ref="fb4c4cd108c00d5905fc6fbd904e44e9" args="(Iterator const &amp;r)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T, class ElementHandler = csArrayElementHandler&lt;T&gt;, class MemoryAllocator = CS::Memory::AllocatorMalloc, class CapacityHandler = csArrayCapacityDefault&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classcsArray_1_1Iterator.html">Iterator</a>&amp; <a class="el" href="classcsArray.html">csArray</a>&lt; T, ElementHandler, MemoryAllocator, CapacityHandler &gt;::Iterator::operator=           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classcsArray_1_1Iterator.html">Iterator</a> const &amp;&nbsp;</td>
          <td class="paramname"> <em>r</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Assignment operator. 
<p>

<p>Definition at line <a class="el" href="csutil_2array_8h-source.html#l01082">1082</a> of file <a class="el" href="csutil_2array_8h-source.html">array.h</a>.</p>

<p>References <a class="el" href="csutil_2array_8h-source.html#l01104">csArray&lt; T, ElementHandler, MemoryAllocator, CapacityHandler &gt;::Iterator::array</a>, and <a class="el" href="csutil_2array_8h-source.html#l01103">csArray&lt; T, ElementHandler, MemoryAllocator, CapacityHandler &gt;::Iterator::currentelem</a>.</p>

</div>
</div><p>
<a class="anchor" name="cbf17a1f1976be28c2538a858bdb955e"></a><!-- doxytag: member="csArray::Iterator::Reset" ref="cbf17a1f1976be28c2538a858bdb955e" args="()" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T, class ElementHandler = csArrayElementHandler&lt;T&gt;, class MemoryAllocator = CS::Memory::AllocatorMalloc, class CapacityHandler = csArrayCapacityDefault&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="classcsArray.html">csArray</a>&lt; T, ElementHandler, MemoryAllocator, CapacityHandler &gt;::Iterator::Reset           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Reset the array to the first element. 
<p>

<p>Definition at line <a class="el" href="csutil_2array_8h-source.html#l01094">1094</a> of file <a class="el" href="csutil_2array_8h-source.html">array.h</a>.</p>

</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li>csutil/<a class="el" href="csutil_2array_8h-source.html">array.h</a></ul>
<hr size="1"><address><small>Generated for Crystal Space 1.2.1 by 
<a href="http://www.doxygen.org/index.html">doxygen</a> 1.5.3 
</small></address> </div></body> </html>