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
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/
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
15 * The Original Code is mozilla.org code.
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.
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.
36 * ***** END LICENSE BLOCK ***** */
39 * rendering object that is the root of the frame tree, which contains
40 * the document's scrollbars and contains fixed-positioned elements
43 #ifndef nsViewportFrame_h___
44 #define nsViewportFrame_h___
46 #include "nsContainerFrame.h"
47 #include "nsGkAtoms.h"
48 #include "nsPresContext.h"
49 #include "nsIPresShell.h"
50 #include "nsAbsoluteContainingBlock.h"
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.
58 class ViewportFrame
: public nsContainerFrame
{
60 typedef nsContainerFrame Super
;
62 ViewportFrame(nsStyleContext
* aContext
)
63 : nsContainerFrame(aContext
)
64 , mFixedContainer(nsGkAtoms::fixedList
)
66 virtual ~ViewportFrame() { } // useful for debugging
68 virtual void Destroy();
70 NS_IMETHOD
Init(nsIContent
* aContent
,
72 nsIFrame
* asPrevInFlow
);
74 NS_IMETHOD
SetInitialChildList(nsIAtom
* aListName
,
75 nsIFrame
* aChildList
);
77 NS_IMETHOD
AppendFrames(nsIAtom
* aListName
,
78 nsIFrame
* aFrameList
);
80 NS_IMETHOD
InsertFrames(nsIAtom
* aListName
,
82 nsIFrame
* aFrameList
);
84 NS_IMETHOD
RemoveFrame(nsIAtom
* aListName
,
87 virtual nsIAtom
* GetAdditionalChildListName(PRInt32 aIndex
) const;
89 virtual nsIFrame
* GetFirstChild(nsIAtom
* aListName
) const;
91 NS_IMETHOD
BuildDisplayList(nsDisplayListBuilder
* aBuilder
,
92 const nsRect
& aDirtyRect
,
93 const nsDisplayListSet
& aLists
);
95 virtual nscoord
GetMinWidth(nsIRenderingContext
*aRenderingContext
);
96 virtual nscoord
GetPrefWidth(nsIRenderingContext
*aRenderingContext
);
97 NS_IMETHOD
Reflow(nsPresContext
* aPresContext
,
98 nsHTMLReflowMetrics
& aDesiredSize
,
99 const nsHTMLReflowState
& aReflowState
,
100 nsReflowStatus
& aStatus
);
103 * Get the "type" of the frame
105 * @see nsGkAtoms::viewportFrame
107 virtual nsIAtom
* GetType() const;
109 virtual PRBool
IsContainingBlock() const;
111 virtual void InvalidateInternal(const nsRect
& aDamageRect
,
112 nscoord aX
, nscoord aY
, nsIFrame
* aForChild
,
116 NS_IMETHOD
GetFrameName(nsAString
& aResult
) const;
120 nsPoint
AdjustReflowStateForScrollbars(nsHTMLReflowState
* aReflowState
) const;
123 // position: fixed content is really content which is absolutely positioned with
124 // respect to the viewport.
125 nsAbsoluteContainingBlock mFixedContainer
;
129 #endif // nsViewportFrame_h___