Sophie

Sophie

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

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: csutil/objiter.h Source File (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><a href="classes.html"><span>Classes</span></a></li>
    <li class="current"><a href="files.html"><span>Files</span></a></li>
    <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
  </ul>
</div>
<h1>csutil/objiter.h</h1><a href="objiter_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
<a name="l00002"></a>00002 <span class="comment">    Copyright (C) 2001 by Martin Geisse &lt;mgeisse@gmx.net&gt;</span>
<a name="l00003"></a>00003 <span class="comment"></span>
<a name="l00004"></a>00004 <span class="comment">    This library is free software; you can redistribute it and/or</span>
<a name="l00005"></a>00005 <span class="comment">    modify it under the terms of the GNU Library General Public</span>
<a name="l00006"></a>00006 <span class="comment">    License as published by the Free Software Foundation; either</span>
<a name="l00007"></a>00007 <span class="comment">    version 2 of the License, or (at your option) any later version.</span>
<a name="l00008"></a>00008 <span class="comment"></span>
<a name="l00009"></a>00009 <span class="comment">    This library is distributed in the hope that it will be useful,</span>
<a name="l00010"></a>00010 <span class="comment">    but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00011"></a>00011 <span class="comment">    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU</span>
<a name="l00012"></a>00012 <span class="comment">    Library General Public License for more details.</span>
<a name="l00013"></a>00013 <span class="comment"></span>
<a name="l00014"></a>00014 <span class="comment">    You should have received a copy of the GNU Library General Public</span>
<a name="l00015"></a>00015 <span class="comment">    License along with this library; if not, write to the Free</span>
<a name="l00016"></a>00016 <span class="comment">    Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.</span>
<a name="l00017"></a>00017 <span class="comment">*/</span>
<a name="l00018"></a>00018 
<a name="l00023"></a>00023 <span class="preprocessor">#ifndef __CS_OBJITER_H__</span>
<a name="l00024"></a>00024 <span class="preprocessor"></span><span class="preprocessor">#define __CS_OBJITER_H__</span>
<a name="l00025"></a>00025 <span class="preprocessor"></span>
<a name="l00026"></a>00026 <span class="preprocessor">#include "csextern.h"</span>
<a name="l00027"></a>00027 <span class="preprocessor">#include "<a class="code" href="scf_8h.html" title="Crystal Space Shared Class Facility (SCF).">csutil/scf.h</a>"</span>
<a name="l00028"></a>00028 <span class="preprocessor">#include "<a class="code" href="ref_8h.html" title="Smart Pointers.">csutil/ref.h</a>"</span>
<a name="l00029"></a>00029 <span class="preprocessor">#include "<a class="code" href="iutil_2object_8h.html" title="Generic object interface.">iutil/object.h</a>"</span>
<a name="l00030"></a>00030 
<a name="l00034"></a>00034 <span class="keyword">template</span>&lt;<span class="keyword">typename</span> T&gt; 
<a name="l00035"></a><a class="code" href="classcsTypedObjectIterator.html">00035</a> <span class="keyword">class </span><a class="code" href="classcsTypedObjectIterator.html" title="Typed object iterator class.">csTypedObjectIterator</a>
<a name="l00036"></a>00036 {
<a name="l00037"></a>00037 <span class="keyword">protected</span>:
<a name="l00038"></a><a class="code" href="classcsTypedObjectIterator.html#8ef9c564c5a0ddd3c289f30e2a371e82">00038</a>   <a class="code" href="classcsRef.html" title="A smart pointer.">csRef&lt;iObjectIterator&gt;</a> <a class="code" href="classcsTypedObjectIterator.html#8ef9c564c5a0ddd3c289f30e2a371e82">iter</a>;
<a name="l00039"></a><a class="code" href="classcsTypedObjectIterator.html#b98b33de835016edf7927803d1d19a71">00039</a>   <a class="code" href="classcsRef.html" title="A smart pointer.">csRef&lt;T&gt;</a> <a class="code" href="classcsTypedObjectIterator.html#b98b33de835016edf7927803d1d19a71">CurrentTypedObject</a>;
<a name="l00040"></a>00040 
<a name="l00041"></a><a class="code" href="classcsTypedObjectIterator.html#0790f8ed0a2a710fb65e0247747f3531">00041</a>   <span class="keywordtype">void</span> <a class="code" href="classcsTypedObjectIterator.html#0790f8ed0a2a710fb65e0247747f3531">FetchObject</a>()
<a name="l00042"></a>00042   {
<a name="l00043"></a>00043     <a class="code" href="classcsTypedObjectIterator.html#b98b33de835016edf7927803d1d19a71">CurrentTypedObject</a>.Invalidate();
<a name="l00044"></a>00044     <span class="keywordflow">while</span> (<a class="code" href="classcsTypedObjectIterator.html#8ef9c564c5a0ddd3c289f30e2a371e82">iter</a>-&gt;HasNext())
<a name="l00045"></a>00045     {
<a name="l00046"></a>00046       <a class="code" href="classcsTypedObjectIterator.html#b98b33de835016edf7927803d1d19a71">CurrentTypedObject</a> = scfQueryInterface&lt;T&gt; (<a class="code" href="classcsTypedObjectIterator.html#8ef9c564c5a0ddd3c289f30e2a371e82">iter</a>-&gt;Next());
<a name="l00047"></a>00047       <span class="keywordflow">if</span> (<a class="code" href="classcsTypedObjectIterator.html#b98b33de835016edf7927803d1d19a71">CurrentTypedObject</a>.IsValid())
<a name="l00048"></a>00048         <span class="keywordflow">return</span>;
<a name="l00049"></a>00049     }
<a name="l00050"></a>00050   }
<a name="l00051"></a>00051 
<a name="l00052"></a>00052 <span class="keyword">public</span>:
<a name="l00054"></a><a class="code" href="classcsTypedObjectIterator.html#4bc57cc87b4b3fe0359e2c7651910812">00054</a>   <a class="code" href="classcsTypedObjectIterator.html#4bc57cc87b4b3fe0359e2c7651910812" title="Constructor.">csTypedObjectIterator</a>(<a class="code" href="structiObject.html" title="This interface is an SCF interface for encapsulating csObject.">iObject</a>* parent)
<a name="l00055"></a>00055   {
<a name="l00056"></a>00056     <a class="code" href="classcsTypedObjectIterator.html#8ef9c564c5a0ddd3c289f30e2a371e82">iter</a> = parent-&gt;<a class="code" href="structiObject.html#7d556c40d0c2f474559145bd257660e6" title="Return an iterator for all child objects.">GetIterator</a>();
<a name="l00057"></a>00057     <a class="code" href="classcsTypedObjectIterator.html#0790f8ed0a2a710fb65e0247747f3531">FetchObject</a>();
<a name="l00058"></a>00058   }
<a name="l00059"></a>00059 
<a name="l00061"></a><a class="code" href="classcsTypedObjectIterator.html#72db2031603e910f9ee941ab1e7e2cbb">00061</a>   <a class="code" href="classcsTypedObjectIterator.html#72db2031603e910f9ee941ab1e7e2cbb" title="Destructor.">~csTypedObjectIterator</a>() {}
<a name="l00062"></a>00062 
<a name="l00064"></a><a class="code" href="classcsTypedObjectIterator.html#7bbc3b689bd061fa86b0e7af41fa2828">00064</a>   T* <a class="code" href="classcsTypedObjectIterator.html#7bbc3b689bd061fa86b0e7af41fa2828" title="Move forward.">Next</a>()
<a name="l00065"></a>00065   {
<a name="l00066"></a>00066     T* cur = <a class="code" href="classcsTypedObjectIterator.html#b98b33de835016edf7927803d1d19a71">CurrentTypedObject</a>;
<a name="l00067"></a>00067     <a class="code" href="classcsTypedObjectIterator.html#0790f8ed0a2a710fb65e0247747f3531">FetchObject</a>();
<a name="l00068"></a>00068     <span class="keywordflow">return</span> (T*)cur;
<a name="l00069"></a>00069   }
<a name="l00070"></a>00070 
<a name="l00072"></a><a class="code" href="classcsTypedObjectIterator.html#24a14f3ae9eba349f173640ea0ae65f9">00072</a>   <span class="keywordtype">void</span> <a class="code" href="classcsTypedObjectIterator.html#24a14f3ae9eba349f173640ea0ae65f9" title="Reset the iterator to the beginning.">Reset</a>() { <a class="code" href="classcsTypedObjectIterator.html#8ef9c564c5a0ddd3c289f30e2a371e82">iter</a>-&gt;Reset(); <a class="code" href="classcsTypedObjectIterator.html#0790f8ed0a2a710fb65e0247747f3531">FetchObject</a>(); }
<a name="l00073"></a>00073 
<a name="l00075"></a><a class="code" href="classcsTypedObjectIterator.html#fa019b4641854e344f589c38dbd367d9">00075</a>   <a class="code" href="structiObject.html" title="This interface is an SCF interface for encapsulating csObject.">iObject</a>* <a class="code" href="classcsTypedObjectIterator.html#fa019b4641854e344f589c38dbd367d9" title="Get the parent object.">GetParentObj</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="classcsTypedObjectIterator.html#8ef9c564c5a0ddd3c289f30e2a371e82">iter</a>-&gt;GetParentObj(); }
<a name="l00076"></a>00076 
<a name="l00078"></a><a class="code" href="classcsTypedObjectIterator.html#247f0357eebf1d6010926803300db098">00078</a>   <span class="keywordtype">bool</span> <a class="code" href="classcsTypedObjectIterator.html#247f0357eebf1d6010926803300db098" title="Check if we have any children of requested type.">HasNext</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="classcsTypedObjectIterator.html#b98b33de835016edf7927803d1d19a71">CurrentTypedObject</a>.IsValid(); }
<a name="l00079"></a>00079 
<a name="l00081"></a><a class="code" href="classcsTypedObjectIterator.html#2213e2a47c03265176f19d54aec38271">00081</a>   T* <a class="code" href="classcsTypedObjectIterator.html#2213e2a47c03265176f19d54aec38271" title="Find the object with the given name.">FindName</a> (<span class="keyword">const</span> <span class="keywordtype">char</span>* name)
<a name="l00082"></a>00082   {
<a name="l00083"></a>00083     <a class="code" href="structiObject.html" title="This interface is an SCF interface for encapsulating csObject.">iObject</a>* obj = <a class="code" href="classcsTypedObjectIterator.html#8ef9c564c5a0ddd3c289f30e2a371e82">iter</a>-&gt;FindName(name);
<a name="l00084"></a>00084     <span class="keywordflow">if</span> (obj != 0)
<a name="l00085"></a>00085       <a class="code" href="classcsTypedObjectIterator.html#b98b33de835016edf7927803d1d19a71">CurrentTypedObject</a> = scfQueryInterface&lt;T&gt; (obj);
<a name="l00086"></a>00086     <span class="keywordflow">else</span>
<a name="l00087"></a>00087       <a class="code" href="classcsTypedObjectIterator.html#b98b33de835016edf7927803d1d19a71">CurrentTypedObject</a>.Invalidate();
<a name="l00088"></a>00088     <span class="keywordflow">return</span> (T*)<a class="code" href="classcsTypedObjectIterator.html#b98b33de835016edf7927803d1d19a71">CurrentTypedObject</a>;
<a name="l00089"></a>00089   }
<a name="l00090"></a>00090 };
<a name="l00091"></a>00091 
<a name="l00092"></a>00092 <span class="preprocessor">#endif // __CS_OBJITER_H__</span>
</pre></div><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>