gecko-dev/dom/webidl/AnonymousContent.webidl
Daisuke Akatsuka c6a47f400c Bug 1571650: Add an API to change the style of AnonymousContent from devtools. r=smaug
DevTools is using AnonymousContent to highlight the element inspecting.
And now, the z-order of highlighting became to be importance. In case of normal
element, we can change the z-order by z-index or order of DOM. However,
AnonymousContent does not have the such the way to change the z-order from
DevTools side. This patch introduces an API to change the style, and makes the
z-order changeable by the z-index.

Differential Revision: https://phabricator.services.mozilla.com/D41927

--HG--
extra : moz-landing-system : lando
2019-08-16 07:38:39 +00:00

101 lines
3.3 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/.
*/
/*
* This file declares the AnonymousContent interface which is used to
* manipulate content that has been inserted into the document's canvasFrame
* anonymous container.
* See Document.insertAnonymousContent.
*
* This API never returns a reference to the actual inserted DOM node on
* purpose. This is to make sure the content cannot be randomly changed and the
* DOM cannot be traversed from the node, so that Gecko can remain in control of
* the inserted content.
*/
[ChromeOnly]
interface AnonymousContent {
/**
* Get the text content of an element inside this custom anonymous content.
*/
[Throws]
DOMString getTextContentForElement(DOMString elementId);
/**
* Set the text content of an element inside this custom anonymous content.
*/
[Throws]
void setTextContentForElement(DOMString elementId, DOMString text);
/**
* Get the value of an attribute of an element inside this custom anonymous
* content.
*/
[Throws]
DOMString? getAttributeForElement(DOMString elementId,
DOMString attributeName);
/**
* Set the value of an attribute of an element inside this custom anonymous
* content.
*/
[NeedsSubjectPrincipal=NonSystem, Throws]
void setAttributeForElement(DOMString elementId,
DOMString attributeName,
DOMString value);
/**
* Remove an attribute from an element inside this custom anonymous content.
*/
[Throws]
void removeAttributeForElement(DOMString elementId,
DOMString attributeName);
/**
* Get the canvas' context for the element specified if it's a <canvas>
* node, `null` otherwise.
*/
[Throws]
nsISupports? getCanvasContext(DOMString elementId,
DOMString contextId);
[Throws]
Animation setAnimationForElement(DOMString elementId,
object? keyframes,
optional UnrestrictedDoubleOrKeyframeAnimationOptions
options = {});
/**
* Accepts a list of (possibly overlapping) DOMRects which describe a shape
* in CSS pixels relative to the element's border box. This shape will be
* excluded from the element's background color rendering. The element will
* not render any background images once this method has been called.
*/
[Throws]
void setCutoutRectsForElement(DOMString elementId,
sequence<DOMRect> rects);
/**
* Get the computed value of a property on an element inside this custom
* anonymous content.
*/
[Throws]
DOMString? getComputedStylePropertyValue(DOMString elementId,
DOMString propertyName);
/**
* If event's original target is in the anonymous content, this returns the id
* attribute value of the target.
*/
DOMString? getTargetIdForEvent(Event event);
/**
* Set given style to this AnonymousContent.
*/
[Throws]
void setStyle(DOMString property, DOMString value);
};