Remove all Web Animations code
[WebKit-https.git] / Source / WebCore / dom / Element.idl
1 /*
2  * Copyright (C) 2006, 2007, 2009, 2015 Apple Inc. All rights reserved.
3  * Copyright (C) 2006 Samuel Weinig <sam.weinig@gmail.com>
4  *
5  * This library is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Library General Public
7  * License as published by the Free Software Foundation; either
8  * version 2 of the License, or (at your option) any later version.
9  *
10  * This library is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  * Library General Public License for more details.
14  *
15  * You should have received a copy of the GNU Library General Public License
16  * along with this library; see the file COPYING.LIB.  If not, write to
17  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
18  * Boston, MA 02110-1301, USA.
19  */
20
21 [
22     CustomToJSObject,
23     DOMJIT,
24     JSCustomHeader,
25     JSGenerateToNativeObject,
26     ExportMacro=WEBCORE_EXPORT,
27 ] interface Element : Node {
28     readonly attribute DOMString? namespaceURI;
29     readonly attribute DOMString? prefix;
30     readonly attribute DOMString localName;
31     readonly attribute DOMString tagName;
32
33     [CEReactions, Reflect] attribute DOMString id;
34     [CEReactions, Reflect=class] attribute DOMString className;
35     [PutForwards=value] readonly attribute DOMTokenList classList; // FIXME: Should be [SameObject].
36     [CEReactions, EnabledAtRuntime=ShadowDOM, Reflect, Unscopable] attribute DOMString slot;
37
38     [DOMJIT=ReadDOM] boolean hasAttributes();
39     readonly attribute NamedNodeMap attributes; // FIXME: Should be [SameObject].
40     sequence<DOMString> getAttributeNames();
41     [DOMJIT=ReadDOM] DOMString? getAttribute(DOMString qualifiedName);
42     DOMString? getAttributeNS(DOMString? namespaceURI, DOMString localName);
43     [CEReactions, MayThrowException] void setAttribute(DOMString qualifiedName, DOMString value);
44     [CEReactions, MayThrowException] void setAttributeNS(DOMString? namespaceURI, DOMString qualifiedName, DOMString value);
45     [CEReactions] void removeAttribute(DOMString qualifiedName);
46     [CEReactions] void removeAttributeNS(DOMString? namespaceURI, DOMString localName);
47     boolean hasAttribute(DOMString qualifiedName);
48     boolean hasAttributeNS(DOMString? namespaceURI, DOMString localName);
49
50     [DOMJIT=ReadDOM] Attr? getAttributeNode(DOMString qualifiedName);
51     Attr? getAttributeNodeNS(DOMString? namespaceURI, DOMString localName);
52     [CEReactions, MayThrowException] Attr? setAttributeNode(Attr attr);
53     [CEReactions, MayThrowException] Attr? setAttributeNodeNS(Attr attr);
54     [CEReactions, MayThrowException] Attr removeAttributeNode(Attr attr);
55
56     [EnabledAtRuntime=ShadowDOM, MayThrowException] ShadowRoot attachShadow(ShadowRootInit init);
57     [EnabledAtRuntime=ShadowDOM, ImplementedAs=shadowRootForBindings, CallWith=ScriptState] readonly attribute ShadowRoot? shadowRoot;
58
59     [MayThrowException] Element? closest(DOMString selectors);
60     [MayThrowException] boolean matches(DOMString selectors);
61     [ImplementedAs=matches, MayThrowException] boolean webkitMatchesSelector(DOMString selectors); // Historical alias of .matches.
62
63     [DOMJIT=ReadDOM] HTMLCollection getElementsByTagName(DOMString qualifiedName);
64     HTMLCollection getElementsByTagNameNS(DOMString? namespaceURI, DOMString localName);
65     HTMLCollection getElementsByClassName(DOMString name);
66
67     [CEReactions, MayThrowException] Element? insertAdjacentElement(DOMString where, Element element); // Historical.
68     [MayThrowException] void insertAdjacentText(DOMString where, DOMString data); // Historical.
69
70     // CSSOM-view extensions (https://drafts.csswg.org/cssom-view/#extension-to-the-element-interface).
71     DOMRectList getClientRects();
72     [NewObject] DOMRect getBoundingClientRect();
73     void scrollIntoView(optional boolean alignWithTop = true); // FIXME: Parameter type should be (boolean or object).
74     [ImplementedAs=scrollTo] void scroll(optional ScrollToOptions options);
75     [ImplementedAs=scrollTo] void scroll(unrestricted double x, unrestricted double y);
76     void scrollTo(optional ScrollToOptions options);
77     void scrollTo(unrestricted double x, unrestricted double y);
78     void scrollBy(optional ScrollToOptions option);
79     void scrollBy(unrestricted double x, unrestricted double y);
80     attribute long scrollTop; // FIXME: should be unrestricted double.
81     attribute long scrollLeft; // FIXME: should be unrestricted double.
82     readonly attribute long scrollWidth;
83     readonly attribute long scrollHeight;
84     readonly attribute double clientTop; // FIXME: Should be of type long.
85     readonly attribute double clientLeft; // FIXME: Should be of type long.
86     readonly attribute double clientWidth; // FIXME: Should be of type long.
87     readonly attribute double clientHeight; // FIXME: Should be of type long.
88
89     // Extensions to Element from DOM Parsing and Serialization specification.
90     // https://w3c.github.io/DOM-Parsing/#extensions-to-the-element-interface
91     [CEReactions] attribute [TreatNullAs=EmptyString] DOMString innerHTML;
92     [CEReactions] attribute [TreatNullAs=EmptyString] DOMString outerHTML;
93     [CEReactions, MayThrowException] void insertAdjacentHTML(DOMString position, DOMString text);
94
95     // Extensions from Full Screen API (https://fullscreen.spec.whatwg.org/#api).
96     // FIXME: Should we add unprefixed versions?
97     [Conditional=FULLSCREEN_API, ImplementedAs=webkitRequestFullscreen] void webkitRequestFullScreen(); // Prefixed Mozilla version.
98     [Conditional=FULLSCREEN_API] void webkitRequestFullscreen(); // Prefixed W3C version.
99
100     // Extensions from Pointer Lock API (https://w3c.github.io/pointerlock/#extensions-to-the-element-interface).
101     [Conditional=POINTER_LOCK] void requestPointerLock();
102
103     // Non standard API (https://www.w3.org/Bugs/Public/show_bug.cgi?id=17152).
104     void scrollIntoViewIfNeeded(optional boolean centerIfNeeded = true);
105
106     // Event handler from Selection API (http://w3c.github.io/selection-api/#extensions-to-globaleventhandlers).
107     // FIXME: Should be moved to GlobalEventHandlers.
108     [NotEnumerable] attribute EventHandler onselectstart; // FIXME: Should be enumerable.
109
110     // Non-standard WebKit API (https://developer.apple.com/reference/webkitjs/gestureevent).
111     [NotEnumerable, Conditional=IOS_GESTURE_EVENTS] attribute EventHandler ongesturechange;
112     [NotEnumerable, Conditional=IOS_GESTURE_EVENTS] attribute EventHandler ongestureend;
113     [NotEnumerable, Conditional=IOS_GESTURE_EVENTS] attribute EventHandler ongesturestart;
114
115     // Non standard.
116     [NotEnumerable, ImplementedAs=onwebkitAnimationEnd] attribute EventHandler onwebkitanimationend;
117     [NotEnumerable, ImplementedAs=onwebkitAnimationIteration] attribute EventHandler onwebkitanimationiteration;
118     [NotEnumerable, ImplementedAs=onwebkitAnimationStart] attribute EventHandler onwebkitanimationstart;
119     [NotEnumerable, ImplementedAs=onwebkitTransitionEnd] attribute EventHandler onwebkittransitionend;
120
121     // FIXME: These event handlers should only be on Document (https://fullscreen.spec.whatwg.org/#api).
122     [NotEnumerable, Conditional=FULLSCREEN_API] attribute EventHandler onwebkitfullscreenchange;
123     [NotEnumerable, Conditional=FULLSCREEN_API] attribute EventHandler onwebkitfullscreenerror;
124
125     // FIXME: Cannot find those EventHandlers in the latest specification (https://w3c.github.io/uievents/#events-focus-types).
126     [NotEnumerable] attribute EventHandler onfocusin;
127     [NotEnumerable] attribute EventHandler onfocusout;
128
129     // Non standard event handler (https://developer.apple.com/reference/webkitjs/element/1633146-onbeforeload).
130     [NotEnumerable] attribute EventHandler onbeforeload;
131
132     // Non standard event handler (https://developer.apple.com/reference/webkitjs/element/1634205-onwebkitneedkey).
133     [NotEnumerable, Conditional=LEGACY_ENCRYPTED_MEDIA, EnabledAtRuntime=LegacyEncryptedMediaAPI] attribute EventHandler onwebkitneedkey;
134
135     // Non standard event handler (https://developer.apple.com/reference/webkitjs/element/1633943-onwebkitpresentationmodechanged).
136     [NotEnumerable, Conditional=VIDEO_PRESENTATION_MODE] attribute EventHandler onwebkitpresentationmodechanged;
137
138     // Non standard event handler (https://developer.apple.com/reference/webkitjs/element/1630042-onwebkitcurrentplaybacktargetisw).
139     [NotEnumerable, Conditional=WIRELESS_PLAYBACK_TARGET] attribute EventHandler onwebkitcurrentplaybacktargetiswirelesschanged;
140
141     // Non standard event handler (https://developer.apple.com/reference/webkitjs/element/1629580-onwebkitplaybacktargetavailabili).
142     [NotEnumerable, Conditional=WIRELESS_PLAYBACK_TARGET] attribute EventHandler onwebkitplaybacktargetavailabilitychanged;
143 };
144
145 dictionary ShadowRootInit {
146     required ShadowRootMode mode;
147 };
148
149 Element implements ChildNode;
150 Element implements DocumentAndElementEventHandlers;
151 Element implements NonDocumentTypeChildNode;
152 Element implements ParentNode;
153 Element implements Slotable;