layout/generic/nsViewportFrame.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
  38 /*
  39  * rendering object that is the root of the frame tree, which contains
  40  * the document's scrollbars and contains fixed-positioned elements
  41  */
  42
  43 #ifndef nsViewportFrame_h___
  44 #define nsViewportFrame_h___
  45
  46 #include "nsContainerFrame.h"
  47 #include "nsGkAtoms.h"
  48 #include "nsAbsoluteContainingBlock.h"
  49
  50 class nsPresContext;
  51
  52 /**
  53   * ViewportFrame is the parent of a single child - the doc root frame or a scroll frame
  54   * containing the doc root frame. ViewportFrame stores this child in its primary child
  55   * list. It stores fixed positioned items in a secondary child list and its mFixedContainer
  56   * delegate handles them.
  57   */
  58 class ViewportFrame : public nsContainerFrame {
  59 public:
  60   NS_DECL_FRAMEARENA_HELPERS
  61
  62   typedef nsContainerFrame Super;
  63
  64   ViewportFrame(nsStyleContext* aContext)
  65     : nsContainerFrame(aContext)
  66     , mFixedContainer(nsGkAtoms::fixedList)
  67   {}
  68   virtual ~ViewportFrame() { } // useful for debugging
  69
  70   virtual void DestroyFrom(nsIFrame* aDestructRoot);
  71
  72   NS_IMETHOD Init(nsIContent*      aContent,
  73                   nsIFrame*        aParent,
  74                   nsIFrame*        asPrevInFlow);
  75
  76   NS_IMETHOD SetInitialChildList(nsIAtom*        aListName,
  77                                  nsFrameList&    aChildList);
  78
  79   NS_IMETHOD AppendFrames(nsIAtom*        aListName,
  80                           nsFrameList&    aFrameList);
  81
  82   NS_IMETHOD InsertFrames(nsIAtom*        aListName,
  83                           nsIFrame*       aPrevFrame,
  84                           nsFrameList&    aFrameList);
  85
  86   NS_IMETHOD RemoveFrame(nsIAtom*        aListName,
  87                          nsIFrame*       aOldFrame);
  88
  89   virtual nsIAtom* GetAdditionalChildListName(PRInt32 aIndex) const;
  90
  91   virtual nsFrameList GetChildList(nsIAtom* aListName) const;
  92
  93   NS_IMETHOD BuildDisplayList(nsDisplayListBuilder*   aBuilder,
  94                               const nsRect&           aDirtyRect,
  95                               const nsDisplayListSet& aLists);
  96
  97   virtual nscoord GetMinWidth(nsIRenderingContext *aRenderingContext);
  98   virtual nscoord GetPrefWidth(nsIRenderingContext *aRenderingContext);
  99   NS_IMETHOD Reflow(nsPresContext*          aPresContext,
 100                     nsHTMLReflowMetrics&     aDesiredSize,
 101                     const nsHTMLReflowState& aReflowState,
 102                     nsReflowStatus&          aStatus);
 103
 104   /**
 105    * Get the "type" of the frame
 106    *
 107    * @see nsGkAtoms::viewportFrame
 108    */
 109   virtual nsIAtom* GetType() const;
 110
 111   virtual PRBool IsContainingBlock() const;
 112
 113   virtual void InvalidateInternal(const nsRect& aDamageRect,
 114                                   nscoord aX, nscoord aY, nsIFrame* aForChild,
 115                                   PRUint32 aFlags);
 116
 117 #ifdef DEBUG
 118   NS_IMETHOD GetFrameName(nsAString& aResult) const;
 119 #endif
 120
 121 protected:
 122   nsPoint AdjustReflowStateForScrollbars(nsHTMLReflowState* aReflowState) const;
 123
 124 protected:
 125   // position: fixed content is really content which is absolutely positioned with
 126   // respect to the viewport.
 127   nsAbsoluteContainingBlock mFixedContainer;
 128 };
 129
 130
 131 #endif // nsViewportFrame_h___