/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */ /* ***** BEGIN LICENSE BLOCK ***** * Version: MPL 1.1/GPL 2.0/LGPL 2.1 * * The contents of this file are subject to the Mozilla Public License Version * 1.1 (the "License"); you may not use this file except in compliance with * the License. You may obtain a copy of the License at * http://www.mozilla.org/MPL/ * * Software distributed under the License is distributed on an "AS IS" basis, * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License * for the specific language governing rights and limitations under the * License. * * The Original Code is Mozilla Communicator client code. * * The Initial Developer of the Original Code is * Netscape Communications Corporation. * Portions created by the Initial Developer are Copyright (C) 1998 * the Initial Developer. All Rights Reserved. * * Contributor(s): * * Alternatively, the contents of this file may be used under the terms of * either of the GNU General Public License Version 2 or later (the "GPL"), * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"), * in which case the provisions of the GPL or the LGPL are applicable instead * of those above. If you wish to allow use of your version of this file only * under the terms of either the GPL or the LGPL, and not to allow others to * use your version of this file under the terms of the MPL, indicate your * decision by deleting the provisions above and replace them with the notice * and other provisions required by the GPL or the LGPL. If you do not delete * the provisions above, a recipient may use your version of this file under * the terms of any one of the MPL, the GPL or the LGPL. * * ***** END LICENSE BLOCK ***** */ /* rendering object to wrap rendering objects that should be scrollable */ #ifndef nsGfxScrollFrame_h___ #define nsGfxScrollFrame_h___ #include "nsHTMLContainerFrame.h" #include "nsIAnonymousContentCreator.h" #include "nsBoxFrame.h" #include "nsIScrollableFrame.h" #include "nsIScrollPositionListener.h" #include "nsIStatefulFrame.h" #include "nsThreadUtils.h" #include "nsIScrollableView.h" #include "nsIView.h" #include "nsIReflowCallback.h" #include "nsBoxLayoutState.h" class nsPresContext; class nsIPresShell; class nsIContent; class nsIAtom; class nsIDocument; class nsIScrollFrameInternal; class nsPresState; struct ScrollReflowState; class nsGfxScrollFrameInner : public nsIScrollPositionListener, public nsIReflowCallback { public: NS_IMETHOD QueryInterface(REFNSIID aIID, void** aInstancePtr); NS_IMETHOD_(nsrefcnt) AddRef(void) { return 2; } NS_IMETHOD_(nsrefcnt) Release(void) { return 1; } nsGfxScrollFrameInner(nsContainerFrame* aOuter, PRBool aIsRoot, PRBool aIsXUL); ~nsGfxScrollFrameInner(); typedef nsIScrollableFrame::ScrollbarStyles ScrollbarStyles; ScrollbarStyles GetScrollbarStylesFromFrame() const; // If a child frame was added or removed on the scrollframe, // reload our child frame list. // We need this if a scrollbar frame is recreated. void ReloadChildFrames(); void CreateScrollableView(); nsresult CreateAnonymousContent(nsTArray& aElements); nsresult FireScrollPortEvent(); void PostOverflowEvent(); void Destroy(); nsresult BuildDisplayList(nsDisplayListBuilder* aBuilder, const nsRect& aDirtyRect, const nsDisplayListSet& aLists); // nsIReflowCallback virtual PRBool ReflowFinished(); virtual void ReflowCallbackCanceled(); // nsIScrollPositionListener NS_IMETHOD ScrollPositionWillChange(nsIScrollableView* aScrollable, nscoord aX, nscoord aY); virtual void ViewPositionDidChange(nsIScrollableView* aScrollable, nsTArray* aConfigurations); NS_IMETHOD ScrollPositionDidChange(nsIScrollableView* aScrollable, nscoord aX, nscoord aY); // This gets called when the 'curpos' attribute on one of the scrollbars changes void CurPosAttributeChanged(nsIContent* aChild); void PostScrollEvent(); void FireScrollEvent(); class ScrollEvent : public nsRunnable { public: NS_DECL_NSIRUNNABLE ScrollEvent(nsGfxScrollFrameInner *inner) : mInner(inner) {} void Revoke() { mInner = nsnull; } private: nsGfxScrollFrameInner *mInner; }; class AsyncScrollPortEvent : public nsRunnable { public: NS_DECL_NSIRUNNABLE AsyncScrollPortEvent(nsGfxScrollFrameInner *inner) : mInner(inner) {} void Revoke() { mInner = nsnull; } private: nsGfxScrollFrameInner *mInner; }; static void FinishReflowForScrollbar(nsIContent* aContent, nscoord aMinXY, nscoord aMaxXY, nscoord aCurPosXY, nscoord aPageIncrement, nscoord aIncrement); static void SetScrollbarEnabled(nsIContent* aContent, nscoord aMaxPos); static void SetCoordAttribute(nsIContent* aContent, nsIAtom* aAtom, nscoord aSize); nscoord GetCoordAttribute(nsIBox* aFrame, nsIAtom* atom, nscoord defaultValue); // Like ScrollPositionDidChange, but initiated by this frame rather than from the // scrolling view void InternalScrollPositionDidChange(nscoord aX, nscoord aY); nsIScrollableView* GetScrollableView() const { return mScrollableView; } nsIView* GetParentViewForChildFrame(nsIFrame* aFrame) const; void ScrollToRestoredPosition(); nsPresState* SaveState(nsIStatefulFrame::SpecialStateID aStateID); void RestoreState(nsPresState* aState); void SaveVScrollbarStateToGlobalHistory(); nsresult GetVScrollbarHintFromGlobalHistory(PRBool* aVScrollbarNeeded); nsIFrame* GetScrolledFrame() const { return mScrolledFrame; } void ScrollbarChanged(nsPresContext* aPresContext, nscoord aX, nscoord aY, PRUint32 aFlags); static void SetScrollbarVisibility(nsIBox* aScrollbar, PRBool aVisible); /** * GetScrolledRect is designed to encapsulate deciding which * directions of overflow should be reachable by scrolling and which * should not. Callers should NOT depend on it having any particular * behavior (although nsXULScrollFrame currently does). * * Currently it allows scrolling down and to the right for * nsHTMLScrollFrames with LTR directionality and for all * nsXULScrollFrames, and allows scrolling down and to the left for * nsHTMLScrollFrames with RTL directionality. */ nsRect GetScrolledRect(const nsSize& aScrollPortSize) const; nsSize GetScrollPortSize() const { return mScrollableView->View()->GetBounds().Size(); } nsMargin GetActualScrollbarSizes() const; nsMargin GetDesiredScrollbarSizes(nsBoxLayoutState* aState); PRBool IsLTR() const; PRBool IsScrollbarOnRight() const; void LayoutScrollbars(nsBoxLayoutState& aState, const nsRect& aContentArea, const nsRect& aOldScrollArea, const nsRect& aScrollArea); // owning references to the nsIAnonymousContentCreator-built content nsCOMPtr mHScrollbarContent; nsCOMPtr mVScrollbarContent; nsCOMPtr mScrollCornerContent; nsRevocableEventPtr mScrollEvent; nsRevocableEventPtr mAsyncScrollPortEvent; nsIScrollableView* mScrollableView; nsIBox* mHScrollbarBox; nsIBox* mVScrollbarBox; nsIFrame* mScrolledFrame; nsIBox* mScrollCornerBox; nsContainerFrame* mOuter; nsRect mRestoreRect; nsPoint mLastPos; PRPackedBool mNeverHasVerticalScrollbar:1; PRPackedBool mNeverHasHorizontalScrollbar:1; PRPackedBool mHasVerticalScrollbar:1; PRPackedBool mHasHorizontalScrollbar:1; PRPackedBool mViewInitiatedScroll:1; PRPackedBool mFrameInitiatedScroll:1; PRPackedBool mDidHistoryRestore:1; // Is this the scrollframe for the document's viewport? PRPackedBool mIsRoot:1; // Is mOuter an nsXULScrollFrame? PRPackedBool mIsXUL:1; // If true, don't try to layout the scrollbars in Reflow(). This can be // useful if multiple passes are involved, because we don't want to place the // scrollbars at the wrong size. PRPackedBool mSupppressScrollbarUpdate:1; // If true, we skipped a scrollbar layout due to mSupppressScrollbarUpdate // being set at some point. That means we should lay out scrollbars even if // it might not strictly be needed next time mSupppressScrollbarUpdate is // false. PRPackedBool mSkippedScrollbarLayout:1; // Did we load a hint from global history // about whether a vertical scrollbar is required? PRPackedBool mDidLoadHistoryVScrollbarHint:1; // The value of the hint loaded PRPackedBool mHistoryVScrollbarHint:1; PRPackedBool mHadNonInitialReflow:1; // State used only by PostScrollEvents so we know // which overflow states have changed. PRPackedBool mHorizontalOverflow:1; PRPackedBool mVerticalOverflow:1; PRPackedBool mPostedReflowCallback:1; PRPackedBool mMayHaveDirtyFixedChildren:1; // If true, need to actually update our scrollbar attributes in the // reflow callback. PRPackedBool mUpdateScrollbarAttributes:1; }; /** * The scroll frame creates and manages the scrolling view * * It only supports having a single child frame that typically is an area * frame, but doesn't have to be. The child frame must have a view, though * * Scroll frames don't support incremental changes, i.e. you can't replace * or remove the scrolled frame */ class nsHTMLScrollFrame : public nsHTMLContainerFrame, public nsIScrollableFrame, public nsIAnonymousContentCreator, public nsIStatefulFrame { public: friend nsIFrame* NS_NewHTMLScrollFrame(nsIPresShell* aPresShell, nsStyleContext* aContext, PRBool aIsRoot); NS_DECL_QUERYFRAME // Called to set the child frames. We typically have three: the scroll area, // the vertical scrollbar, and the horizontal scrollbar. NS_IMETHOD SetInitialChildList(nsIAtom* aListName, nsIFrame* aChildList); NS_IMETHOD BuildDisplayList(nsDisplayListBuilder* aBuilder, const nsRect& aDirtyRect, const nsDisplayListSet& aLists) { return mInner.BuildDisplayList(aBuilder, aDirtyRect, aLists); } PRBool TryLayout(ScrollReflowState* aState, nsHTMLReflowMetrics* aKidMetrics, PRBool aAssumeVScroll, PRBool aAssumeHScroll, PRBool aForce, nsresult* aResult); PRBool ScrolledContentDependsOnHeight(ScrollReflowState* aState); nsresult ReflowScrolledFrame(ScrollReflowState* aState, PRBool aAssumeHScroll, PRBool aAssumeVScroll, nsHTMLReflowMetrics* aMetrics, PRBool aFirstPass); nsresult ReflowContents(ScrollReflowState* aState, const nsHTMLReflowMetrics& aDesiredSize); void PlaceScrollArea(const ScrollReflowState& aState); nscoord GetIntrinsicVScrollbarWidth(nsIRenderingContext *aRenderingContext); virtual nscoord GetMinWidth(nsIRenderingContext *aRenderingContext); virtual nscoord GetPrefWidth(nsIRenderingContext *aRenderingContext); NS_IMETHOD GetPadding(nsMargin& aPadding); virtual PRBool IsCollapsed(nsBoxLayoutState& aBoxLayoutState); NS_IMETHOD Reflow(nsPresContext* aPresContext, nsHTMLReflowMetrics& aDesiredSize, const nsHTMLReflowState& aReflowState, nsReflowStatus& aStatus); // Because there can be only one child frame, these two function return // NS_ERROR_FAILURE NS_IMETHOD AppendFrames(nsIAtom* aListName, nsIFrame* aFrameList); NS_IMETHOD InsertFrames(nsIAtom* aListName, nsIFrame* aPrevFrame, nsIFrame* aFrameList); virtual void Destroy(); NS_IMETHOD RemoveFrame(nsIAtom* aListName, nsIFrame* aOldFrame); virtual nsIView* GetParentViewForChildFrame(nsIFrame* aFrame) const { return mInner.GetParentViewForChildFrame(aFrame); } virtual nsIFrame* GetContentInsertionFrame() { return mInner.GetScrolledFrame()->GetContentInsertionFrame(); } virtual nsIView* GetMouseCapturer() const { return mInner.GetScrolledFrame()->GetView(); } virtual void InvalidateInternal(const nsRect& aDamageRect, nscoord aX, nscoord aY, nsIFrame* aForChild, PRUint32 aFlags); virtual PRBool NeedsView() { return PR_TRUE; } virtual PRBool DoesClipChildren() { return PR_TRUE; } virtual nsSplittableType GetSplittableType() const; virtual nsPoint GetPositionOfChildIgnoringScrolling(nsIFrame* aChild) { nsPoint pt = aChild->GetPosition(); if (aChild == mInner.GetScrolledFrame()) pt += GetScrollPosition(); return pt; } // nsIAnonymousContentCreator virtual nsresult CreateAnonymousContent(nsTArray& aElements); // nsIScrollableFrame virtual nsIFrame* GetScrolledFrame() const; virtual nsIScrollableView* GetScrollableView(); virtual nsPoint GetScrollPosition() const; virtual void ScrollTo(nsPoint aScrollPosition, PRUint32 aFlags); virtual void SetScrollbarVisibility(PRBool aVerticalVisible, PRBool aHorizontalVisible); virtual nsIBox* GetScrollbarBox(PRBool aVertical); virtual void CurPosAttributeChanged(nsIContent* aChild, PRInt32 aModType); // nsIStatefulFrame NS_IMETHOD SaveState(SpecialStateID aStateID, nsPresState** aState) { NS_ENSURE_ARG_POINTER(aState); *aState = mInner.SaveState(aStateID); return NS_OK; } NS_IMETHOD RestoreState(nsPresState* aState) { NS_ENSURE_ARG_POINTER(aState); mInner.RestoreState(aState); return NS_OK; } virtual void ScrollToRestoredPosition() { mInner.ScrollToRestoredPosition(); } virtual nsMargin GetActualScrollbarSizes() const { return mInner.GetActualScrollbarSizes(); } virtual nsMargin GetDesiredScrollbarSizes(nsBoxLayoutState* aState); virtual nsMargin GetDesiredScrollbarSizes(nsPresContext* aPresContext, nsIRenderingContext* aRC) { nsBoxLayoutState bls(aPresContext, aRC, 0); return GetDesiredScrollbarSizes(&bls); } virtual nsGfxScrollFrameInner::ScrollbarStyles GetScrollbarStyles() const; /** * Get the "type" of the frame * * @see nsGkAtoms::scrollFrame */ virtual nsIAtom* GetType() const; #ifdef NS_DEBUG NS_IMETHOD GetFrameName(nsAString& aResult) const; #endif PRBool DidHistoryRestore() { return mInner.mDidHistoryRestore; } #ifdef ACCESSIBILITY NS_IMETHOD GetAccessible(nsIAccessible** aAccessible); #endif protected: nsHTMLScrollFrame(nsIPresShell* aShell, nsStyleContext* aContext, PRBool aIsRoot); virtual PRIntn GetSkipSides() const; void SetSuppressScrollbarUpdate(PRBool aSuppress) { mInner.mSupppressScrollbarUpdate = aSuppress; } PRBool GuessHScrollbarNeeded(const ScrollReflowState& aState); PRBool GuessVScrollbarNeeded(const ScrollReflowState& aState); nsSize GetScrollPortSize() const { return mInner.GetScrollPortSize(); } PRBool IsScrollbarUpdateSuppressed() const { return mInner.mSupppressScrollbarUpdate; } // Return whether we're in an "initial" reflow. Some reflows with // NS_FRAME_FIRST_REFLOW set are NOT "initial" as far as we're concerned. PRBool InInitialReflow() const; /** * Override this to return false if computed height/min-height/max-height * should NOT be propagated to child content. * nsListControlFrame uses this. */ virtual PRBool ShouldPropagateComputedHeightToScrolledContent() const { return PR_TRUE; } private: friend class nsGfxScrollFrameInner; nsGfxScrollFrameInner mInner; }; /** * The scroll frame creates and manages the scrolling view * * It only supports having a single child frame that typically is an area * frame, but doesn't have to be. The child frame must have a view, though * * Scroll frames don't support incremental changes, i.e. you can't replace * or remove the scrolled frame */ class nsXULScrollFrame : public nsBoxFrame, public nsIScrollableFrame, public nsIAnonymousContentCreator, public nsIStatefulFrame { public: NS_DECL_QUERYFRAME friend nsIFrame* NS_NewXULScrollFrame(nsIPresShell* aPresShell, nsStyleContext* aContext, PRBool aIsRoot); // Called to set the child frames. We typically have three: the scroll area, // the vertical scrollbar, and the horizontal scrollbar. NS_IMETHOD SetInitialChildList(nsIAtom* aListName, nsIFrame* aChildList); NS_IMETHOD BuildDisplayList(nsDisplayListBuilder* aBuilder, const nsRect& aDirtyRect, const nsDisplayListSet& aLists) { return mInner.BuildDisplayList(aBuilder, aDirtyRect, aLists); } // XXXldb Is this actually used? #if 0 virtual nscoord GetMinWidth(nsIRenderingContext *aRenderingContext); #endif // Because there can be only one child frame, these two function return // NS_ERROR_FAILURE NS_IMETHOD AppendFrames(nsIAtom* aListName, nsIFrame* aFrameList); NS_IMETHOD InsertFrames(nsIAtom* aListName, nsIFrame* aPrevFrame, nsIFrame* aFrameList); virtual void Destroy(); NS_IMETHOD RemoveFrame(nsIAtom* aListName, nsIFrame* aOldFrame); virtual nsIView* GetParentViewForChildFrame(nsIFrame* aFrame) const { return mInner.GetParentViewForChildFrame(aFrame); } virtual nsIFrame* GetContentInsertionFrame() { return mInner.GetScrolledFrame()->GetContentInsertionFrame(); } virtual nsIView* GetMouseCapturer() const { return mInner.GetScrolledFrame()->GetView(); } virtual void InvalidateInternal(const nsRect& aDamageRect, nscoord aX, nscoord aY, nsIFrame* aForChild, PRUint32 aFlags); virtual PRBool NeedsView() { return PR_TRUE; } virtual PRBool DoesClipChildren() { return PR_TRUE; } virtual nsSplittableType GetSplittableType() const; virtual nsPoint GetPositionOfChildIgnoringScrolling(nsIFrame* aChild) { nsPoint pt = aChild->GetPosition(); if (aChild == mInner.GetScrolledFrame()) pt += GetScrollPosition(); return pt; } // nsIAnonymousContentCreator virtual nsresult CreateAnonymousContent(nsTArray& aElements); virtual nsSize GetMinSize(nsBoxLayoutState& aBoxLayoutState); virtual nsSize GetPrefSize(nsBoxLayoutState& aBoxLayoutState); virtual nsSize GetMaxSize(nsBoxLayoutState& aBoxLayoutState); virtual nscoord GetBoxAscent(nsBoxLayoutState& aBoxLayoutState); NS_IMETHOD DoLayout(nsBoxLayoutState& aBoxLayoutState); NS_IMETHOD GetPadding(nsMargin& aPadding); nsresult Layout(nsBoxLayoutState& aState); void LayoutScrollArea(nsBoxLayoutState& aState, const nsRect& aRect); static PRBool AddRemoveScrollbar(PRBool& aHasScrollbar, nscoord& aXY, nscoord& aSize, nscoord aSbSize, PRBool aOnRightOrBottom, PRBool aAdd); PRBool AddRemoveScrollbar(nsBoxLayoutState& aState, nsRect& aScrollAreaSize, PRBool aOnTop, PRBool aHorizontal, PRBool aAdd); PRBool AddHorizontalScrollbar (nsBoxLayoutState& aState, nsRect& aScrollAreaSize, PRBool aOnBottom); PRBool AddVerticalScrollbar (nsBoxLayoutState& aState, nsRect& aScrollAreaSize, PRBool aOnRight); void RemoveHorizontalScrollbar(nsBoxLayoutState& aState, nsRect& aScrollAreaSize, PRBool aOnBottom); void RemoveVerticalScrollbar (nsBoxLayoutState& aState, nsRect& aScrollAreaSize, PRBool aOnRight); static void AdjustReflowStateForPrintPreview(nsBoxLayoutState& aState, PRBool& aSetBack); static void AdjustReflowStateBack(nsBoxLayoutState& aState, PRBool aSetBack); // nsIScrollableFrame virtual nsIFrame* GetScrolledFrame() const; virtual nsIScrollableView* GetScrollableView(); virtual nsPoint GetScrollPosition() const; virtual void ScrollTo(nsPoint aScrollPosition, PRUint32 aFlags); virtual void SetScrollbarVisibility(PRBool aVerticalVisible, PRBool aHorizontalVisible); virtual nsIBox* GetScrollbarBox(PRBool aVertical); virtual void CurPosAttributeChanged(nsIContent* aChild, PRInt32 aModType); // nsIStatefulFrame NS_IMETHOD SaveState(SpecialStateID aStateID, nsPresState** aState) { NS_ENSURE_ARG_POINTER(aState); *aState = mInner.SaveState(aStateID); return NS_OK; } NS_IMETHOD RestoreState(nsPresState* aState) { NS_ENSURE_ARG_POINTER(aState); mInner.RestoreState(aState); return NS_OK; } virtual void ScrollToRestoredPosition() { mInner.ScrollToRestoredPosition(); } virtual nsMargin GetActualScrollbarSizes() const { return mInner.GetActualScrollbarSizes(); } virtual nsMargin GetDesiredScrollbarSizes(nsBoxLayoutState* aState); virtual nsMargin GetDesiredScrollbarSizes(nsPresContext* aPresContext, nsIRenderingContext* aRC) { nsBoxLayoutState bls(aPresContext, aRC, 0); return GetDesiredScrollbarSizes(&bls); } virtual nsGfxScrollFrameInner::ScrollbarStyles GetScrollbarStyles() const; /** * Get the "type" of the frame * * @see nsGkAtoms::scrollFrame */ virtual nsIAtom* GetType() const; virtual PRBool IsFrameOfType(PRUint32 aFlags) const { // Override bogus IsFrameOfType in nsBoxFrame. if (aFlags & (nsIFrame::eReplacedContainsBlock | nsIFrame::eReplaced)) return PR_FALSE; return nsBoxFrame::IsFrameOfType(aFlags); } #ifdef NS_DEBUG NS_IMETHOD GetFrameName(nsAString& aResult) const; #endif protected: nsXULScrollFrame(nsIPresShell* aShell, nsStyleContext* aContext, PRBool aIsRoot); virtual PRIntn GetSkipSides() const; private: friend class nsGfxScrollFrameInner; nsGfxScrollFrameInner mInner; }; #endif /* nsGfxScrollFrame_h___ */