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
  30   /* getBoxQuadsFromWindowOrigin is similar to getBoxQuads, but the
  31    * returned quads are further translated relative to the window
  32    * origin -- which is not the layout origin. Further translation
  33    * must be done to bring the quads into layout space. Typically,
  34    * this will be done by performing another call from the top level
  35    * browser process, requesting the quad of the top level content
  36    * document itself. The position of this quad can then be used as
  37    * the offset into layout space, and subtracted from the original
  38    * returned quads. If options.relativeTo is supplied, this method
  39    * will throw.
  40    */
  41   [ChromeOnly, Throws, Func="nsINode::HasBoxQuadsSupport"]
  42   sequence<DOMQuad> getBoxQuadsFromWindowOrigin(optional BoxQuadOptions options = {});
  43
  44   [Throws, Pref="layout.css.convertFromNode.enabled", NeedsCallerType]
  45   DOMQuad convertQuadFromNode(DOMQuad quad, GeometryNode from, optional ConvertCoordinateOptions options = {});
  46   [Throws, Pref="layout.css.convertFromNode.enabled", NeedsCallerType]
  47   DOMQuad convertRectFromNode(DOMRectReadOnly rect, GeometryNode from, optional ConvertCoordinateOptions options = {});
  48   [Throws, Pref="layout.css.convertFromNode.enabled", NeedsCallerType]
  49   DOMPoint convertPointFromNode(DOMPointInit point, GeometryNode from, optional ConvertCoordinateOptions options = {});
  50 };
  51
  52 // PseudoElement includes GeometryUtils;
  53
  54 typedef (Text or Element /* or PseudoElement */ or Document) GeometryNode;