Sophie

Sophie

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

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;::ConstIterator 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_1ConstIterator.html">ConstIterator</a></div>
<h1>csArray&lt; T, ElementHandler, MemoryAllocator, CapacityHandler &gt;::ConstIterator Class Reference</h1><!-- doxytag: class="csArray::ConstIterator" --><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_1ConstIterator-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">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsArray_1_1ConstIterator.html#07662fbb990f591ffe5300d67f651a89">ConstIterator</a> (<a class="el" href="classcsArray_1_1ConstIterator.html">ConstIterator</a> const &amp;r)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Copy constructor.  <a href="#07662fbb990f591ffe5300d67f651a89"></a><br></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_1ConstIterator.html#f76f7541d1734c26ce9cc5f976c9d2cb">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_1ConstIterator.html#4094b758f2cd6c13faccf42cf44d383f" title="Returns the next element in the array.">Next()</a> call will return an element.  <a href="#f76f7541d1734c26ce9cc5f976c9d2cb"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const T &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsArray_1_1ConstIterator.html#4094b758f2cd6c13faccf42cf44d383f">Next</a> ()</td></tr>

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

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Assignment operator.  <a href="#7a0f499b62c54e670de022383c19fd48"></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_1ConstIterator.html#3fbaa85fa069b2d95412d9523e9cfb04">Reset</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Reset the array to the first element.  <a href="#3fbaa85fa069b2d95412d9523e9cfb04"></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="7587479adb25714c163909f4b0fd422b"></a><!-- doxytag: member="csArray::ConstIterator::ConstIterator" ref="7587479adb25714c163909f4b0fd422b" args="(const csArray&lt; T, ElementHandler, MemoryAllocator, CapacityHandler &gt; &amp;newarray)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsArray_1_1ConstIterator.html#7587479adb25714c163909f4b0fd422b">ConstIterator</a> (const <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::ConstIterator::csArray&lt; T, ElementHandler, MemoryAllocator, CapacityHandler &gt;" ref="ff4f613b969d93508791c502b07831ee" args="" -->
class&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsArray_1_1ConstIterator.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;::ConstIterator</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#l01108">1108</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="07662fbb990f591ffe5300d67f651a89"></a><!-- doxytag: member="csArray::ConstIterator::ConstIterator" ref="07662fbb990f591ffe5300d67f651a89" args="(ConstIterator 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;::ConstIterator::ConstIterator           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classcsArray_1_1ConstIterator.html">ConstIterator</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#l01112">1112</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="f76f7541d1734c26ce9cc5f976c9d2cb"></a><!-- doxytag: member="csArray::ConstIterator::HasNext" ref="f76f7541d1734c26ce9cc5f976c9d2cb" 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;::ConstIterator::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_1ConstIterator.html#4094b758f2cd6c13faccf42cf44d383f" 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#l01120">1120</a> of file <a class="el" href="csutil_2array_8h-source.html">array.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="4094b758f2cd6c13faccf42cf44d383f"></a><!-- doxytag: member="csArray::ConstIterator::Next" ref="4094b758f2cd6c13faccf42cf44d383f" 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">const T&amp; <a class="el" href="classcsArray.html">csArray</a>&lt; T, ElementHandler, MemoryAllocator, CapacityHandler &gt;::ConstIterator::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#l01124">1124</a> of file <a class="el" href="csutil_2array_8h-source.html">array.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="7a0f499b62c54e670de022383c19fd48"></a><!-- doxytag: member="csArray::ConstIterator::operator=" ref="7a0f499b62c54e670de022383c19fd48" args="(ConstIterator 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_1ConstIterator.html">ConstIterator</a>&amp; <a class="el" href="classcsArray.html">csArray</a>&lt; T, ElementHandler, MemoryAllocator, CapacityHandler &gt;::ConstIterator::operator=           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classcsArray_1_1ConstIterator.html">ConstIterator</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#l01116">1116</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#l01138">csArray&lt; T, ElementHandler, MemoryAllocator, CapacityHandler &gt;::ConstIterator::array</a>, and <a class="el" href="csutil_2array_8h-source.html#l01137">csArray&lt; T, ElementHandler, MemoryAllocator, CapacityHandler &gt;::ConstIterator::currentelem</a>.</p>

</div>
</div><p>
<a class="anchor" name="3fbaa85fa069b2d95412d9523e9cfb04"></a><!-- doxytag: member="csArray::ConstIterator::Reset" ref="3fbaa85fa069b2d95412d9523e9cfb04" 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;::ConstIterator::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#l01128">1128</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>