layout/svg/nsSVGTextPathFrame.h

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* This Source Code Form is subject to the terms of the Mozilla Public
   3  * License, v. 2.0. If a copy of the MPL was not distributed with this
   4  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   5
   6 #ifndef NSSVGTEXTPATHFRAME_H
   7 #define NSSVGTEXTPATHFRAME_H
   8
   9 #include "gfxTypes.h"
  10 #include "nsCOMPtr.h"
  11 #include "nsFrame.h"
  12 #include "nsISVGChildFrame.h"
  13 #include "nsLiteralString.h"
  14 #include "nsQueryFrame.h"
  15 #include "nsSVGTSpanFrame.h"
  16
  17 class gfxFlattenedPath;
  18 class nsIAtom;
  19 class nsIContent;
  20 class nsIFrame;
  21 class nsIPresShell;
  22 class nsStyleContext;
  23
  24 namespace mozilla {
  25 class SVGNumberList;
  26 }
  27
  28 typedef nsSVGTSpanFrame nsSVGTextPathFrameBase;
  29
  30 class nsSVGTextPathFrame : public nsSVGTextPathFrameBase
  31 {
  32   typedef mozilla::SVGNumberList SVGNumberList;
  33
  34   friend nsIFrame*
  35   NS_NewSVGTextPathFrame(nsIPresShell* aPresShell, nsStyleContext* aContext);
  36 protected:
  37   nsSVGTextPathFrame(nsStyleContext* aContext) : nsSVGTextPathFrameBase(aContext) {}
  38
  39 public:
  40   NS_DECL_FRAMEARENA_HELPERS
  41
  42   // nsIFrame:
  43 #ifdef DEBUG
  44   virtual void Init(nsIContent*      aContent,
  45                     nsIFrame*        aParent,
  46                     nsIFrame*        aPrevInFlow) MOZ_OVERRIDE;
  47 #endif
  48
  49   NS_IMETHOD  AttributeChanged(int32_t         aNameSpaceID,
  50                                nsIAtom*        aAttribute,
  51                                int32_t         aModType);
  52   /**
  53    * Get the "type" of the frame
  54    *
  55    * @see nsGkAtoms::svgGFrame
  56    */
  57   virtual nsIAtom* GetType() const;
  58
  59 #ifdef DEBUG
  60   NS_IMETHOD GetFrameName(nsAString& aResult) const
  61   {
  62     return MakeFrameName(NS_LITERAL_STRING("SVGTextPath"), aResult);
  63   }
  64 #endif
  65
  66   // nsSVGTextPathFrame methods:
  67   already_AddRefed<gfxFlattenedPath> GetFlattenedPath();
  68   nsIFrame *GetPathFrame();
  69
  70   /**
  71    * Gets the scale by which offsets along this textPath must be scaled. This
  72    * scaling is due to the user provided 'pathLength' attribute on the <path>
  73    * element, which is a user provided estimate of the path length.
  74    */
  75   gfxFloat GetOffsetScale();
  76
  77   /**
  78    * Gets the offset from the start of the path at which the first character
  79    * should be positioned. The value returned already takes GetOffsetScale
  80    * into account.
  81    */
  82   gfxFloat GetStartOffset();
  83
  84 protected:
  85
  86   virtual void GetXY(SVGUserUnitList *aX, SVGUserUnitList *aY);
  87   virtual void GetDxDy(SVGUserUnitList *aDx, SVGUserUnitList *aDy);
  88   virtual const SVGNumberList *GetRotate();
  89 };
  90
  91 #endif