Back to index

lightning-sunbird  0.9+nobinonly
nsIContentIterator.h
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
00002 /* ***** BEGIN LICENSE BLOCK *****
00003  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00004  *
00005  * The contents of this file are subject to the Mozilla Public License Version
00006  * 1.1 (the "License"); you may not use this file except in compliance with
00007  * the License. You may obtain a copy of the License at
00008  * http://www.mozilla.org/MPL/
00009  *
00010  * Software distributed under the License is distributed on an "AS IS" basis,
00011  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00012  * for the specific language governing rights and limitations under the
00013  * License.
00014  *
00015  * The Original Code is mozilla.org code.
00016  *
00017  * The Initial Developer of the Original Code is
00018  * Netscape Communications Corporation.
00019  * Portions created by the Initial Developer are Copyright (C) 1998
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *
00024  * Alternatively, the contents of this file may be used under the terms of
00025  * either of the GNU General Public License Version 2 or later (the "GPL"),
00026  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00027  * in which case the provisions of the GPL or the LGPL are applicable instead
00028  * of those above. If you wish to allow use of your version of this file only
00029  * under the terms of either the GPL or the LGPL, and not to allow others to
00030  * use your version of this file under the terms of the MPL, indicate your
00031  * decision by deleting the provisions above and replace them with the notice
00032  * and other provisions required by the GPL or the LGPL. If you do not delete
00033  * the provisions above, a recipient may use your version of this file under
00034  * the terms of any one of the MPL, the GPL or the LGPL.
00035  *
00036  * ***** END LICENSE BLOCK ***** */
00037 
00038 #ifndef __nsIContentIterator_h___
00039 #define __nsIContentIterator_h___
00040 
00041 #include "nsISupports.h"
00042 
00043 class nsIContent;
00044 class nsIDOMRange;
00045 
00046 #define NS_ICONTENTITERTOR_IID \
00047 {0xa6cf90e4, 0x15b3, 0x11d2,   \
00048 {0x93, 0x2e, 0x00, 0x80, 0x5f, 0x8a, 0xdd, 0x32} }
00049 
00050 // {B4BC9F63-D9BA-11d3-9938-00108301233C}
00051 #define NS_IGENERATEDCONTENTITERTOR_IID \
00052 { 0xb4bc9f63, 0xd9ba, 0x11d3,  \
00053 { 0x99, 0x38, 0x0, 0x10, 0x83, 0x1, 0x23, 0x3c } }
00054 
00055 
00056 class nsIContentIterator : public nsISupports
00057 {
00058 public:
00059   NS_DEFINE_STATIC_IID_ACCESSOR(NS_ICONTENTITERTOR_IID)
00060 
00061   /* Initializes an iterator for the subtree rooted by the node aRoot
00062    */
00063   virtual nsresult Init(nsIContent* aRoot) = 0;
00064 
00065   /* Initializes an iterator for the subtree defined by the range aRange
00066    */
00067   virtual nsresult Init(nsIDOMRange* aRange) = 0;
00068 
00071   virtual void First() = 0;
00072 
00075   virtual void Last() = 0;
00076 
00079   virtual void Next() = 0;
00080 
00083   virtual void Prev() = 0;
00084 
00088   virtual nsIContent *GetCurrentNode() = 0;
00089 
00094   virtual PRBool IsDone() = 0;
00095 
00098   virtual nsresult PositionAt(nsIContent* aCurNode) = 0;
00099 };
00100 
00101 class nsIPresShell;
00102 
00103 class nsIGeneratedContentIterator : public nsISupports {
00104 public:
00105 
00106   NS_DEFINE_STATIC_IID_ACCESSOR(NS_IGENERATEDCONTENTITERTOR_IID)
00107 
00108   /* Initializes an iterator for the subtree rooted by the node aRoot
00109    */
00110   virtual nsresult Init(nsIPresShell *aShell, nsIDOMRange* aRange) = 0;
00111 
00112   virtual nsresult Init(nsIPresShell *aShell, nsIContent* aContent) = 0;
00113 };
00114 
00115 
00116 #endif // __nsIContentIterator_h___
00117