CrystalSpace

Public API Reference

iCollection Struct Reference

A collection object is for convenience of the script language. More...

#include <iengine/collectn.h>

Inheritance diagram for iCollection:

Inheritance graph
[legend]
List of all members.

Public Member Functions

virtual void AddObject (iObject *obj)=0
 Add an object to the collection.
virtual iObjectFindObject (char *name) const =0
 Find an object with the given name inside this collection.
virtual iObjectGetObject (int i) const =0
 Get an object by index (function version).
virtual int GetObjectCount () const =0
 Get the number of objects in this collection.
virtual iObjectoperator[] (int i) const =0
 Get an object by index (operator version).
virtual iObjectQueryObject ()=0
 Query the iObject for this collection.

Detailed Description

A collection object is for convenience of the script language.

It is simply a collection of other objects.

Main creators of instances implementing this interface:

Main ways to get pointers to this interface:

Main users of this interface:

Deprecated:
Don't use collections. They are obsolete.

Definition at line 48 of file collectn.h.


Member Function Documentation

virtual void iCollection::AddObject ( iObject obj  )  [pure virtual]

Add an object to the collection.

virtual iObject* iCollection::FindObject ( char *  name  )  const [pure virtual]

Find an object with the given name inside this collection.

virtual iObject* iCollection::GetObject ( int  i  )  const [pure virtual]

Get an object by index (function version).

virtual int iCollection::GetObjectCount (  )  const [pure virtual]

Get the number of objects in this collection.

virtual iObject* iCollection::operator[] ( int  i  )  const [pure virtual]

Get an object by index (operator version).

virtual iObject* iCollection::QueryObject (  )  [pure virtual]

Query the iObject for this collection.


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