layout/svg/base/src/nsSVGTextFrame.h

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* ***** BEGIN LICENSE BLOCK *****
   3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   4  *
   5  * The contents of this file are subject to the Mozilla Public License Version
   6  * 1.1 (the "License"); you may not use this file except in compliance with
   7  * the License. You may obtain a copy of the License at
   8  * http://www.mozilla.org/MPL/
   9  *
  10  * Software distributed under the License is distributed on an "AS IS" basis,
  11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12  * for the specific language governing rights and limitations under the
  13  * License.
  14  *
  15  * The Original Code is the Mozilla SVG project.
  16  *
  17  * The Initial Developer of the Original Code is
  18  * Crocodile Clips Ltd..
  19  * Portions created by the Initial Developer are Copyright (C) 2002
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *   Alex Fritze <alex.fritze@crocodile-clips.com> (original author)
  24  *
  25  * Alternatively, the contents of this file may be used under the terms of
  26  * either of the GNU General Public License Version 2 or later (the "GPL"),
  27  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  28  * in which case the provisions of the GPL or the LGPL are applicable instead
  29  * of those above. If you wish to allow use of your version of this file only
  30  * under the terms of either the GPL or the LGPL, and not to allow others to
  31  * use your version of this file under the terms of the MPL, indicate your
  32  * decision by deleting the provisions above and replace them with the notice
  33  * and other provisions required by the GPL or the LGPL. If you do not delete
  34  * the provisions above, a recipient may use your version of this file under
  35  * the terms of any one of the MPL, the GPL or the LGPL.
  36  *
  37  * ***** END LICENSE BLOCK ***** */
  38
  39 #ifndef NS_SVGTEXTFRAME_H
  40 #define NS_SVGTEXTFRAME_H
  41
  42 #include "nsSVGTextContainerFrame.h"
  43
  44 typedef nsSVGTextContainerFrame nsSVGTextFrameBase;
  45
  46 class nsSVGTextFrame : public nsSVGTextFrameBase
  47 {
  48   friend nsIFrame*
  49   NS_NewSVGTextFrame(nsIPresShell* aPresShell, nsIContent* aContent, nsStyleContext* aContext);
  50 protected:
  51   nsSVGTextFrame(nsStyleContext* aContext)
  52     : nsSVGTextFrameBase(aContext),
  53       mMetricsState(unsuspended),
  54       mPositioningDirty(PR_TRUE) {}
  55
  56 public:
  57   // nsIFrame:
  58   NS_IMETHOD  AttributeChanged(PRInt32         aNameSpaceID,
  59                                nsIAtom*        aAttribute,
  60                                PRInt32         aModType);
  61
  62   /**
  63    * Get the "type" of the frame
  64    *
  65    * @see nsGkAtoms::svgTextFrame
  66    */
  67   virtual nsIAtom* GetType() const;
  68
  69 #ifdef DEBUG
  70   NS_IMETHOD GetFrameName(nsAString& aResult) const
  71   {
  72     return MakeFrameName(NS_LITERAL_STRING("SVGText"), aResult);
  73   }
  74 #endif
  75
  76   // nsISVGChildFrame interface:
  77   virtual void NotifySVGChanged(PRUint32 aFlags);
  78   NS_IMETHOD NotifyRedrawSuspended();
  79   NS_IMETHOD NotifyRedrawUnsuspended();
  80   // Override these four to ensure that UpdateGlyphPositioning is called
  81   // to bring glyph positions up to date
  82   NS_IMETHOD PaintSVG(nsSVGRenderState* aContext,
  83                       const nsIntRect *aDirtyRect);
  84   NS_IMETHOD_(nsIFrame*) GetFrameForPoint(const nsPoint & aPoint);
  85   NS_IMETHOD UpdateCoveredRegion();
  86   NS_IMETHOD InitialUpdate();
  87   NS_IMETHOD GetBBox(nsIDOMSVGRect **_retval);
  88
  89   // nsSVGContainerFrame methods:
  90   virtual already_AddRefed<nsIDOMSVGMatrix> GetCanvasTM();
  91
  92   // nsISVGTextContentMetrics
  93   NS_IMETHOD GetNumberOfChars(PRInt32 *_retval);
  94   NS_IMETHOD GetComputedTextLength(float *_retval);
  95   NS_IMETHOD GetSubStringLength(PRUint32 charnum, PRUint32 nchars, float *_retval);
  96   NS_IMETHOD GetStartPositionOfChar(PRUint32 charnum, nsIDOMSVGPoint **_retval);
  97   NS_IMETHOD GetEndPositionOfChar(PRUint32 charnum, nsIDOMSVGPoint **_retval);
  98   NS_IMETHOD GetExtentOfChar(PRUint32 charnum, nsIDOMSVGRect **_retval);
  99   NS_IMETHOD GetRotationOfChar(PRUint32 charnum, float *_retval);
 100   NS_IMETHOD GetCharNumAtPosition(nsIDOMSVGPoint *point, PRInt32 *_retval);
 101
 102   // nsSVGTextFrame
 103   void NotifyGlyphMetricsChange();
 104
 105 private:
 106   /**
 107    * @param aForceGlobalTransform passed down to nsSVGGlyphFrames to
 108    * control whether they should use the global transform even when
 109    * NS_STATE_NONDISPLAY_CHILD
 110    */
 111   void UpdateGlyphPositioning(PRBool aForceGlobalTransform);
 112
 113   nsCOMPtr<nsIDOMSVGMatrix> mCanvasTM;
 114
 115   enum UpdateState { unsuspended, suspended };
 116   UpdateState mMetricsState;
 117
 118   PRPackedBool mPositioningDirty;
 119 };
 120
 121 #endif