GeometryUtils.webidl (2624B)
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 15 dictionary GeometryUtilsOptions { 16 [ChromeOnly] 17 boolean createFramesForSuppressedWhitespace = true; 18 [ChromeOnly] 19 boolean flush = true; 20 }; 21 22 dictionary BoxQuadOptions : GeometryUtilsOptions { 23 CSSBoxType box = "border"; 24 GeometryNode relativeTo; 25 [ChromeOnly] 26 boolean ignoreTransforms = false; 27 }; 28 29 dictionary ConvertCoordinateOptions : GeometryUtilsOptions { 30 CSSBoxType fromBox = "border"; 31 CSSBoxType toBox = "border"; 32 }; 33 34 interface mixin GeometryUtils { 35 [Throws, Func="nsINode::HasBoxQuadsSupport", NeedsCallerType] 36 sequence<DOMQuad> getBoxQuads(optional BoxQuadOptions options = {}); 37 38 /* getBoxQuadsFromWindowOrigin is similar to getBoxQuads, but the 39 * returned quads are further translated relative to the window 40 * origin -- which is not the layout origin. Further translation 41 * must be done to bring the quads into layout space. Typically, 42 * this will be done by performing another call from the top level 43 * browser process, requesting the quad of the top level content 44 * document itself. The position of this quad can then be used as 45 * the offset into layout space, and subtracted from the original 46 * returned quads. If options.relativeTo is supplied, this method 47 * will throw. 48 */ 49 [ChromeOnly, Throws, Func="nsINode::HasBoxQuadsSupport"] 50 sequence<DOMQuad> getBoxQuadsFromWindowOrigin(optional BoxQuadOptions options = {}); 51 52 [Throws, Pref="layout.css.convertFromNode.enabled", NeedsCallerType] 53 DOMQuad convertQuadFromNode(DOMQuad quad, GeometryNode from, optional ConvertCoordinateOptions options = {}); 54 [Throws, Pref="layout.css.convertFromNode.enabled", NeedsCallerType] 55 DOMQuad convertRectFromNode(DOMRectReadOnly rect, GeometryNode from, optional ConvertCoordinateOptions options = {}); 56 [Throws, Pref="layout.css.convertFromNode.enabled", NeedsCallerType] 57 DOMPoint convertPointFromNode(DOMPointInit point, GeometryNode from, optional ConvertCoordinateOptions options = {}); 58 }; 59 60 // PseudoElement includes GeometryUtils; 61 62 typedef (Text or Element /* or PseudoElement */ or Document) GeometryNode;