third_party/WebKit/Source/core/svg/SVGSVGElement.idl

   1 /*
   2  * Copyright (C) 2004, 2005 Nikolas Zimmermann <zimmermann@kde.org>
   3  * Copyright (C) 2004, 2005, 2010 Rob Buis <buis@kde.org>
   4  * Copyright (C) 2006 Samuel Weinig <sam.weinig@gmail.com>
   5  * Copyright (C) 2006 Apple Inc. All rights reserved.
   6  *
   7  * This library is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Library General Public
   9  * License as published by the Free Software Foundation; either
  10  * version 2 of the License, or (at your option) any later version.
  11  *
  12  * This library is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * Library General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Library General Public License
  18  * along with this library; see the file COPYING.LIB.  If not, write to
  19  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  20  * Boston, MA 02110-1301, USA.
  21  */
  22
  23 // http://www.w3.org/TR/SVG2/struct.html#InterfaceSVGSVGElement
  24
  25 [
  26     TypeChecking=Interface,
  27 ] interface SVGSVGElement : SVGGraphicsElement {
  28
  29     [RuntimeEnabled=SVG1DOM, MeasureAs=SVG1DOM] readonly attribute SVGAnimatedLength x;
  30     [RuntimeEnabled=SVG1DOM, MeasureAs=SVG1DOM] readonly attribute SVGAnimatedLength y;
  31     [RuntimeEnabled=SVG1DOM, MeasureAs=SVG1DOM] readonly attribute SVGAnimatedLength width;
  32     [RuntimeEnabled=SVG1DOM, MeasureAs=SVG1DOM] readonly attribute SVGAnimatedLength height;
  33     // TODO(philipj): viewport should be a DOMRectReadOnly.
  34     readonly attribute SVGRect viewport;
  35     // TODO(philipj): useCurrentView and currentView have been removed:
  36     // https://github.com/w3c/svgwg/commit/4c26fd36937a65192024208d85c144a21071b057
  37     [Measure] readonly attribute boolean useCurrentView;
  38     [Measure] readonly attribute SVGViewSpec currentView;
  39              attribute float currentScale;
  40     // TODO(philipj): currentTranslate should be a DOMPointReadOnly.
  41     [ImplementedAs=currentTranslateFromJavascript] readonly attribute SVGPoint currentTranslate;
  42
  43     [RuntimeEnabled=SVG1DOM, DeprecateAs=SVGSVGElementSuspendRedraw] unsigned long suspendRedraw(unsigned long maxWaitMilliseconds);
  44     [RuntimeEnabled=SVG1DOM, DeprecateAs=SVGSVGElementUnsuspendRedraw] void unsuspendRedraw(unsigned long suspendHandleId);
  45     [RuntimeEnabled=SVG1DOM, DeprecateAs=SVGSVGElementUnsuspendRedrawAll] void unsuspendRedrawAll();
  46     [RuntimeEnabled=SVG1DOM, DeprecateAs=SVGSVGElementForceRedraw] void forceRedraw();
  47
  48     [RuntimeEnabled=smil] void pauseAnimations();
  49     [RuntimeEnabled=smil] void unpauseAnimations();
  50     [RuntimeEnabled=smil] boolean animationsPaused();
  51     [RuntimeEnabled=smil] float getCurrentTime();
  52     [RuntimeEnabled=smil] void setCurrentTime(float seconds);
  53
  54     // TODO(philipj): The rect arguments should be DOMRectReadOnly.
  55     NodeList getIntersectionList(SVGRect rect, SVGElement? referenceElement);
  56     NodeList getEnclosureList(SVGRect rect, SVGElement? referenceElement);
  57     boolean checkIntersection(SVGElement element, SVGRect rect);
  58     boolean checkEnclosure(SVGElement element, SVGRect rect);
  59     void deselectAll();
  60     [RuntimeEnabled=SVG1DOM, MeasureAs=SVG1DOM] SVGNumber createSVGNumber();
  61     [RuntimeEnabled=SVG1DOM, MeasureAs=SVG1DOM] SVGLength createSVGLength();
  62     [RuntimeEnabled=SVG1DOM, MeasureAs=SVG1DOM] SVGAngle createSVGAngle();
  63     // TODO(philipj): SVGPoint/Matrix/Rect should be DOMPoint/Matrix/Rect.
  64     [RuntimeEnabled=SVG1DOM, MeasureAs=SVG1DOM] SVGPoint createSVGPoint();
  65     [RuntimeEnabled=SVG1DOM, MeasureAs=SVG1DOM] SVGMatrix createSVGMatrix();
  66     [RuntimeEnabled=SVG1DOM, MeasureAs=SVG1DOM] SVGRect createSVGRect();
  67     [RuntimeEnabled=SVG1DOM, MeasureAs=SVG1DOM] SVGTransform createSVGTransform();
  68     [RuntimeEnabled=SVG1DOM, MeasureAs=SVG1DOM] SVGTransform createSVGTransformFromMatrix(SVGMatrix matrix);
  69
  70     // TODO(philipj): The following was part of SVG 1.1:
  71     // http://www.w3.org/TR/SVG11/struct.html#InterfaceSVGSVGElement
  72     [Measure] readonly attribute float pixelUnitToMillimeterX;
  73     [Measure] readonly attribute float pixelUnitToMillimeterY;
  74     [Measure] readonly attribute float screenPixelToMillimeterX;
  75     [Measure] readonly attribute float screenPixelToMillimeterY;
  76     [Measure] Element getElementById(DOMString elementId);
  77 };
  78
  79 SVGSVGElement implements SVGFitToViewBox;
  80 SVGSVGElement implements SVGZoomAndPan;