Back to index

lightning-sunbird  0.9+nobinonly
nsScrollPortView.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 
00038 #ifndef nsScrollPortView_h___
00039 #define nsScrollPortView_h___
00040 
00041 #include "nsView.h"
00042 #include "nsIScrollableView.h"
00043 #include "nsCOMPtr.h"
00044 #include "nsITimer.h"
00045 
00046 class nsISupportsArray;
00047 class SmoothScroll;
00048 
00049 //this is a class that acts as a container for other views and provides
00050 //automatic management of scrolling of the views it contains.
00051 
00052 class nsScrollPortView : public nsView, public nsIScrollableView_MOZILLA_1_8_BRANCH
00053 {
00054 public:
00055   nsScrollPortView(nsViewManager* aViewManager = nsnull);
00056 
00057   virtual nsIScrollableView* ToScrollableView() { return this; }
00058 
00059   NS_IMETHOD QueryInterface(REFNSIID aIID,
00060                             void** aInstancePtr);
00061 
00062   NS_IMETHOD  SetWidget(nsIWidget *aWidget);
00063 
00064   //nsIScrollableView interface
00065   NS_IMETHOD  CreateScrollControls(nsNativeWidget aNative = nsnull);
00066   NS_IMETHOD  GetContainerSize(nscoord *aWidth, nscoord *aHeight) const;
00067   NS_IMETHOD  SetScrolledView(nsIView *aScrolledView);
00068   NS_IMETHOD  GetScrolledView(nsIView *&aScrolledView) const;
00069 
00070   NS_IMETHOD  GetScrollPosition(nscoord &aX, nscoord &aY) const;
00071   NS_IMETHOD  ScrollTo(nscoord aX, nscoord aY, PRUint32 aUpdateFlags);
00072   NS_IMETHOD  SetScrollProperties(PRUint32 aProperties);
00073   NS_IMETHOD  GetScrollProperties(PRUint32 *aProperties);
00074   NS_IMETHOD  SetLineHeight(nscoord aHeight);
00075   NS_IMETHOD  GetLineHeight(nscoord *aHeight);
00076   NS_IMETHOD  ScrollByLines(PRInt32 aNumLinesX, PRInt32 aNumLinesY);
00077   NS_IMETHOD  GetPageScrollDistances(nsSize *aDistances);
00078   NS_IMETHOD  ScrollByPages(PRInt32 aNumPagesX, PRInt32 aNumPagesY);
00079   NS_IMETHOD  ScrollByWhole(PRBool aTop);
00080   NS_IMETHOD  ScrollByPixels(PRInt32 aNumPixelsX, PRInt32 aNumPixelsY);
00081   NS_IMETHOD  CanScroll(PRBool aHorizontal, PRBool aForward, PRBool &aResult);
00082 
00083   NS_IMETHOD_(nsIView*) View();
00084 
00085   NS_IMETHOD  AddScrollPositionListener(nsIScrollPositionListener* aListener);
00086   NS_IMETHOD  RemoveScrollPositionListener(nsIScrollPositionListener* aListener);
00087 
00088   // local to the view module
00089 
00090   NS_IMETHOD  Paint(nsIRenderingContext& rc, const nsRect& rect,
00091                     PRUint32 aPaintFlags, PRBool &Result);
00092   NS_IMETHOD  Paint(nsIRenderingContext& aRC, const nsIRegion& aRegion,
00093                     PRUint32 aPaintFlags, PRBool &Result);
00094   nsView*     GetScrolledView() const { return GetFirstChild(); }
00095 
00096 private:
00097   NS_IMETHOD  ScrollToImpl(nscoord aX, nscoord aY, PRUint32 aUpdateFlags);
00098 
00099   // data members
00100   SmoothScroll* mSmoothScroll;
00101 
00102   // methods
00103   void        IncrementalScroll();
00104   PRBool      IsSmoothScrollingEnabled();
00105   static void SmoothScrollAnimationCallback(nsITimer *aTimer, void* aESM);
00106 
00107 protected:
00108   virtual ~nsScrollPortView();
00109 
00110   //private
00111   void Scroll(nsView *aScrolledView, nsPoint aTwipsDelta, nsPoint aPixDelta, float aT2P);
00112   PRBool CannotBitBlt(nsView* aScrolledView);
00113 
00114   nscoord             mOffsetX, mOffsetY;
00115   nscoord             mOffsetXpx, mOffsetYpx;
00116   PRUint32            mScrollProperties;
00117   nscoord             mLineHeight;
00118   nsISupportsArray   *mListeners;
00119 };
00120 
00121 #endif