/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */ /* ***** BEGIN LICENSE BLOCK ***** * Version: NPL 1.1/GPL 2.0/LGPL 2.1 * * The contents of this file are subject to the Netscape 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/NPL/ * * 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.org 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 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 NPL, 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 NPL, the GPL or the LGPL. * * ***** END LICENSE BLOCK ***** */ #ifndef nsIScrollFrame_h___ #define nsIScrollFrame_h___ #include "nsISupports.h" #include "nsCoord.h" #include "nsIViewManager.h" class nsIFrame; class nsIBox; class nsIPresContext; // IID for the nsIScrollableFrame interface #define NS_ISCROLLABLE_FRAME_IID \ { 0xc95f1831, 0xc372, 0x11d1, \ { 0xb7, 0x21, 0x0, 0x64, 0x9, 0x92, 0xd8, 0xc9 } } class nsIScrollableFrame : public nsISupports { public: enum nsScrollPref { Auto = 0, NeverScroll, AlwaysScroll, AlwaysScrollVertical, AlwaysScrollHorizontal }; NS_DEFINE_STATIC_IID_ACCESSOR(NS_ISCROLLABLE_FRAME_IID) /** * Set the frame that we are scrolling within the scrolling frame. */ NS_IMETHOD SetScrolledFrame(nsIPresContext* aPresContext, nsIFrame *aScrolledFrame) = 0; /** * Get the frame that we are scrolling within the scrollable frame. * @result child frame */ NS_IMETHOD GetScrolledFrame(nsIPresContext* aPresContext, nsIFrame *&aScrolledFrame) const = 0; /** * Gets the size of the area that lies inside the scrollbars but clips the scrolled frame */ NS_IMETHOD GetClipSize(nsIPresContext* aPresContext, nscoord *aWidth, nscoord *aHeight) const = 0; /** * Get information about whether the vertical and horizontal scrollbars * are currently visible */ NS_IMETHOD GetScrollbarVisibility(nsIPresContext* aPresContext, PRBool *aVerticalVisible, PRBool *aHorizontalVisible) const = 0; /** * Query whether scroll bars should be displayed all the time, never or * only when necessary. * @return current scrollbar selection */ NS_IMETHOD GetScrollPreference(nsIPresContext* aPresContext, nsScrollPref* aScrollPreference) const = 0; /** * Gets the vertical width and horizontal height of the scrollbars. */ NS_IMETHOD GetScrollbarSizes(nsIPresContext* aPresContext, nscoord *aVbarWidth, nscoord *aHbarHeight) const = 0; /** * Get the position of the scrolled view. */ NS_IMETHOD GetScrollPosition(nsIPresContext* aContext, nscoord &aX, nscoord& aY) const=0; /** * Scroll the view to the given x,y, update's the scrollbar's thumb * positions and the view's offset. Clamps the values to be * legal. Updates the display based on aUpdateFlags. * @param aX left edge to scroll to * @param aY top edge to scroll to * @param aUpdateFlags passed onto nsIViewManager->UpdateView() * @return error status */ NS_IMETHOD ScrollTo(nsIPresContext* aContext, nscoord aX, nscoord aY, PRUint32 aFlags = NS_VMREFRESH_NO_SYNC)=0; NS_IMETHOD GetScrollableView(nsIPresContext* aContext, nsIScrollableView** aResult)=0; /** * Set information about whether the vertical and horizontal scrollbars * are currently visible */ NS_IMETHOD SetScrollbarVisibility(nsIPresContext* aPresContext, PRBool aVerticalVisible, PRBool aHorizontalVisible) = 0; NS_IMETHOD GetScrollbarBox(PRBool aVertical, nsIBox** aResult) = 0; }; #endif