Provides script language access to C++ objects of this type.
Class Hierarchy | Type » List |
Function members are as follows:
Return Type | Function Name | Documentation |
---|---|---|
int32 | Add | Adds a <Type> derived object 'Obj' to the <List>. The <List> then owns the object and the object will be deleted when the <List> is deleted. |
int32 | AddRef | Adds a <Type> derived object 'Obj' to the <List> as a reference. The object is not owned by the <List> and will not be deleted when the <List> is deleted. |
int32 | Clear | Clears the <List> and destroys any objects that are owned by the <List>. Does not destroy the <List> object. |
int32 | CountIs | Returns true if the count of objects resident in the <List> matches the specified count. |
int32 | CountIsNot | Returns true if the count of objects resident in the <List> does not match the specified count. |
int32 | Del | Deletes an object from the <List>. If the <List> owns the object, the underlying memory is released. |
int32 | DelAt | Deletes the object at the specified index. If the <List> owns the object, the object is destroyed and its memory is released. |
int32 | DoesNotContain | Returns true if the <List> does not contain a pointer to the indicated object. Please note that this test works whether or not the <List> owns the object or merely references the object. |
int32 | Find | Returns the index of the object, or -1 if the object is not resident in the <List>. |
<Type> | Get | Returns a <Type> pointer to an object in the <List>, at the specified index. |
int32 | GetCount | Returns the count of objects in the <List>. |
<Type> | GetFirst | Returns the first object in the <List>. |
<Type> | GetFirstOfType | Returns a pointer to the first object of the specified type. |
<Type> | GetLast | Returns a pointer to the last object in the <List>. |
int32 | GetLastIndex | Returns the <int32> value of the last index in the <List>. The last index is computed as Count - 1. |
int32 | In | Tests if the object 'p_oObject' is contained in the <List>. |
int32 | Insert | Inserts an object in the <List>. The <List> takes ownership of the object. |
int32 | InsertRef | Inserts a pointer to the object into the <List>. The <List> does not take ownership of the object. |
int32 | IsCountMultiple | Returns true if the number of items resident in the <List> object is a multiple of the specified count. |
int32 | IsEmpty | Returns true if zero objects are resident in the <List>. |
int32 | IsHeterogenous | Returns true if the <List> contains pointers to objects of more than one type. |
int32 | IsHomogenous | Returns true if the <List> contains pointers to objects of a single type. |
int32 | MaxIndex | Returns the maximum index in the <List>, which is: the <List> object's count - 1. |
int32 | Move | Moves the object at the source index to the destination index. The <List> is temporarily re-ordered, so subsequent move operations may require recomputation to ensure their index values are correct. |
int32 | MoveToEnd | Moves a <List> member to the end of the <List>. |
int32 | Owns | Adds a <Type> derived object 'Obj' to the <List>. The <List> then owns the object and the object will be deleted when the <List> is deleted. |
int32 | Refers | Adds a <Type> derived object 'Obj' to the <List> as a reference. The object is not owned by the <List> and will not be deleted when the <List> is deleted. |
int32 | Remove | Removes the object from the <List>, but does not destroy it. The object's memory is not released. |
<Type> | RemoveAt | Removes the object from the <List> at the specified index and returns a pointer to the object. If the <List> owned the object, ownership of the object is released, but the object's memory is not freed. The object can be manually deleted or ownership can be transferred. |
<Type> | RemoveFirst | Removes the first object from the <List> and returns a pointer to the object. If the <List> owned the object, ownership of the object is released, but the object's memory is not freed. The object can be manually deleted or ownership can be transferred. |
int32 | RemoveLast | Removes the last object from the <List> and returns a pointer to the object. If the <List> owned the object, ownership of the object is released, but the object's memory is not freed. The object can be manually deleted or ownership can be transferred. |
int32 | Reverse | Reverses the order of the <List>. |
int32 | Transfer | Moves <List> members from this <List> to a destination <List>. Ownership semantics are maintained: if ListA owns ListMember0, then ListB will own ListMember0. |