Back to index

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

#include <xpcprivate.h>

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

List of all members.

Public Member Functions

NS_DECL_ISUPPORTS
NS_DECL_NSISIMPLEENUMERATOR 
xpcPropertyBagEnumerator (PRUint32 count)
virtual ~xpcPropertyBagEnumerator ()
JSBool AppendElement (nsISupports *element)
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.

Private Attributes

nsSupportsArray mArray
PRUint32 mIndex
PRUint32 mCount

Detailed Description

Definition at line 2337 of file xpcprivate.h.


Constructor & Destructor Documentation

Definition at line 424 of file xpcwrappedjsclass.cpp.

    : mIndex(0), mCount(0)
{
    mArray.SizeTo(count);
}

Definition at line 2344 of file xpcprivate.h.

{}

Member Function Documentation

JSBool xpcPropertyBagEnumerator::AppendElement ( nsISupports *  element)

Definition at line 430 of file xpcwrappedjsclass.cpp.

{
    if(!mArray.AppendElement(element))
        return JS_FALSE;
    mCount++;
    return JS_TRUE;
}

Here is the caller graph for this function:

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

nsSupportsArray xpcPropertyBagEnumerator::mArray [private]

Definition at line 2349 of file xpcprivate.h.

Definition at line 2351 of file xpcprivate.h.

Definition at line 2350 of file xpcprivate.h.


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