Back to index

lightning-sunbird  0.9+nobinonly
nsISVGChildFrame.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 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 #ifndef __NS_ISVGCHILDFRAME_H__
00040 #define __NS_ISVGCHILDFRAME_H__
00041 
00042 
00043 #include "nsISupports.h"
00044 #include "nsCOMPtr.h"
00045 #include "nsISVGRendererRegion.h"
00046 
00047 class nsISVGRendererCanvas;
00048 class nsPresContext;
00049 class nsIDOMSVGRect;
00050 struct nsRect;
00051 
00052 #define NS_ISVGCHILDFRAME_IID \
00053 { 0x13c16e09, 0x049d, 0x407c, { 0x91, 0xf2, 0xf0, 0xbc, 0xf1, 0xb3, 0xab, 0x81 } }
00054 
00055 class nsISVGChildFrame : public nsISupports {
00056 public:
00057 
00058   NS_DEFINE_STATIC_IID_ACCESSOR(NS_ISVGCHILDFRAME_IID)
00059 
00060   // XXX Ideally we don't want to pass the dirtyRect along but extract
00061   // it from nsIRenderingContext where needed (only in foreign
00062   // objects) dirtyRectTwips is the unmodified region passed to the
00063   // outer svg frame's ::Paint
00064   NS_IMETHOD PaintSVG(nsISVGRendererCanvas* canvas, const nsRect& dirtyRectTwips)=0;
00065 
00066   // Check if this frame or children contain the given point,
00067   // specified in device pixels relative to the origin of the outer
00068   // svg frame (origin ill-defined in the case of borders - bug
00069   // 290770).  Return value unspecified (usually NS_OK for hit, error
00070   // no hit, but not always [ex: nsSVGPathGeometryFrame.cpp]) and no
00071   // code trusts the return value - this should be fixed (bug 290765).
00072   // *hit set to topmost frame in the children (or 'this' if leaf
00073   // frame) which is accepting pointer events, null if no frame hit.
00074   // See bug 290852 for foreignObject complications.
00075   NS_IMETHOD GetFrameForPointSVG(float x, float y, nsIFrame** hit)=0;
00076 
00077   NS_IMETHOD_(already_AddRefed<nsISVGRendererRegion>) GetCoveredRegion()=0;
00078   NS_IMETHOD InitialUpdate()=0;
00079   NS_IMETHOD NotifyCanvasTMChanged()=0;
00080   NS_IMETHOD NotifyRedrawSuspended()=0;
00081   NS_IMETHOD NotifyRedrawUnsuspended()=0;
00082 
00083   NS_IMETHOD SetMatrixPropagation(PRBool aPropagate)=0;
00084 
00085   // XXX move this function into interface nsISVGLocatableMetrics
00086   NS_IMETHOD GetBBox(nsIDOMSVGRect **_retval)=0; // bbox in local coords
00087 };
00088 
00089 #endif // __NS_ISVGCHILDFRAME_H__
00090