CrystalSpace

Public API Reference

Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members   Related Pages  

iObjectIterator Struct Reference
[Utilities]

This is an iterator for child objects of a csObject. More...

#include <object.h>

Inheritance diagram for iObjectIterator:

iBase List of all members.

Public Methods

virtual iObjectNext ()=0
 Move forward. More...

virtual void Reset ()=0
 Reset the iterator to the beginning. More...

virtual iObjectGetParentObj () const=0
 Get the parent object. More...

virtual bool HasNext () const=0
 Check if we have any more children of requested type. More...

virtual iObjectFindName (const char *name)=0
 traverses all csObjects and looks for an object with the given name returns object if found. More...


Detailed Description

This is an iterator for child objects of a csObject.

Note that this iterator only contains type-independent functionality and is therefore a bit complicated to use (i.e. you'll have to do a lot of SCF_QUERY_INTERFACE_CALLS if you use it directly). Check out typed object iterators instead.

Definition at line 130 of file iutil/object.h.


Member Function Documentation

virtual iObject* iObjectIterator::FindName const char *    name [pure virtual]
 

traverses all csObjects and looks for an object with the given name returns object if found.

You can continue search by calling Next and then do an other FindName, if you like.

virtual iObject* iObjectIterator::GetParentObj   const [pure virtual]
 

Get the parent object.

virtual bool iObjectIterator::HasNext   const [pure virtual]
 

Check if we have any more children of requested type.

virtual iObject* iObjectIterator::Next   [pure virtual]
 

Move forward.

virtual void iObjectIterator::Reset   [pure virtual]
 

Reset the iterator to the beginning.


The documentation for this struct was generated from the following file:
Generated for Crystal Space by doxygen 1.2.14