Move onanimation* EventHandlers to GlobalEventHandlers
[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     JSCustomHeader,
24     JSGenerateToNativeObject,
25     ExportMacro=WEBCORE_EXPORT,
26 ] interface Element : Node {
27     readonly attribute DOMString? namespaceURI;
28     readonly attribute DOMString? prefix;
29     readonly attribute DOMString localName;
30     readonly attribute DOMString tagName;
31
32     [CEReactions, Reflect] attribute DOMString id;
33     [CEReactions, Reflect=class] attribute DOMString className;
34     [PutForwards=value] readonly attribute DOMTokenList classList; // FIXME: Should be [SameObject].
35     [CEReactions, EnabledAtRuntime=ShadowDOM, Reflect, Unscopable] attribute DOMString slot;
36
37     [DOMJIT=ReadDOM] boolean hasAttributes();
38     readonly attribute NamedNodeMap attributes; // FIXME: Should be [SameObject].
39     sequence<DOMString> getAttributeNames();
40     [DOMJIT=ReadDOM] DOMString? getAttribute(DOMString qualifiedName);
41     DOMString? getAttributeNS(DOMString? namespaceURI, DOMString localName);
42     [CEReactions, MayThrowException] void setAttribute(DOMString qualifiedName, DOMString value);
43     [CEReactions, MayThrowException] void setAttributeNS(DOMString? namespaceURI, DOMString qualifiedName, DOMString value);
44     [CEReactions] void removeAttribute(DOMString qualifiedName);
45     [CEReactions] void removeAttributeNS(DOMString? namespaceURI, DOMString localName);
46     boolean hasAttribute(DOMString qualifiedName);
47     boolean hasAttributeNS(DOMString? namespaceURI, DOMString localName);
48
49     [DOMJIT=ReadDOM] Attr? getAttributeNode(DOMString qualifiedName);
50     Attr? getAttributeNodeNS(DOMString? namespaceURI, DOMString localName);
51     [CEReactions, MayThrowException] Attr? setAttributeNode(Attr attr);
52     [CEReactions, MayThrowException] Attr? setAttributeNodeNS(Attr attr);
53     [CEReactions, MayThrowException] Attr removeAttributeNode(Attr attr);
54
55     [EnabledAtRuntime=ShadowDOM, MayThrowException] ShadowRoot attachShadow(ShadowRootInit init);
56     [EnabledAtRuntime=ShadowDOM, ImplementedAs=shadowRootForBindings, CallWith=ScriptState] readonly attribute ShadowRoot? shadowRoot;
57
58     [MayThrowException] Element? closest(DOMString selectors);
59     [MayThrowException] boolean matches(DOMString selectors);
60     [ImplementedAs=matches, MayThrowException] boolean webkitMatchesSelector(DOMString selectors); // Historical alias of .matches.
61
62     [DOMJIT=ReadDOM] HTMLCollection getElementsByTagName(DOMString qualifiedName);
63     HTMLCollection getElementsByTagNameNS(DOMString? namespaceURI, DOMString localName);
64     HTMLCollection getElementsByClassName(DOMString name);
65
66     [CEReactions, MayThrowException] Element? insertAdjacentElement(DOMString where, Element element); // Historical.
67     [MayThrowException] void insertAdjacentText(DOMString where, DOMString data); // Historical.
68
69     // CSSOM-view extensions (https://drafts.csswg.org/cssom-view/#extension-to-the-element-interface).
70     sequence<DOMRect> getClientRects();
71     [NewObject] DOMRect getBoundingClientRect();
72     void scrollIntoView(optional boolean alignWithTop = true); // FIXME: Parameter type should be (boolean or object).
73     [ImplementedAs=scrollTo] void scroll(optional ScrollToOptions options);
74     [ImplementedAs=scrollTo] void scroll(unrestricted double x, unrestricted double y);
75     void scrollTo(optional ScrollToOptions options);
76     void scrollTo(unrestricted double x, unrestricted double y);
77     void scrollBy(optional ScrollToOptions option);
78     void scrollBy(unrestricted double x, unrestricted double y);
79     attribute long scrollTop; // FIXME: should be unrestricted double.
80     attribute long scrollLeft; // FIXME: should be unrestricted double.
81     readonly attribute long scrollWidth;
82     readonly attribute long scrollHeight;
83     readonly attribute double clientTop; // FIXME: Should be of type long.
84     readonly attribute double clientLeft; // FIXME: Should be of type long.
85     readonly attribute double clientWidth; // FIXME: Should be of type long.
86     readonly attribute double clientHeight; // FIXME: Should be of type long.
87
88     // Extensions to Element from DOM Parsing and Serialization specification.
89     // https://w3c.github.io/DOM-Parsing/#extensions-to-the-element-interface
90     [CEReactions, SetterMayThrowException] attribute [TreatNullAs=EmptyString] DOMString innerHTML;
91     [CEReactions, SetterMayThrowException] attribute [TreatNullAs=EmptyString] DOMString outerHTML;
92     [CEReactions, MayThrowException] void insertAdjacentHTML(DOMString position, DOMString text);
93
94     // Extensions from Full Screen API (https://fullscreen.spec.whatwg.org/#api).
95     // FIXME: Should we add unprefixed versions?
96     [Conditional=FULLSCREEN_API, ImplementedAs=webkitRequestFullscreen] void webkitRequestFullScreen(); // Prefixed Mozilla version.
97     [Conditional=FULLSCREEN_API] void webkitRequestFullscreen(); // Prefixed W3C version.
98
99     // Extensions from Pointer Lock API (https://w3c.github.io/pointerlock/#extensions-to-the-element-interface).
100     [Conditional=POINTER_LOCK] void requestPointerLock();
101
102     // Extensions from CSS Regions API (https://drafts.csswg.org/css-regions/#the-region-interface).
103     // FIXME: Should be in a separate Region interface implemented by Element.
104     // FIXME: Should we add unprefixed versions?
105     [Conditional=CSS_REGIONS] readonly attribute DOMString webkitRegionOverset;
106     [Conditional=CSS_REGIONS] sequence<Range>? webkitGetRegionFlowRanges();
107
108     // Non standard API (https://www.w3.org/Bugs/Public/show_bug.cgi?id=17152).
109     void scrollIntoViewIfNeeded(optional boolean centerIfNeeded = true);
110
111     // Event handler from Selection API (http://w3c.github.io/selection-api/#extensions-to-globaleventhandlers).
112     // FIXME: Should be moved to GlobalEventHandlers.
113     [NotEnumerable] attribute EventHandler onselectstart; // FIXME: Should be enumerable.
114
115     // Non-standard WebKit API (https://developer.apple.com/reference/webkitjs/gestureevent).
116     [NotEnumerable, Conditional=IOS_GESTURE_EVENTS] attribute EventHandler ongesturechange;
117     [NotEnumerable, Conditional=IOS_GESTURE_EVENTS] attribute EventHandler ongestureend;
118     [NotEnumerable, Conditional=IOS_GESTURE_EVENTS] attribute EventHandler ongesturestart;
119
120     // Non standard event handlers.
121     [NotEnumerable, ImplementedAs=onwebkitAnimationEnd] attribute EventHandler onwebkitanimationend;
122     [NotEnumerable] attribute EventHandler onbeforecopy;
123     [NotEnumerable] attribute EventHandler onbeforecut;
124     [NotEnumerable] attribute EventHandler onbeforeinput;
125     [NotEnumerable] attribute EventHandler onbeforepaste;
126     [NotEnumerable] attribute EventHandler oncopy;
127     [NotEnumerable] attribute EventHandler oncut;
128     [NotEnumerable] attribute EventHandler onpaste;
129     [NotEnumerable, ImplementedAs=onwebkitAnimationIteration] attribute EventHandler onwebkitanimationiteration;
130     [NotEnumerable, ImplementedAs=onwebkitAnimationStart] attribute EventHandler onwebkitanimationstart;
131     [NotEnumerable, ImplementedAs=onwebkitTransitionEnd] attribute EventHandler onwebkittransitionend;
132
133     // FIXME: These event handlers should only be on Document (https://fullscreen.spec.whatwg.org/#api).
134     [NotEnumerable, Conditional=FULLSCREEN_API] attribute EventHandler onwebkitfullscreenchange;
135     [NotEnumerable, Conditional=FULLSCREEN_API] attribute EventHandler onwebkitfullscreenerror;
136
137     // FIXME: Cannot find those EventHandlers in the latest specification (https://w3c.github.io/uievents/#events-focus-types).
138     [NotEnumerable] attribute EventHandler onfocusin;
139     [NotEnumerable] attribute EventHandler onfocusout;
140
141     // Non standard event handler (https://developer.apple.com/reference/webkitjs/element/1633146-onbeforeload).
142     [NotEnumerable] attribute EventHandler onbeforeload;
143
144     // Non standard event handler (https://developer.apple.com/reference/webkitjs/element/1634205-onwebkitneedkey).
145     [NotEnumerable, Conditional=LEGACY_ENCRYPTED_MEDIA] attribute EventHandler onwebkitneedkey;
146
147     // Non standard event handler (https://developer.apple.com/reference/webkitjs/element/1633943-onwebkitpresentationmodechanged).
148     [NotEnumerable, Conditional=VIDEO_PRESENTATION_MODE] attribute EventHandler onwebkitpresentationmodechanged;
149
150     // Non standard event handler (https://developer.apple.com/reference/webkitjs/element/1630042-onwebkitcurrentplaybacktargetisw).
151     [NotEnumerable, Conditional=WIRELESS_PLAYBACK_TARGET] attribute EventHandler onwebkitcurrentplaybacktargetiswirelesschanged;
152
153     // Non standard event handler (https://developer.apple.com/reference/webkitjs/element/1629580-onwebkitplaybacktargetavailabili).
154     [NotEnumerable, Conditional=WIRELESS_PLAYBACK_TARGET] attribute EventHandler onwebkitplaybacktargetavailabilitychanged;
155 };
156
157 dictionary ShadowRootInit {
158     required ShadowRootMode mode;
159 };
160
161 Element implements Animatable;
162 Element implements ChildNode;
163 Element implements NonDocumentTypeChildNode;
164 Element implements ParentNode;
165 Element implements Slotable;