<!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: iDocumentNodeIterator Struct 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 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 Pages</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="classes.html"><span>Alphabetical List</span></a></li>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<h1>iDocumentNodeIterator Struct Reference<br>
<small>
[<a class="el" href="group__util.html">Utilities</a>]</small>
</h1><!-- doxytag: class="iDocumentNodeIterator" --><!-- doxytag: inherits="iBase" -->An iterator over <a class="el" href="structiDocumentNode.html" title="Representation of a node in a document.">iDocumentNode</a>.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="document_8h-source.html">iutil/document.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for iDocumentNodeIterator:</div>
<div class="dynsection">
<p><center><img src="structiDocumentNodeIterator__inherit__graph.png" border="0" usemap="#iDocumentNodeIterator__inherit__map" alt="Inheritance graph"></center>
<map name="iDocumentNodeIterator__inherit__map">
<area shape="rect" href="classscfImplementation1.html" title="scfImplementation1\< CS::DocSystem::Implementation::FilterDocumentNodeIterator\< T \>, iDocumentNodeIterator \>" alt="" coords="333,5,1117,32"><area shape="rect" href="classscfImplementation1.html" title="scfImplementation1\< csEmptyDocumentNodeIterator, iDocumentNodeIterator \>" alt="" coords="449,56,1001,83"><area shape="rect" href="structiBase.html" title="This is the basic interface: all other interfaces should be derived from this one..." alt="" coords="5,31,61,57"><area shape="rect" href="classcsEmptyDocumentNodeIterator.html" title="Document node iterator does not return any nodes." alt="" coords="1167,56,1396,83"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="structiDocumentNodeIterator-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">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structiDocumentNodeIterator.html#b3e8b1198d6504e948bffee655107212">HasNext</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Are there more elements? <a href="#b3e8b1198d6504e948bffee655107212"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classcsRef.html">csRef</a><br>
< <a class="el" href="structiDocumentNode.html">iDocumentNode</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="structiDocumentNodeIterator.html#02894065434c2f3258dcffd4437ef460">Next</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get next element. <a href="#02894065434c2f3258dcffd4437ef460"></a><br></td></tr>
<tr><td colspan="2"><div class="groupHeader">Position querying</div></td></tr>
<tr><td colspan="2"><div class="groupText">The position returned by an iterator gives an indicator for the place of the next item returned in relation to all items iterated.<p>
It is <b>not</b> an accurate counter. In fact, after an element is fetched, the position may increase by any number or not at all.<p>
The only guarantees made are: * The <em>next position</em> is less than the <em>last position</em> as long as elements are available, * the <em>next position</em> is equal to the <em>last position</em> if no more elements are available, and * after a Next() call, the <em>next position</em> is larger or equal to the <em>next position</em> before the call. <br><br></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structiDocumentNodeIterator.html#d50ffb15ec3f5e97a82ce3acc840cca9">GetEndPosition</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the index of the "end" position (the position that is taken after no more elements are available). <a href="#d50ffb15ec3f5e97a82ce3acc840cca9"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structiDocumentNodeIterator.html#b79b6cba7ee10adb334808dc2c3f7cd5">GetNextPosition</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get an index of the next node. <a href="#b79b6cba7ee10adb334808dc2c3f7cd5"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
An iterator over <a class="el" href="structiDocumentNode.html" title="Representation of a node in a document.">iDocumentNode</a>.
<p>
Main creators of instances implementing this interface:<ul>
<li><a class="el" href="structiDocumentNode.html#e458462ca2357d0fd96fc9c31492bdcc" title="Get an iterator over all children.">iDocumentNode::GetNodes()</a> </li></ul>
<p>Definition at line <a class="el" href="document_8h-source.html#l00130">130</a> of file <a class="el" href="document_8h-source.html">document.h</a>.</p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="d50ffb15ec3f5e97a82ce3acc840cca9"></a><!-- doxytag: member="iDocumentNodeIterator::GetEndPosition" ref="d50ffb15ec3f5e97a82ce3acc840cca9" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual size_t iDocumentNodeIterator::GetEndPosition </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return the index of the "end" position (the position that is taken after no more elements are available).
<p>
<p>Implemented in <a class="el" href="classcsEmptyDocumentNodeIterator.html#5a697e48413308a09a4131603f1159cd">csEmptyDocumentNodeIterator</a>.</p>
</div>
</div><p>
<a class="anchor" name="b79b6cba7ee10adb334808dc2c3f7cd5"></a><!-- doxytag: member="iDocumentNodeIterator::GetNextPosition" ref="b79b6cba7ee10adb334808dc2c3f7cd5" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual size_t iDocumentNodeIterator::GetNextPosition </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get an index of the next node.
<p>
<p>Implemented in <a class="el" href="classcsEmptyDocumentNodeIterator.html#e6edd032029f5d95ba089d330ddaeaf7">csEmptyDocumentNodeIterator</a>.</p>
</div>
</div><p>
<a class="anchor" name="b3e8b1198d6504e948bffee655107212"></a><!-- doxytag: member="iDocumentNodeIterator::HasNext" ref="b3e8b1198d6504e948bffee655107212" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool iDocumentNodeIterator::HasNext </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Are there more elements?
<p>
<p>Implemented in <a class="el" href="classcsEmptyDocumentNodeIterator.html#05d55d09f93057fa0b2518d49d99cd9f">csEmptyDocumentNodeIterator</a>.</p>
</div>
</div><p>
<a class="anchor" name="02894065434c2f3258dcffd4437ef460"></a><!-- doxytag: member="iDocumentNodeIterator::Next" ref="02894065434c2f3258dcffd4437ef460" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classcsRef.html">csRef</a><<a class="el" href="structiDocumentNode.html">iDocumentNode</a>> iDocumentNodeIterator::Next </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get next element.
<p>
<p>Implemented in <a class="el" href="classcsEmptyDocumentNodeIterator.html#d4261d397183de9dfaff76d997ae68b2">csEmptyDocumentNodeIterator</a>.</p>
</div>
</div><p>
<hr>The documentation for this struct was generated from the following file:<ul>
<li>iutil/<a class="el" href="document_8h-source.html">document.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>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
bad97183153701b09df5fae1052b1c30
>
files
>
2900
