Back to index

lightning-sunbird  0.9+nobinonly
nsICanvasRenderingContextInternal.h
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 40; 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  *   Vladimir Vukicevic <vladimir@pobox.com>
00019  * Portions created by the Initial Developer are Copyright (C) 2005
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 the GNU General Public License Version 2 or later (the "GPL"), or
00026  * 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 nsICanvasRenderingContextInternal_h___
00039 #define nsICanvasRenderingContextInternal_h___
00040 
00041 #include "nsISupports.h"
00042 #include "nsICanvasElement.h"
00043 #include "nsIInputStream.h"
00044 
00045 // {05150761-22A3-4e8d-A03E-EC53CB731C70}
00046 #define NS_ICANVASRENDERINGCONTEXTINTERNAL_IID \
00047   { 0x5150761, 0x22a3, 0x4e8d, { 0xa0, 0x3e, 0xec, 0x53, 0xcb, 0x73, 0x1c, 0x70 } }
00048 
00049 class nsIRenderingContext;
00050 
00051 struct _cairo_surface;
00052 
00053 class nsICanvasRenderingContextInternal : public nsISupports {
00054 public:
00055   NS_DEFINE_STATIC_IID_ACCESSOR(NS_ICANVASRENDERINGCONTEXTINTERNAL_IID)
00056 
00057   // This method should NOT hold a ref to aParentCanvas; it will be called
00058   // with nsnull when the element is going away.
00059   NS_IMETHOD SetCanvasElement(nsICanvasElement* aParentCanvas) = 0;
00060 
00061   // Sets the dimensions of the canvas, in pixels.  Called
00062   // whenever the size of the element changes.
00063   NS_IMETHOD SetDimensions(PRInt32 width, PRInt32 height) = 0;
00064 
00065   // Render the canvas at the origin of the given nsIRenderingContext
00066   NS_IMETHOD Render(nsIRenderingContext *rc) = 0;
00067 
00068   // Render the canvas at the origin of the given cairo surface
00069   NS_IMETHOD RenderToSurface(struct _cairo_surface *surf) = 0;
00070 
00071   // Gives you a stream containing the image represented by this context.
00072   // The format is given in aMimeTime, for example "image/png".
00073   //
00074   // If the image format does not support transparency or aIncludeTransparency
00075   // is false, alpha will be discarded and the result will be the image
00076   // composited on black.
00077   NS_IMETHOD GetInputStream(const nsACString& aMimeType,
00078                             const nsAString& aEncoderOptions,
00079                             nsIInputStream **aStream) = 0;
00080 };
00081 
00082 #endif /* nsICanvasRenderingContextInternal_h___ */