CrystalSpace

Public API Reference

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

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 bool Next ()=0
 Move forward. More...

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

virtual iObjectGetObject () const=0
 Get the object we are pointing at. More...

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

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

virtual bool FindName (const char *name)=0
 traverses all csObjects and looks for an object with the given name returns true, if found, false if not 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 bool iObjectIterator::FindName const char *    name [pure virtual]
 

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

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

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

Get the object we are pointing at.

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

Get the parent object.

virtual bool iObjectIterator::IsFinished   const [pure virtual]
 

Check if we have any children of requested type.

virtual bool 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