Back to index

lightning-sunbird  0.9+nobinonly
nsDrawingSurfaceGTK.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 nsDrawingSurfaceGTK_h___
00039 #define nsDrawingSurfaceGTK_h___
00040 
00041 #include "nsIDrawingSurface.h"
00042 
00043 #include "nsTimer.h"
00044 #include "nsIRegion.h"
00045 #include "nsCOMPtr.h"
00046 
00047 #include <gtk/gtk.h>
00048 
00049 #ifdef MOZ_ENABLE_XFT
00050 typedef struct _XftDraw XftDraw;
00051 #endif
00052 
00053 class nsDrawingSurfaceGTK : public nsIDrawingSurface
00054 {
00055 public:
00056   nsDrawingSurfaceGTK();
00057   virtual ~nsDrawingSurfaceGTK();
00058 
00067   nsresult Init(GdkDrawable *aDrawable, GdkGC *aGC);
00068 
00083   nsresult Init(GdkGC *aGC, PRUint32 aWidth, PRUint32 aHeight,
00084                 PRUint32 aFlags);
00085   
00086   NS_DECL_ISUPPORTS
00087 
00088   //nsIDrawingSurface interface
00089 
00090   NS_IMETHOD Lock(PRInt32 aX, PRInt32 aY, PRUint32 aWidth, PRUint32 aHeight,
00091                   void **aBits, PRInt32 *aStride, PRInt32 *aWidthBytes,
00092                   PRUint32 aFlags);
00093   NS_IMETHOD Unlock(void);
00094   NS_IMETHOD GetDimensions(PRUint32 *aWidth, PRUint32 *aHeight);
00095   NS_IMETHOD IsOffscreen(PRBool *aOffScreen);
00096   NS_IMETHOD IsPixelAddressable(PRBool *aAddressable);
00097   NS_IMETHOD GetPixelFormat(nsPixelFormat *aFormat);
00098 
00099 /* below are utility functions used mostly for nsRenderingContext and nsImage
00100  * to plug into gdk_* functions for drawing.  You should not set a pointer
00101  * that might hang around with the return from these.  instead use the ones
00102  * above.  pav
00103  */
00104   GdkDrawable *GetDrawable(void) { return mPixmap; }
00105 
00106   void GetSize(PRUint32 *aWidth, PRUint32 *aHeight) { *aWidth = mWidth; *aHeight = mHeight; }
00107 
00108   PRInt32 GetDepth() { return mDepth; }
00109 
00110 #ifdef MOZ_ENABLE_XFT
00111   XftDraw *GetXftDraw     (void);
00112   void     GetLastXftClip (nsIRegion **aLastRegion);
00113   void     SetLastXftClip (nsIRegion  *aLastRegion);
00114 #endif /* MOZ_ENABLE_XFT */
00115 
00116 protected:
00117   inline PRUint8 ConvertMaskToCount(unsigned long val);
00118 
00119 private:
00120   /* general */
00121   GdkPixmap   *mPixmap;
00122   GdkGC              *mGC;
00123   gint        mDepth;
00124   nsPixelFormat      mPixFormat;
00125   PRUint32      mWidth;
00126   PRUint32      mHeight;
00127   PRUint32    mFlags;
00128   PRBool      mIsOffscreen;
00129 
00130   /* for locks */
00131   GdkImage    *mImage;
00132   PRInt32     mLockX;
00133   PRInt32     mLockY;
00134   PRUint32    mLockWidth;
00135   PRUint32    mLockHeight;
00136   PRUint32    mLockFlags;
00137   PRBool      mLocked;
00138 
00139 #ifdef MOZ_ENABLE_XFT
00140   XftDraw             *mXftDraw;
00141   nsCOMPtr<nsIRegion>  mLastXftClip;
00142 #endif
00143 
00144   //  MOZ_TIMER_DECLARE(mLockTime)
00145   //  MOZ_TIMER_DECLARE(mUnlockTime)
00146 };
00147 
00148 #endif