layout/base/nsFrameTraversal.h

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* ***** BEGIN LICENSE BLOCK *****
   3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   4  *
   5  * The contents of this file are subject to the Mozilla Public License Version
   6  * 1.1 (the "License"); you may not use this file except in compliance with
   7  * the License. You may obtain a copy of the License at
   8  * http://www.mozilla.org/MPL/
   9  *
  10  * Software distributed under the License is distributed on an "AS IS" basis,
  11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12  * for the specific language governing rights and limitations under the
  13  * License.
  14  *
  15  * The Original Code is mozilla.org code.
  16  *
  17  * The Initial Developer of the Original Code is
  18  * Netscape Communications Corporation.
  19  * Portions created by the Initial Developer are Copyright (C) 1998
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *
  24  * Alternatively, the contents of this file may be used under the terms of
  25  * either of the GNU General Public License Version 2 or later (the "GPL"),
  26  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  27  * in which case the provisions of the GPL or the LGPL are applicable instead
  28  * of those above. If you wish to allow use of your version of this file only
  29  * under the terms of either the GPL or the LGPL, and not to allow others to
  30  * use your version of this file under the terms of the MPL, indicate your
  31  * decision by deleting the provisions above and replace them with the notice
  32  * and other provisions required by the GPL or the LGPL. If you do not delete
  33  * the provisions above, a recipient may use your version of this file under
  34  * the terms of any one of the MPL, the GPL or the LGPL.
  35  *
  36  * ***** END LICENSE BLOCK ***** */
  37 #ifndef NSFRAMETRAVERSAL_H
  38 #define NSFRAMETRAVERSAL_H
  39
  40 #include "nsIFrame.h"
  41 #include "nsIFrameTraversal.h"
  42
  43 nsresult NS_NewFrameTraversal(nsIFrameEnumerator **aEnumerator,
  44                               nsPresContext* aPresContext,
  45                               nsIFrame *aStart,
  46                               nsIteratorType aType,
  47                               PRBool aVisual,
  48                               PRBool aLockInScrollView,
  49                               PRBool aFollowOOFs);
  50
  51 nsresult NS_CreateFrameTraversal(nsIFrameTraversal** aResult);
  52
  53 class nsFrameTraversal : public nsIFrameTraversal
  54 {
  55 public:
  56   nsFrameTraversal();
  57   virtual ~nsFrameTraversal();
  58
  59   NS_DECL_ISUPPORTS
  60
  61   NS_IMETHOD NewFrameTraversal(nsIFrameEnumerator **aEnumerator,
  62                                nsPresContext* aPresContext,
  63                                nsIFrame *aStart,
  64                                PRInt32 aType,
  65                                PRBool aVisual,
  66                                PRBool aLockInScrollView,
  67                                PRBool aFollowOOFs);
  68 };
  69
  70 #endif //NSFRAMETRAVERSAL_H