Removed v8 bindings hooks from IDL files
[WebKit-https.git] / Source / WebCore / dom / Document.idl
1 /*
2  * Copyright (C) 2006, 2007, 2011 Apple Inc. All rights reserved.
3  * Copyright (C) 2006, 2007 Samuel Weinig <sam@webkit.org>
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     JSGenerateToNativeObject,
24     JSInlineGetOwnPropertySlot
25 ] interface Document : Node {
26
27     // DOM Level 1 Core
28     readonly attribute DocumentType doctype;
29     readonly attribute DOMImplementation implementation;
30     readonly attribute Element documentElement;
31
32     [ReturnNewObject]
33     Element createElement(in [TreatNullAs=NullString,Optional=DefaultIsUndefined] DOMString tagName)
34         raises (DOMException);
35     DocumentFragment   createDocumentFragment();
36     [ReturnNewObject] Text createTextNode(in [Optional=DefaultIsUndefined] DOMString data);
37     [ReturnNewObject] Comment createComment(in [Optional=DefaultIsUndefined] DOMString data);
38     [ReturnNewObject] CDATASection createCDATASection(in [Optional=DefaultIsUndefined] DOMString data)
39         raises(DOMException);
40     [ObjCLegacyUnnamedParameters, ReturnNewObject] ProcessingInstruction createProcessingInstruction(in [Optional=DefaultIsUndefined] DOMString target,
41                                                                                  in [Optional=DefaultIsUndefined] DOMString data)
42         raises (DOMException);
43     [ReturnNewObject] Attr createAttribute(in [Optional=DefaultIsUndefined] DOMString name)
44         raises (DOMException);
45     [ReturnNewObject] EntityReference createEntityReference(in [Optional=DefaultIsUndefined] DOMString name)
46         raises(DOMException);
47     NodeList getElementsByTagName(in [Optional=DefaultIsUndefined] DOMString tagname);
48
49     // Introduced in DOM Level 2:
50
51     [ObjCLegacyUnnamedParameters, ReturnNewObject]
52     Node importNode(in [Optional=DefaultIsUndefined] Node importedNode,
53                     in [Optional] boolean deep)
54         raises (DOMException);
55     [ObjCLegacyUnnamedParameters, ReturnNewObject]
56     Element createElementNS(in [TreatNullAs=NullString,Optional=DefaultIsUndefined] DOMString namespaceURI,
57                             in [TreatNullAs=NullString,Optional=DefaultIsUndefined] DOMString qualifiedName)
58         raises (DOMException);
59     [ObjCLegacyUnnamedParameters, ReturnNewObject] Attr createAttributeNS(in [TreatNullAs=NullString,Optional=DefaultIsUndefined] DOMString namespaceURI,
60                                                                           in [TreatNullAs=NullString,Optional=DefaultIsUndefined] DOMString qualifiedName)
61         raises (DOMException);
62     [ObjCLegacyUnnamedParameters] NodeList getElementsByTagNameNS(in [TreatNullAs=NullString,Optional=DefaultIsUndefined] DOMString namespaceURI,
63                                                    in [Optional=DefaultIsUndefined] DOMString localName);
64     Element getElementById(in [Optional=DefaultIsUndefined] DOMString elementId);
65
66     // DOM Level 3 Core
67
68     [TreatReturnedNullStringAs=Null] readonly attribute DOMString inputEncoding;
69
70     [TreatReturnedNullStringAs=Null] readonly attribute DOMString xmlEncoding;
71              [TreatReturnedNullStringAs=Null, TreatNullAs=NullString] attribute DOMString xmlVersion
72                 setter raises (DOMException);
73              attribute boolean xmlStandalone
74                 setter raises (DOMException);
75
76     Node               adoptNode(in [Optional=DefaultIsUndefined] Node source)
77         raises (DOMException);
78
79 #if defined(LANGUAGE_OBJECTIVE_C) && LANGUAGE_OBJECTIVE_C || defined(LANGUAGE_GOBJECT) && LANGUAGE_GOBJECT
80     // document.documentURI was writable in DOM3 Core, but is read-only in DOM4
81     // (see http://www.w3.org/TR/2011/WD-dom-20110915/#document). We need to keep
82     // the writable version around for Objective C clients, but are moving to
83     // read-only for other clients.
84              [TreatReturnedNullStringAs=Null, TreatNullAs=NullString] attribute DOMString documentURI;
85 #else
86     [TreatReturnedNullStringAs=Null] readonly attribute DOMString documentURI;
87 #endif
88
89     // DOM Level 2 Events (DocumentEvents interface)
90
91     Event              createEvent(in [Optional=DefaultIsUndefined] DOMString eventType)
92         raises(DOMException);
93
94     // DOM Level 2 Tranversal and Range (DocumentRange interface)
95
96     Range              createRange();
97
98     // DOM Level 2 Tranversal and Range (DocumentTraversal interface)
99
100     [ObjCLegacyUnnamedParameters] NodeIterator createNodeIterator(in [Optional=DefaultIsUndefined] Node root,
101                                                    in [Optional=DefaultIsUndefined] unsigned long whatToShow,
102                                                    in [Optional=DefaultIsUndefined] NodeFilter filter,
103                                                    in [Optional=DefaultIsUndefined] boolean expandEntityReferences)
104         raises(DOMException);
105     [ObjCLegacyUnnamedParameters] TreeWalker createTreeWalker(in [Optional=DefaultIsUndefined] Node root,
106                                                in [Optional=DefaultIsUndefined] unsigned long whatToShow,
107                                                in [Optional=DefaultIsUndefined] NodeFilter filter,
108                                                in [Optional=DefaultIsUndefined] boolean expandEntityReferences)
109         raises(DOMException);
110
111     // DOM Level 2 Abstract Views (DocumentView interface)
112
113     readonly attribute DOMWindow defaultView;
114
115     // DOM Level 2 Style (DocumentStyle interface)
116
117     readonly attribute StyleSheetList styleSheets;
118
119     // DOM Level 2 Style (DocumentCSS interface)
120
121     [ObjCLegacyUnnamedParameters] CSSStyleDeclaration getOverrideStyle(in [Optional=DefaultIsUndefined] Element element,
122                                                         in [Optional=DefaultIsUndefined] DOMString pseudoElement);
123
124     // DOM Level 3 XPath (XPathEvaluator interface)
125     [ObjCLegacyUnnamedParameters] XPathExpression createExpression(in [Optional=DefaultIsUndefined] DOMString expression,
126                                                     in [Optional=DefaultIsUndefined] XPathNSResolver resolver)
127         raises(DOMException);
128     XPathNSResolver    createNSResolver(in Node nodeResolver);
129     [ObjCLegacyUnnamedParameters] XPathResult evaluate(in [Optional=DefaultIsUndefined] DOMString expression,
130                                                   in [Optional=DefaultIsUndefined] Node contextNode,
131                                                   in [Optional=DefaultIsUndefined] XPathNSResolver resolver,
132                                                   in [Optional=DefaultIsUndefined] unsigned short type,
133                                                   in [Optional=DefaultIsUndefined] XPathResult inResult)
134         raises(DOMException);
135
136     // Common extensions
137     boolean            execCommand(in [Optional=DefaultIsUndefined] DOMString command,
138                                    in [Optional=DefaultIsUndefined] boolean userInterface,
139                                    in [TreatNullAs=NullString, TreatUndefinedAs=NullString,Optional=DefaultIsUndefined] DOMString value);
140
141 #if defined(LANGUAGE_OBJECTIVE_C) && LANGUAGE_OBJECTIVE_C
142     // FIXME: remove the these two versions once [Optional] is implemented for Objective-C.
143     boolean            execCommand(in DOMString command,
144                                    in boolean userInterface);
145     boolean            execCommand(in DOMString command);
146 #endif
147
148     boolean            queryCommandEnabled(in [Optional=DefaultIsUndefined] DOMString command);
149     boolean            queryCommandIndeterm(in [Optional=DefaultIsUndefined] DOMString command);
150     boolean            queryCommandState(in [Optional=DefaultIsUndefined] DOMString command);
151     boolean            queryCommandSupported(in [Optional=DefaultIsUndefined] DOMString command);
152     DOMString          queryCommandValue(in [Optional=DefaultIsUndefined] DOMString command);
153
154     // Moved down from HTMLDocument
155
156              [TreatNullAs=NullString] attribute DOMString title;
157     readonly attribute DOMString referrer;
158 #if defined(LANGUAGE_JAVASCRIPT) && LANGUAGE_JAVASCRIPT
159              [TreatNullAs=NullString] attribute DOMString domain
160                  setter raises (DOMException);
161 #else
162     readonly attribute DOMString domain;
163 #endif
164     readonly attribute DOMString URL;
165
166              [TreatNullAs=NullString] attribute DOMString cookie
167                  setter raises (DOMException),
168                  getter raises (DOMException);
169
170              attribute HTMLElement body
171                  setter raises (DOMException);
172
173     readonly attribute HTMLHeadElement head;
174     readonly attribute HTMLCollection images;
175     readonly attribute HTMLCollection applets;
176     readonly attribute HTMLCollection links;
177     readonly attribute HTMLCollection forms;
178     readonly attribute HTMLCollection anchors;
179     readonly attribute DOMString lastModified;
180
181     NodeList getElementsByName(in [Optional=DefaultIsUndefined] DOMString elementName);
182
183 #if defined(ENABLE_MICRODATA) && ENABLE_MICRODATA
184     NodeList getItems(in [TreatNullAs=NullString, TreatUndefinedAs=NullString, Optional=DefaultIsUndefined] DOMString typeNames);
185 #endif
186
187 #if defined(LANGUAGE_JAVASCRIPT) && LANGUAGE_JAVASCRIPT
188              [Custom] attribute Location location;
189 #endif
190
191     // IE extensions
192
193              [TreatReturnedNullStringAs=Undefined, TreatNullAs=NullString] attribute DOMString charset;
194     [TreatReturnedNullStringAs=Undefined] readonly attribute DOMString defaultCharset;
195     [TreatReturnedNullStringAs=Undefined] readonly attribute DOMString readyState;
196
197     Element            elementFromPoint(in [Optional=DefaultIsUndefined] long x, 
198                                         in [Optional=DefaultIsUndefined] long y);
199     Range              caretRangeFromPoint(in [Optional=DefaultIsUndefined] long x, 
200                                            in [Optional=DefaultIsUndefined] long y);
201
202     // Mozilla extensions
203 #if defined(LANGUAGE_JAVASCRIPT) && LANGUAGE_JAVASCRIPT
204     DOMSelection       getSelection();
205 #endif
206     [TreatReturnedNullStringAs=Null] readonly attribute DOMString characterSet;
207
208     // WebKit extensions
209
210     [TreatReturnedNullStringAs=Null] readonly attribute DOMString preferredStylesheetSet;
211              [TreatReturnedNullStringAs=Null, TreatNullAs=NullString] attribute DOMString selectedStylesheetSet;
212
213 #if !defined(LANGUAGE_JAVASCRIPT) || !LANGUAGE_JAVASCRIPT
214     CSSStyleDeclaration createCSSStyleDeclaration();
215 #endif
216
217 #if defined(LANGUAGE_OBJECTIVE_C) && LANGUAGE_OBJECTIVE_C
218     // DOM Level 2 Style Interface
219     [ObjCLegacyUnnamedParameters, ObjCUseDefaultView] CSSStyleDeclaration getComputedStyle(in Element element,
220                                                                   in DOMString pseudoElement);
221
222     // WebKit extension
223     // FIXME: remove the first version once [Optional] is implemented for Objective-C.
224     [ObjCUseDefaultView] CSSRuleList getMatchedCSSRules(in Element element,
225                                               in DOMString pseudoElement);
226     [ObjCUseDefaultView] CSSRuleList getMatchedCSSRules(in Element element,
227                                               in DOMString pseudoElement,
228                                               in [Optional] boolean authorOnly);
229                                               
230 #endif
231
232 #if !defined(LANGUAGE_CPP) || !LANGUAGE_CPP
233 #if !defined(LANGUAGE_OBJECTIVE_C) || !LANGUAGE_OBJECTIVE_C
234     CanvasRenderingContext getCSSCanvasContext(in DOMString contextId, in DOMString name, in long width, in long height);
235 #endif
236 #endif
237
238     // HTML 5
239     NodeList getElementsByClassName(in [Optional=DefaultIsUndefined] DOMString tagname);
240
241     readonly attribute DOMString compatMode;
242
243     // NodeSelector - Selector API
244     Element querySelector(in DOMString selectors)
245         raises(DOMException);
246     NodeList querySelectorAll(in DOMString selectors)
247         raises(DOMException);
248
249 #if defined(ENABLE_FULLSCREEN_API) && ENABLE_FULLSCREEN_API
250     // Mozilla version
251     readonly attribute boolean webkitIsFullScreen;
252     readonly attribute boolean webkitFullScreenKeyboardInputAllowed;
253     readonly attribute Element webkitCurrentFullScreenElement;
254     void webkitCancelFullScreen();
255
256     // W3C version
257     readonly attribute boolean webkitFullscreenEnabled;
258     readonly attribute Element webkitFullscreenElement;
259     void webkitExitFullscreen();
260 #endif
261
262     [Conditional=POINTER_LOCK] void webkitExitPointerLock();
263     [Conditional=POINTER_LOCK] readonly attribute Element webkitPointerLockElement;
264
265     [Conditional=CSS_REGIONS] DOMNamedFlowCollection webkitGetNamedFlows();
266
267 #if defined(LANGUAGE_JAVASCRIPT) && LANGUAGE_JAVASCRIPT
268     [Conditional=FONT_LOAD_EVENTS] readonly attribute FontLoader fontloader;
269 #endif
270
271 #if !defined(LANGUAGE_OBJECTIVE_C) || !LANGUAGE_OBJECTIVE_C
272     // Event handler DOM attributes
273     [NotEnumerable] attribute EventListener onabort;
274     [NotEnumerable] attribute EventListener onblur;
275     [NotEnumerable] attribute EventListener onchange;
276     [NotEnumerable] attribute EventListener onclick;
277     [NotEnumerable] attribute EventListener oncontextmenu;
278     [NotEnumerable] attribute EventListener ondblclick;
279     [NotEnumerable] attribute EventListener ondrag;
280     [NotEnumerable] attribute EventListener ondragend;
281     [NotEnumerable] attribute EventListener ondragenter;
282     [NotEnumerable] attribute EventListener ondragleave;
283     [NotEnumerable] attribute EventListener ondragover;
284     [NotEnumerable] attribute EventListener ondragstart;
285     [NotEnumerable] attribute EventListener ondrop;
286     [NotEnumerable] attribute EventListener onerror;
287     [NotEnumerable] attribute EventListener onfocus;
288     [NotEnumerable] attribute EventListener oninput;
289     [NotEnumerable] attribute EventListener oninvalid;
290     [NotEnumerable] attribute EventListener onkeydown;
291     [NotEnumerable] attribute EventListener onkeypress;
292     [NotEnumerable] attribute EventListener onkeyup;
293     [NotEnumerable] attribute EventListener onload;
294     [NotEnumerable] attribute EventListener onmousedown;
295     [NotEnumerable] attribute EventListener onmousemove;
296     [NotEnumerable] attribute EventListener onmouseout;
297     [NotEnumerable] attribute EventListener onmouseover;
298     [NotEnumerable] attribute EventListener onmouseup;
299     [NotEnumerable] attribute EventListener onmousewheel;
300     [NotEnumerable] attribute EventListener onreadystatechange;
301     [NotEnumerable] attribute EventListener onscroll;
302     [NotEnumerable] attribute EventListener onselect;
303     [NotEnumerable] attribute EventListener onsubmit;
304
305     // attribute [NotEnumerable] EventListener oncanplay;
306     // attribute [NotEnumerable] EventListener oncanplaythrough;
307     // attribute [NotEnumerable] EventListener ondurationchange;
308     // attribute [NotEnumerable] EventListener onemptied;
309     // attribute [NotEnumerable] EventListener onended;
310     // attribute [NotEnumerable] EventListener onloadeddata;
311     // attribute [NotEnumerable] EventListener onloadedmetadata;
312     // attribute [NotEnumerable] EventListener onloadstart;
313     // attribute [NotEnumerable] EventListener onpause;
314     // attribute [NotEnumerable] EventListener onplay;
315     // attribute [NotEnumerable] EventListener onplaying;
316     // attribute [NotEnumerable] EventListener onprogress;
317     // attribute [NotEnumerable] EventListener onratechange;
318     // attribute [NotEnumerable] EventListener onseeked;
319     // attribute [NotEnumerable] EventListener onseeking;
320     // attribute [NotEnumerable] EventListener onshow;
321     // attribute [NotEnumerable] EventListener onstalled;
322     // attribute [NotEnumerable] EventListener onsuspend;
323     // attribute [NotEnumerable] EventListener ontimeupdate;
324     // attribute [NotEnumerable] EventListener onvolumechange;
325     // attribute [NotEnumerable] EventListener onwaiting;
326
327     // WebKit extensions
328     [NotEnumerable] attribute EventListener onbeforecut;
329     [NotEnumerable] attribute EventListener oncut;
330     [NotEnumerable] attribute EventListener onbeforecopy;
331     [NotEnumerable] attribute EventListener oncopy;
332     [NotEnumerable] attribute EventListener onbeforepaste;
333     [NotEnumerable] attribute EventListener onpaste;
334     [NotEnumerable] attribute EventListener onreset;
335     [NotEnumerable] attribute EventListener onsearch;
336     [NotEnumerable] attribute EventListener onselectstart;
337     [NotEnumerable] attribute EventListener onselectionchange;
338     [NotEnumerable,Conditional=TOUCH_EVENTS] attribute EventListener ontouchstart;
339     [NotEnumerable,Conditional=TOUCH_EVENTS] attribute EventListener ontouchmove;
340     [NotEnumerable,Conditional=TOUCH_EVENTS] attribute EventListener ontouchend;
341     [NotEnumerable,Conditional=TOUCH_EVENTS] attribute EventListener ontouchcancel;
342     [NotEnumerable, Conditional=FULLSCREEN_API] attribute EventListener onwebkitfullscreenchange;
343     [NotEnumerable, Conditional=FULLSCREEN_API] attribute EventListener onwebkitfullscreenerror;
344     [NotEnumerable, Conditional=POINTER_LOCK] attribute EventListener onwebkitpointerlockchange;
345     [NotEnumerable, Conditional=POINTER_LOCK] attribute EventListener onwebkitpointerlockerror;
346     [NotEnumerable, Conditional=CSP_NEXT] attribute EventListener onsecuritypolicyviolation;
347 #endif
348
349 #if defined(ENABLE_TOUCH_EVENTS) && ENABLE_TOUCH_EVENTS
350     [ReturnNewObject] Touch createTouch(in [Optional=DefaultIsUndefined] DOMWindow window,
351                                                      in [Optional=DefaultIsUndefined] EventTarget target,
352                                                      in [Optional=DefaultIsUndefined] long identifier,
353                                                      in [Optional=DefaultIsUndefined] long pageX,
354                                                      in [Optional=DefaultIsUndefined] long pageY,
355                                                      in [Optional=DefaultIsUndefined] long screenX,
356                                                      in [Optional=DefaultIsUndefined] long screenY,
357                                                      in [Optional=DefaultIsUndefined] long webkitRadiusX,
358                                                      in [Optional=DefaultIsUndefined] long webkitRadiusY,
359                                                      in [Optional=DefaultIsUndefined] float webkitRotationAngle,
360                                                      in [Optional=DefaultIsUndefined] float webkitForce)
361         raises (DOMException);
362     [ReturnNewObject, Custom] TouchList createTouchList()
363         raises (DOMException);
364 #endif
365
366 #if defined(ENABLE_CUSTOM_ELEMENTS) && ENABLE_CUSTOM_ELEMENTS
367     [Conditional=CUSTOM_ELEMENTS, ImplementedAs=registerElement, CallWith=ScriptState]
368     CustomElementConstructor webkitRegister(in DOMString name, in [Optional] Dictionary options) raises(DOMException);
369     [ReturnNewObject]
370     Element createElement(in DOMString localName, in [TreatNullAs=NullString] DOMString typeExtension) raises (DOMException);
371     [ReturnNewObject]
372     Element createElementNS(in [TreatNullAs=NullString] DOMString namespaceURI, in DOMString qualifiedName,
373                             in [TreatNullAs=NullString] DOMString typeExtension) raises (DOMException);
374 #endif
375
376 #if defined(LANGUAGE_CPP) && LANGUAGE_CPP
377     // Extra WebCore methods exposed to allow compile-time casting in C++
378     boolean isHTMLDocument();
379 #endif
380
381     // Page visibility API.
382     [Conditional=PAGE_VISIBILITY_API] readonly attribute DOMString webkitVisibilityState;
383     [Conditional=PAGE_VISIBILITY_API] readonly attribute boolean webkitHidden;
384
385     // Security Policy API: http://dvcs.w3.org/hg/content-security-policy/raw-file/tip/csp-specification.dev.html#script-interfaces
386     [Conditional=CSP_NEXT] readonly attribute DOMSecurityPolicy securityPolicy;
387
388 };
389