Back to index

lightning-sunbird  0.9+nobinonly
nsIFrameTraversal.h
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 2; 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 #ifndef NSIFRAMETRAVERSAL_H
00038 #define NSIFRAMETRAVERSAL_H
00039 
00040 #include "nsISupports.h"
00041 #include "nsIEnumerator.h"
00042 #include "nsIFrame.h"
00043 
00044 /* Brief explanation of frame traversal types:
00045  *
00046  * LEAF:
00047  *  Iterate over only the leaf frames in the tree, in depth-first order.
00048  *
00049  * EXTENSIVE:
00050  *  Iterate over all frames in the tree, including non-leaf frames.
00051  *  Child frames are traversed before their parents going both forward
00052  *  and backward.
00053  *
00054  * FOCUS:
00055  *  Traverse frames in "focus" order, which is like extensive but
00056  *  does a strict preorder traversal in both directions.  This type of
00057  *  traversal also handles placeholder frames transparently, meaning that
00058  *  it will never stop on one - going down will get the real frame, going
00059  *  back up will go on past the placeholder, so the placeholders are logically
00060  *  part of the frame tree.
00061  *
00062  * FASTEST:
00063  *  XXX not implemented
00064  *
00065  * VISUAL:
00066  *  Traverse frames in "visual" order (left-to-right, top-to-bottom).
00067  */
00068 
00069 enum nsTraversalType{
00070   LEAF,
00071   EXTENSIVE,
00072   FOCUS,
00073   FASTEST
00074 #ifdef IBMBIDI // Simon
00075    , VISUAL
00076 #endif
00077 }; 
00078 
00079 // {1691E1F3-EE41-11d4-9885-00C04FA0CF4B}
00080 #define NS_IFRAMETRAVERSAL_IID \
00081 { 0x1691e1f3, 0xee41, 0x11d4, { 0x98, 0x85, 0x0, 0xc0, 0x4f, 0xa0, 0xcf, 0x4b } }
00082 
00083 class nsIFrameTraversal : public nsISupports
00084 {
00085 public:
00086   NS_DEFINE_STATIC_IID_ACCESSOR(NS_IFRAMETRAVERSAL_IID)
00087 
00088   NS_IMETHOD NewFrameTraversal(nsIBidirectionalEnumerator **aEnumerator,
00089                               PRUint32 aType,
00090                               nsPresContext* aPresContext,
00091                               nsIFrame *aStart) = 0;
00092 };
00093 
00094 
00095 #endif //NSIFRAMETRAVERSAL_H