Public Member Functions

nsIInputIterator Interface Reference

... More...

import "nsISupportsIterators.idl";

List of all members.

Public Member Functions

nsISupports getElement ()
 Retrieve (and |AddRef()|) the element this iterator currently points to.
void stepForward ()
 Advance this iterator to the next position in the underlying container or sequence.
boolean isEqualTo (in nsISupports anotherIterator)
 Test if |anotherIterator| points to the same position in the underlying container or sequence.
nsISupports clone ()
 Create a new iterator pointing to the same position in the underlying container or sequence to which this iterator currently points.

Detailed Description

...


Member Function Documentation

nsISupports nsIInputIterator::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.

Returns:
a new iterator pointing at the same position in the same underlying container or sequence as this iterator
nsISupports nsIInputIterator::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.

Returns:
a new reference to the element this iterator currently points to (if any)
boolean nsIInputIterator::isEqualTo ( in 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.

Parameters:
anotherIterator another iterator to compare against, created by or for the same underlying container or sequence
Returns:
true if |anotherIterator| points to the same position in the underlying container or sequence
void nsIInputIterator::stepForward (  ) 

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


The documentation for this interface was generated from the following file: