77894f7c976c4b35c597707e07ab80642143bcc3
[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     [CEReactions, MayThrowException] boolean toggleAttribute(DOMString qualifiedName, optional boolean force);
48     boolean hasAttribute(DOMString qualifiedName);
49     boolean hasAttributeNS(DOMString? namespaceURI, DOMString localName);
50
51     [DOMJIT=ReadDOM] Attr? getAttributeNode(DOMString qualifiedName);
52     Attr? getAttributeNodeNS(DOMString? namespaceURI, DOMString localName);
53     [CEReactions, MayThrowException] Attr? setAttributeNode(Attr attr);
54     [CEReactions, MayThrowException] Attr? setAttributeNodeNS(Attr attr);
55     [CEReactions, MayThrowException] Attr removeAttributeNode(Attr attr);
56
57     [EnabledAtRuntime=ShadowDOM, MayThrowException] ShadowRoot attachShadow(ShadowRootInit init);
58     [EnabledAtRuntime=ShadowDOM, ImplementedAs=shadowRootForBindings, CallWith=ExecState] readonly attribute ShadowRoot? shadowRoot;
59
60     [MayThrowException] Element? closest(DOMString selectors);
61     [MayThrowException] boolean matches(DOMString selectors);
62     [ImplementedAs=matches, MayThrowException] boolean webkitMatchesSelector(DOMString selectors); // Historical alias of .matches.
63
64     [DOMJIT=ReadDOM] HTMLCollection getElementsByTagName(DOMString qualifiedName);
65     HTMLCollection getElementsByTagNameNS(DOMString? namespaceURI, DOMString localName);
66     HTMLCollection getElementsByClassName(DOMString name);
67
68     [CEReactions, MayThrowException] Element? insertAdjacentElement(DOMString where, Element element); // Historical.
69     [MayThrowException] void insertAdjacentText(DOMString where, DOMString data); // Historical.
70
71     // CSSOM-view extensions (https://drafts.csswg.org/cssom-view/#extension-to-the-element-interface).
72     DOMRectList getClientRects();
73     [NewObject] DOMRect getBoundingClientRect();
74     void scrollIntoView(optional (boolean or ScrollIntoViewOptions) arg);
75     [ImplementedAs=scrollTo] void scroll(optional ScrollToOptions options);
76     [ImplementedAs=scrollTo] void scroll(unrestricted double x, unrestricted double y);
77     void scrollTo(optional ScrollToOptions options);
78     void scrollTo(unrestricted double x, unrestricted double y);
79     void scrollBy(optional ScrollToOptions option);
80     void scrollBy(unrestricted double x, unrestricted double y);
81     attribute long scrollTop; // FIXME(webkit.org/b/188045): should be unrestricted double.
82     attribute long scrollLeft; // FIXME(webkit.org/b/188045): should be unrestricted double.
83     readonly attribute long scrollWidth;
84     readonly attribute long scrollHeight;
85     readonly attribute double clientTop; // FIXME: Should be of type long.
86     readonly attribute double clientLeft; // FIXME: Should be of type long.
87     readonly attribute double clientWidth; // FIXME: Should be of type long.
88     readonly attribute double clientHeight; // FIXME: Should be of type long.
89
90     // Extensions to Element from DOM Parsing and Serialization specification.
91     // https://w3c.github.io/DOM-Parsing/#extensions-to-the-element-interface
92     [CEReactions] attribute [TreatNullAs=EmptyString] DOMString innerHTML;
93     [CEReactions] attribute [TreatNullAs=EmptyString] DOMString outerHTML;
94     [CEReactions, MayThrowException] void insertAdjacentHTML(DOMString position, DOMString text);
95
96     // Extensions from Full Screen API (https://fullscreen.spec.whatwg.org/#api).
97     // FIXME: Should we add unprefixed versions?
98     [Conditional=FULLSCREEN_API, EnabledBySetting=FullScreen, ImplementedAs=webkitRequestFullscreen] void webkitRequestFullScreen(); // Prefixed Mozilla version.
99     [Conditional=FULLSCREEN_API, EnabledBySetting=FullScreen] void webkitRequestFullscreen(); // Prefixed W3C version.
100
101     // Extensions from Pointer Lock API (https://w3c.github.io/pointerlock/#extensions-to-the-element-interface).
102     [Conditional=POINTER_LOCK] void requestPointerLock();
103
104     // Non standard API (https://www.w3.org/Bugs/Public/show_bug.cgi?id=17152).
105     void scrollIntoViewIfNeeded(optional boolean centerIfNeeded = true);
106
107     // Event handler from Selection API (http://w3c.github.io/selection-api/#extensions-to-globaleventhandlers).
108     // FIXME: Should be moved to GlobalEventHandlers.
109     [NotEnumerable] attribute EventHandler onselectstart; // FIXME: Should be enumerable.
110
111     // Non-standard WebKit API (https://developer.apple.com/reference/webkitjs/gestureevent).
112     [NotEnumerable, Conditional=IOS_GESTURE_EVENTS] attribute EventHandler ongesturechange;
113     [NotEnumerable, Conditional=IOS_GESTURE_EVENTS] attribute EventHandler ongestureend;
114     [NotEnumerable, Conditional=IOS_GESTURE_EVENTS] attribute EventHandler ongesturestart;
115
116     // Non standard.
117     [NotEnumerable, ImplementedAs=onwebkitAnimationEnd] attribute EventHandler onwebkitanimationend;
118     [NotEnumerable, ImplementedAs=onwebkitAnimationIteration] attribute EventHandler onwebkitanimationiteration;
119     [NotEnumerable, ImplementedAs=onwebkitAnimationStart] attribute EventHandler onwebkitanimationstart;
120     [NotEnumerable, ImplementedAs=onwebkitTransitionEnd] attribute EventHandler onwebkittransitionend;
121
122     // FIXME: These event handlers should only be on Document (https://fullscreen.spec.whatwg.org/#api).
123     [NotEnumerable, Conditional=FULLSCREEN_API, EnabledBySetting=FullScreen] attribute EventHandler onwebkitfullscreenchange;
124     [NotEnumerable, Conditional=FULLSCREEN_API, EnabledBySetting=FullScreen] attribute EventHandler onwebkitfullscreenerror;
125
126     // FIXME: Cannot find those EventHandlers in the latest specification (https://w3c.github.io/uievents/#events-focus-types).
127     [NotEnumerable] attribute EventHandler onfocusin;
128     [NotEnumerable] attribute EventHandler onfocusout;
129
130     // Non standard event handler (https://developer.apple.com/reference/webkitjs/element/1633146-onbeforeload).
131     [NotEnumerable] attribute EventHandler onbeforeload;
132
133     // Non standard event handler (https://developer.apple.com/reference/webkitjs/element/1634205-onwebkitneedkey).
134     [NotEnumerable, Conditional=LEGACY_ENCRYPTED_MEDIA, EnabledAtRuntime=LegacyEncryptedMediaAPI] attribute EventHandler onwebkitneedkey;
135
136     // Non standard event handler (https://developer.apple.com/reference/webkitjs/element/1633943-onwebkitpresentationmodechanged).
137     [NotEnumerable, Conditional=VIDEO_PRESENTATION_MODE] attribute EventHandler onwebkitpresentationmodechanged;
138
139     // Non standard event handler (https://developer.apple.com/reference/webkitjs/element/1630042-onwebkitcurrentplaybacktargetisw).
140     [NotEnumerable, Conditional=WIRELESS_PLAYBACK_TARGET] attribute EventHandler onwebkitcurrentplaybacktargetiswirelesschanged;
141
142     // Non standard event handler (https://developer.apple.com/reference/webkitjs/element/1629580-onwebkitplaybacktargetavailabili).
143     [NotEnumerable, Conditional=WIRELESS_PLAYBACK_TARGET] attribute EventHandler onwebkitplaybacktargetavailabilitychanged;
144
145     // Accessibility events.
146     [EnabledAtRuntime=AccessibilityObjectModel] attribute EventHandler onaccessiblecontextmenu;
147     [EnabledAtRuntime=AccessibilityObjectModel] attribute EventHandler onaccessibleclick;
148     [EnabledAtRuntime=AccessibilityObjectModel] attribute EventHandler onaccessibledecrement;
149     [EnabledAtRuntime=AccessibilityObjectModel] attribute EventHandler onaccessibledismiss;
150     [EnabledAtRuntime=AccessibilityObjectModel] attribute EventHandler onaccessiblefocus;
151     [EnabledAtRuntime=AccessibilityObjectModel] attribute EventHandler onaccessibleincrement;
152     [EnabledAtRuntime=AccessibilityObjectModel] attribute EventHandler onaccessiblescrollintoview;
153     [EnabledAtRuntime=AccessibilityObjectModel] attribute EventHandler onaccessiblesetvalue;
154     [EnabledAtRuntime=AccessibilityObjectModel] attribute EventHandler onaccessibleselect;
155 };
156
157 dictionary ShadowRootInit {
158     required ShadowRootMode mode;
159 };
160
161 Element implements AccessibilityRole;
162 Element implements AriaAttributes;
163 Element implements Animatable;
164 Element implements ChildNode;
165 Element implements DocumentAndElementEventHandlers;
166 Element implements NonDocumentTypeChildNode;
167 Element implements ParentNode;
168 Element implements Slotable;