nsIForwardIterator

IID:8da01646-1dd2-11b2-98a7-c7009045be7e
Inherits From:nsISupports

Methods

nsISupports clone ( ) nsISupports getElement ( ) PRBool isEqualTo ( nsISupports anotherIterator ) void putElement ( nsISupports anElementToPut ) void stepForward ( )

nsISupports clone ( )

Create a new iterator pointing to the same position in the underlying container or sequence to which this iterator currently points. The returned iterator is suitable for use in a subsequent call to isEqualTo() against this iterator.


nsISupports getElement ( )

Retrieve (and AddRef()) the element this iterator currently points to.

The result is undefined if this iterator currently points outside the useful range of the underlying container or sequence.


PRBool isEqualTo ( nsISupports anotherIterator )

Test if anotherIterator points to the same position in the underlying container or sequence.

The result is undefined if anotherIterator was not created by or for the same underlying container or sequence.

Arguments:
anotherIterator: another iterator to compare against, created by or for the same underlying container or sequence

void putElement ( nsISupports anElementToPut )

Put anElementToPut into the underlying container or sequence at the position currently pointed to by this iterator. The iterator and the underlying container or sequence cooperate to Release() the replaced element, if any and if necessary, and to AddRef() the new element.

The result is undefined if this iterator currently points outside the useful range of the underlying container or sequence.

Arguments:
anElementToPut: the element to place into the underlying container or sequence

void stepForward ( )

Advance this iterator to the next position in the underlying container or sequence.

Reference documentation is generated from Mozilla's source.

Add a note User Contributed Notes
No comments available

Copyright © 1999 - 2005 XULPlanet.com