layout/svg/base/src/nsISVGGlyphFragmentLeaf.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_ISVGGLYPHFRAGMENTLEAF_H__
  40 #define __NS_ISVGGLYPHFRAGMENTLEAF_H__
  41
  42 #include "nsISVGGlyphFragmentNode.h"
  43 #include "nsIDOMSVGLengthList.h"
  44
  45 class nsIDOMSVGPoint;
  46 class nsIDOMSVGRect;
  47 class nsSVGTextPathFrame;
  48
  49
  50 // {ec9a9965-3ff2-4bb5-b0e2-dd8830e9f41a}
  51 #define NS_ISVGGLYPHFRAGMENTLEAF_IID \
  52   { 0xec9a9965, 0x3ff2, 0x4bb5, \
  53     { 0xb0, 0xe2, 0xdd, 0x88, 0x30, 0xe9, 0xf4, 0x1a } }
  54
  55 class nsISVGGlyphFragmentLeaf : public nsISVGGlyphFragmentNode
  56 {
  57 public:
  58
  59   NS_DECLARE_STATIC_IID_ACCESSOR(NS_ISVGGLYPHFRAGMENTLEAF_IID)
  60
  61   NS_IMETHOD GetStartPositionOfChar(PRUint32 charnum, nsIDOMSVGPoint **_retval)=0;
  62   NS_IMETHOD GetEndPositionOfChar(PRUint32 charnum, nsIDOMSVGPoint **_retval)=0;
  63   NS_IMETHOD GetExtentOfChar(PRUint32 charnum, nsIDOMSVGRect **_retval)=0;
  64   NS_IMETHOD GetRotationOfChar(PRUint32 charnum, float *_retval)=0;
  65
  66   enum { BASELINE_ALPHABETIC = 0U };
  67   enum { BASELINE_HANGING = 1U };
  68   enum { BASELINE_IDEOGRAPHC = 2U };
  69   enum { BASELINE_MATHEMATICAL = 3U };
  70   enum { BASELINE_CENTRAL = 4U };
  71   enum { BASELINE_MIDDLE = 5U };
  72   enum { BASELINE_TEXT_BEFORE_EDGE = 6U };
  73   enum { BASELINE_TEXT_AFTER_EDGE = 7U };
  74
  75   NS_IMETHOD_(float) GetBaselineOffset(PRUint16 baselineIdentifier,
  76                                        PRBool aForceGlobalTransform)=0;
  77   NS_IMETHOD_(float) GetAdvance(PRBool aForceGlobalTransform)=0;
  78
  79   NS_IMETHOD_(void) SetGlyphPosition(float x, float y)=0;
  80   NS_IMETHOD_(nsSVGTextPathFrame*) FindTextPathParent()=0;
  81   NS_IMETHOD_(PRBool) IsStartOfChunk()=0; // == is new absolutely positioned chunk.
  82   NS_IMETHOD_(void) GetAdjustedPosition(/* inout */ float &x, /* inout */ float &y)=0;
  83
  84   NS_IMETHOD_(already_AddRefed<nsIDOMSVGLengthList>) GetX()=0;
  85   NS_IMETHOD_(already_AddRefed<nsIDOMSVGLengthList>) GetY()=0;
  86   NS_IMETHOD_(already_AddRefed<nsIDOMSVGLengthList>) GetDx()=0;
  87   NS_IMETHOD_(already_AddRefed<nsIDOMSVGLengthList>) GetDy()=0;
  88   NS_IMETHOD_(PRUint16) GetTextAnchor()=0;
  89   NS_IMETHOD_(PRBool) IsAbsolutelyPositioned()=0;
  90 };
  91
  92 NS_DEFINE_STATIC_IID_ACCESSOR(nsISVGGlyphFragmentLeaf,
  93                               NS_ISVGGLYPHFRAGMENTLEAF_IID)
  94
  95 #endif // __NS_ISVGGLYPHFRAGMENTLEAF_H__