gecko-dev/dom/webidl/GeometryUtils.webidl
Emilio Cobos Álvarez 64c3a4eed8 Bug 1928255 - Add an option to ignore transforms to GeometryUtils. r=layout-reviewers,webidl,saschanaz,jwatt
I want to mimic what anchor positioning will eventually do, and this is
how anchor positioning would behave. I want to use this to avoid having
to hack around it in a different way.

Differential Revision: https://phabricator.services.mozilla.com/D227757
2024-11-04 16:11:58 +00:00

63 lines
2.6 KiB
Plaintext

/* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* The origin of this IDL file is
* http://dev.w3.org/csswg/cssom-view/
*
* Copyright © 2012 W3C® (MIT, ERCIM, Keio), All Rights Reserved. W3C
* liability, trademark and document use rules apply.
*/
enum CSSBoxType { "margin", "border", "padding", "content" };
dictionary GeometryUtilsOptions {
[ChromeOnly]
boolean createFramesForSuppressedWhitespace = true;
[ChromeOnly]
boolean flush = true;
};
dictionary BoxQuadOptions : GeometryUtilsOptions {
CSSBoxType box = "border";
GeometryNode relativeTo;
[ChromeOnly]
boolean ignoreTransforms = false;
};
dictionary ConvertCoordinateOptions : GeometryUtilsOptions {
CSSBoxType fromBox = "border";
CSSBoxType toBox = "border";
};
interface mixin GeometryUtils {
[Throws, Func="nsINode::HasBoxQuadsSupport", NeedsCallerType]
sequence<DOMQuad> getBoxQuads(optional BoxQuadOptions options = {});
/* getBoxQuadsFromWindowOrigin is similar to getBoxQuads, but the
* returned quads are further translated relative to the window
* origin -- which is not the layout origin. Further translation
* must be done to bring the quads into layout space. Typically,
* this will be done by performing another call from the top level
* browser process, requesting the quad of the top level content
* document itself. The position of this quad can then be used as
* the offset into layout space, and subtracted from the original
* returned quads. If options.relativeTo is supplied, this method
* will throw.
*/
[ChromeOnly, Throws, Func="nsINode::HasBoxQuadsSupport"]
sequence<DOMQuad> getBoxQuadsFromWindowOrigin(optional BoxQuadOptions options = {});
[Throws, Pref="layout.css.convertFromNode.enabled", NeedsCallerType]
DOMQuad convertQuadFromNode(DOMQuad quad, GeometryNode from, optional ConvertCoordinateOptions options = {});
[Throws, Pref="layout.css.convertFromNode.enabled", NeedsCallerType]
DOMQuad convertRectFromNode(DOMRectReadOnly rect, GeometryNode from, optional ConvertCoordinateOptions options = {});
[Throws, Pref="layout.css.convertFromNode.enabled", NeedsCallerType]
DOMPoint convertPointFromNode(DOMPointInit point, GeometryNode from, optional ConvertCoordinateOptions options = {});
};
// PseudoElement includes GeometryUtils;
typedef (Text or Element /* or PseudoElement */ or Document) GeometryNode;