Back to index

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

#include <nsSHistory.h>

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

List of all members.

Public Member Functions

NS_DECL_ISUPPORTS
NS_DECL_NSISIMPLEENUMERATOR 
nsSHEnumerator (nsSHistory *aHistory)
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 Member Functions

virtual ~nsSHEnumerator ()

Private Attributes

PRInt32 mIndex
nsSHistorymSHistory

Friends

class nsSHistory

Detailed Description

Definition at line 120 of file nsSHistory.h.


Constructor & Destructor Documentation

Definition at line 1258 of file nsSHistory.cpp.

                                                    :mIndex(-1)
{
  mSHistory = aSHistory;
}
nsSHEnumerator::~nsSHEnumerator ( ) [protected, virtual]

Definition at line 1263 of file nsSHistory.cpp.


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:


Friends And Related Function Documentation

friend class nsSHistory [friend]

Definition at line 130 of file nsSHistory.h.


Member Data Documentation

Definition at line 133 of file nsSHistory.h.

Definition at line 134 of file nsSHistory.h.


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