Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions | Protected Attributes | Private Member Functions
nsSimpleArrayEnumerator Class Reference

#include <nsArrayEnumerator.h>

Inheritance diagram for nsSimpleArrayEnumerator:
Inheritance graph
[legend]
Collaboration diagram for nsSimpleArrayEnumerator:
Collaboration graph
[legend]

List of all members.

Public Member Functions

NS_DECL_ISUPPORTS
NS_DECL_NSISIMPLEENUMERATOR 
nsSimpleArrayEnumerator (nsIArray *aValueArray)
boolean hasMoreElements ()
 Called to determine whether or not the enumerator has any elements that can be returned via getNext().
nsISupports getNext ()
 Called to retrieve the next element in the enumerator.

Protected Attributes

nsCOMPtr< nsIArraymValueArray
PRUint32 mIndex

Private Member Functions

 ~nsSimpleArrayEnumerator ()

Detailed Description

Definition at line 49 of file nsArrayEnumerator.h.


Constructor & Destructor Documentation

NS_DECL_ISUPPORTS NS_DECL_NSISIMPLEENUMERATOR nsSimpleArrayEnumerator::nsSimpleArrayEnumerator ( nsIArray aValueArray) [inline]

Definition at line 59 of file nsArrayEnumerator.h.

                                                   :
        mValueArray(aValueArray), mIndex(0) {
    }

Definition at line 64 of file nsArrayEnumerator.h.

{}

Member Function Documentation

nsISupports nsISimpleEnumerator::getNext ( ) [inherited]

Called to retrieve the next element in the enumerator.

The "next" element is the first element upon the first call. Must be pre-ceeded by a call to hasMoreElements() which returns PR_TRUE. This method is generally called within a loop to iterate over the elements in the enumerator.

See also:
hasMoreElements()
Returns:
NS_OK if the call succeeded in returning a non-null value through the out parameter. NS_ERROR_FAILURE if there are no more elements to enumerate.
the next element in the enumeration.

Here is the caller graph for this function:

Called to determine whether or not the enumerator has any elements that can be returned via getNext().

This method is generally used to determine whether or not to initiate or continue iteration over the enumerator, though it can be called without subsequent getNext() calls. Does not affect internal state of enumerator.

See also:
getNext()
Returns:
PR_TRUE if there are remaining elements in the enumerator. PR_FALSE if there are no more elements in the enumerator.

Here is the caller graph for this function:


Member Data Documentation

Definition at line 68 of file nsArrayEnumerator.h.

Definition at line 67 of file nsArrayEnumerator.h.


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