Back to index

lightning-sunbird  0.9+nobinonly
nsISVGRendererCanvas.idl
Go to the documentation of this file.
00001 /* -*- Mode: IDL; 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 the Mozilla SVG project.
00016  *
00017  * The Initial Developer of the Original Code is
00018  * Crocodile Clips Ltd.
00019  * Portions created by the Initial Developer are Copyright (C) 2002
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *   Alex Fritze <alex.fritze@crocodile-clips.com> (original author)
00024  *
00025  * Alternatively, the contents of this file may be used under the terms of
00026  * either of the GNU General Public License Version 2 or later (the "GPL"),
00027  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00028  * in which case the provisions of the GPL or the LGPL are applicable instead
00029  * of those above. If you wish to allow use of your version of this file only
00030  * under the terms of either the GPL or the LGPL, and not to allow others to
00031  * use your version of this file under the terms of the MPL, indicate your
00032  * decision by deleting the provisions above and replace them with the notice
00033  * and other provisions required by the GPL or the LGPL. If you do not delete
00034  * the provisions above, a recipient may use your version of this file under
00035  * the terms of any one of the MPL, the GPL or the LGPL.
00036  *
00037  * ***** END LICENSE BLOCK ***** */
00038 
00039 #include "nsISupports.idl"
00040 
00041 
00042 %{C++
00043 struct nsRect;
00044 %}
00045 
00046 [ref] native nsRectRef(nsRect);
00047 
00048 typedef PRUint32 nscolor;
00049 
00050 interface nsIRenderingContext;
00051 interface nsPresContext;
00052 interface nsIDOMSVGMatrix;
00053 interface nsISVGRendererSurface;
00054 
00072 [uuid(2e64a227-de4b-4a69-ab82-5dda1579e90f)]
00073 interface nsISVGRendererCanvas : nsISupports
00074 {
00086   [noscript] nsIRenderingContext lockRenderingContext([const] in nsRectRef rect);
00087 
00092   void unlockRenderingContext();
00093 
00094   // XXX do we need this?
00095   nsPresContext getPresContext();
00096 
00102   void clear(in nscolor color);
00103 
00108   void flush();
00109 
00113   const unsigned short SVG_RENDER_MODE_NORMAL = 0;
00114   const unsigned short SVG_RENDER_MODE_CLIP = 1;
00115   attribute unsigned short renderMode;
00116 
00120   void pushClip();
00121   void popClip();
00122 
00126   void setClipRect(in nsIDOMSVGMatrix canvasTM, in float x, in float y,
00127                    in float width, in float height);
00128 
00132   void pushSurface(in nsISVGRendererSurface surface);
00133   void popSurface();
00134 
00138   void compositeSurface(in nsISVGRendererSurface surface,
00139                         in unsigned long x, in unsigned long y,
00140                         in float opacity);
00141 
00142   void compositeSurfaceMatrix(in nsISVGRendererSurface surface,
00143                               in nsIDOMSVGMatrix canvasTM,
00144                               in float opacity);
00145 };
00146