dom/webidl/GeometryUtils.webidl

   1 /* -*- Mode: IDL; 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  * The origin of this IDL file is
   7  * http://dev.w3.org/csswg/cssom-view/
   8  *
   9  * Copyright © 2012 W3C® (MIT, ERCIM, Keio), All Rights Reserved. W3C
  10  * liability, trademark and document use rules apply.
  11  */
  12
  13 enum CSSBoxType { "margin", "border", "padding", "content" };
  14 dictionary BoxQuadOptions {
  15   CSSBoxType box = "border";
  16   GeometryNode relativeTo;
  17   [ChromeOnly]
  18   boolean createFramesForSuppressedWhitespace = true;
  19 };
  20
  21 dictionary ConvertCoordinateOptions {
  22   CSSBoxType fromBox = "border";
  23   CSSBoxType toBox = "border";
  24 };
  25
  26 interface mixin GeometryUtils {
  27   [Throws, Func="nsINode::HasBoxQuadsSupport", NeedsCallerType]
  28   sequence<DOMQuad> getBoxQuads(optional BoxQuadOptions options = {});
  29   [Throws, Pref="layout.css.convertFromNode.enabled", NeedsCallerType]
  30   DOMQuad convertQuadFromNode(DOMQuad quad, GeometryNode from, optional ConvertCoordinateOptions options = {});
  31   [Throws, Pref="layout.css.convertFromNode.enabled", NeedsCallerType]
  32   DOMQuad convertRectFromNode(DOMRectReadOnly rect, GeometryNode from, optional ConvertCoordinateOptions options = {});
  33   [Throws, Pref="layout.css.convertFromNode.enabled", NeedsCallerType]
  34   DOMPoint convertPointFromNode(DOMPointInit point, GeometryNode from, optional ConvertCoordinateOptions options = {});
  35 };
  36
  37 // PseudoElement includes GeometryUtils;
  38
  39 typedef (Text or Element /* or PseudoElement */ or Document) GeometryNode;