Back to index

lightning-sunbird  0.9+nobinonly
nsSVGUtils.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 IBM Corporation.
00018  * Portions created by the Initial Developer are Copyright (C) 2005
00019  * the Initial Developer. All Rights Reserved.
00020  *
00021  * Contributor(s):
00022  *
00023  * Alternatively, the contents of this file may be used under the terms of
00024  * either of the GNU General Public License Version 2 or later (the "GPL"),
00025  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00026  * in which case the provisions of the GPL or the LGPL are applicable instead
00027  * of those above. If you wish to allow use of your version of this file only
00028  * under the terms of either the GPL or the LGPL, and not to allow others to
00029  * use your version of this file under the terms of the MPL, indicate your
00030  * decision by deleting the provisions above and replace them with the notice
00031  * and other provisions required by the GPL or the LGPL. If you do not delete
00032  * the provisions above, a recipient may use your version of this file under
00033  * the terms of any one of the MPL, the GPL or the LGPL.
00034  *
00035  * ***** END LICENSE BLOCK ***** */
00036 
00037 #ifndef NS_SVGUTILS_H
00038 #define NS_SVGUTILS_H
00039 
00040 // Need this to get nsPresContext
00041 #include "nsContentUtils.h"
00042 
00043 class nsPresContext;
00044 class nsIContent;
00045 class nsStyleCoord;
00046 class nsIFrame;
00047 struct nsStyleSVGPaint;
00048 class nsIDOMSVGRect;
00049 class nsFrameList;
00050 class nsIDOMSVGLength;
00051 class nsIDOMSVGMatrix;
00052 
00053 typedef struct _cairo cairo_t;
00054 
00055 class nsSVGUtils
00056 {
00057 public:
00058   /* Checks the svg enable preference and if a renderer could
00059    * successfully be created.
00060    */
00061   static PRBool SVGEnabled();
00062 
00063   /*
00064    * Converts a nsStyleCoord into a userspace value.  Handles units
00065    * Factor (straight userspace), Coord (dimensioned), and Percent (of
00066    * the current SVG viewport)
00067    */
00068   static float CoordToFloat(nsPresContext *aPresContext, nsIContent *aContent,
00069                             const nsStyleCoord &aCoord);
00070   /*
00071    * Gets an internal frame for an element referenced by a URI.  Note that this
00072    * only works for URIs that reference elements within the same document.
00073    */
00074   static nsresult GetReferencedFrame(nsIFrame **aRefFrame, nsCAutoString& uriSpec, 
00075                                      nsIContent *aContent, 
00076                                      nsIPresShell *aPresShell);
00077   /*
00078    * For SVGPaint attributes (fills, strokes), return the type of the Paint.  This
00079    * is an expanded type that includes whether this is a solid fill, a gradient, or
00080    * a pattern.
00081    */
00082   static nsresult GetPaintType(PRUint16 *aPaintType, const nsStyleSVGPaint& aPaint, 
00083                                nsIContent *aContent, nsIPresShell *aPresShell);
00084 
00085   /*
00086    * Creates a bounding box by walking the children and doing union.
00087    */
00088   static nsresult GetBBox(nsFrameList *aFrames, nsIDOMSVGRect **_retval);
00089 
00090   /* enum for specifying coordinate direction for ObjectSpace/UserSpace */
00091   enum ctxDirection { X, Y, XY };
00092 
00093   /* Computes the input length in terms of user space coordinates.
00094      Input: content - object to be used for determining user space
00095             length - length to be converted
00096             direction - direction of length
00097   */
00098   static float UserSpace(nsIContent *content,
00099                          nsIDOMSVGLength *length,
00100                          ctxDirection direction);
00101 
00102   /*
00103    * Hit test a given rectangle/matrix.
00104    */
00105   static PRBool
00106   HitTestRect(nsIDOMSVGMatrix *aMatrix,
00107               float aRX, float aRY, float aRWidth, float aRHeight,
00108               float aX, float aY);
00109 
00110   /*
00111    * Convert a rectangle from cairo user space to device space.
00112    */
00113   static void
00114   UserToDeviceBBox(cairo_t *ctx,
00115                    double *xmin, double *ymin,
00116                    double *xmax, double *ymax);
00117 };
00118 
00119 #endif