Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions
nsIContentIterator Class Reference

#include <nsIContentIterator.h>

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

List of all members.

Public Member Functions

virtual nsresult Init (nsIContent *aRoot)=0
virtual nsresult Init (nsIDOMRange *aRange)=0
virtual void First ()=0
 First will reset the list.
virtual void Last ()=0
 Last will reset the list to the end.
virtual void Next ()=0
 Next will advance the list.
virtual void Prev ()=0
 Prev will decrement the list.
virtual nsIContentGetCurrentNode ()=0
 CurrentItem will return the current item, or null if the list is empty.
virtual PRBool IsDone ()=0
 return if the collection is at the end.
virtual nsresult PositionAt (nsIContent *aCurNode)=0
 PositionAt will position the iterator to the supplied node.

Detailed Description

Definition at line 56 of file nsIContentIterator.h.


Member Function Documentation

virtual void nsIContentIterator::First ( ) [pure virtual]

First will reset the list.

Implemented in nsContentSubtreeIterator, nsContentIterator, nsFindContentIterator, nsGeneratedContentIterator, nsFilteredContentIterator, and nsFrameContentIterator.

Here is the caller graph for this function:

virtual nsIContent* nsIContentIterator::GetCurrentNode ( ) [pure virtual]

CurrentItem will return the current item, or null if the list is empty.

Returns:
the current node

Implemented in nsContentIterator, nsFindContentIterator, nsGeneratedContentIterator, nsFilteredContentIterator, and nsFrameContentIterator.

Here is the caller graph for this function:

virtual nsresult nsIContentIterator::Init ( nsIContent aRoot) [pure virtual]
virtual nsresult nsIContentIterator::Init ( nsIDOMRange aRange) [pure virtual]
virtual PRBool nsIContentIterator::IsDone ( ) [pure virtual]

return if the collection is at the end.

that is the beginning following a call to Prev and it is the end of the list following a call to next

Returns:
if the iterator is done.

Implemented in nsContentIterator, nsFindContentIterator, nsGeneratedContentIterator, nsFilteredContentIterator, and nsFrameContentIterator.

Here is the caller graph for this function:

virtual void nsIContentIterator::Last ( ) [pure virtual]

Last will reset the list to the end.

Implemented in nsContentSubtreeIterator, nsContentIterator, nsFindContentIterator, nsGeneratedContentIterator, nsFilteredContentIterator, and nsFrameContentIterator.

Here is the caller graph for this function:

virtual void nsIContentIterator::Next ( ) [pure virtual]
virtual nsresult nsIContentIterator::PositionAt ( nsIContent aCurNode) [pure virtual]

PositionAt will position the iterator to the supplied node.

Implemented in nsContentSubtreeIterator, nsGeneratedSubtreeIterator, nsContentIterator, nsFindContentIterator, nsGeneratedContentIterator, nsFilteredContentIterator, and nsFrameContentIterator.

Here is the caller graph for this function:

virtual void nsIContentIterator::Prev ( ) [pure virtual]

Prev will decrement the list.

Implemented in nsContentSubtreeIterator, nsGeneratedSubtreeIterator, nsContentIterator, nsFindContentIterator, nsGeneratedContentIterator, nsFilteredContentIterator, and nsFrameContentIterator.

Here is the caller graph for this function:


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