Unreviewed, rolling out r151978.
[WebKit-https.git] / Source / WebCore / dom / Node.idl
1 /*
2  * Copyright (C) 2006, 2007, 2008, 2009 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     JSCustomHeader,
23     JSCustomMarkFunction,
24     JSCustomPushEventHandlerScope,
25     CustomIsReachable,
26     JSCustomFinalize,
27     CustomToJSObject,
28     EventTarget,
29     JSGenerateToNativeObject,
30     JSInlineGetOwnPropertySlot,
31     ObjCPolymorphic,
32 ] interface Node
33 #if defined(LANGUAGE_OBJECTIVE_C) && LANGUAGE_OBJECTIVE_C
34     : Object, EventTarget
35 #endif /* defined(LANGUAGE_OBJECTIVE_C) */
36  {
37     // NodeType
38     const unsigned short      ELEMENT_NODE                   = 1;
39     const unsigned short      ATTRIBUTE_NODE                 = 2;
40     const unsigned short      TEXT_NODE                      = 3;
41     const unsigned short      CDATA_SECTION_NODE             = 4;
42     const unsigned short      ENTITY_REFERENCE_NODE          = 5;
43     const unsigned short      ENTITY_NODE                    = 6;
44     const unsigned short      PROCESSING_INSTRUCTION_NODE    = 7;
45     const unsigned short      COMMENT_NODE                   = 8;
46     const unsigned short      DOCUMENT_NODE                  = 9;
47     const unsigned short      DOCUMENT_TYPE_NODE             = 10;
48     const unsigned short      DOCUMENT_FRAGMENT_NODE         = 11;
49     const unsigned short      NOTATION_NODE                  = 12;
50
51     [TreatReturnedNullStringAs=Null] readonly attribute DOMString        nodeName;
52
53     // FIXME: the spec says this can also raise on retrieval.
54     [TreatReturnedNullStringAs=Null, TreatNullAs=NullString, SetterRaisesException] attribute DOMString nodeValue;
55
56     readonly attribute unsigned short   nodeType;
57     readonly attribute Node             parentNode;
58     readonly attribute NodeList         childNodes;
59     readonly attribute Node             firstChild;
60     readonly attribute Node             lastChild;
61     readonly attribute Node             previousSibling;
62     readonly attribute Node             nextSibling;
63     readonly attribute Document         ownerDocument;
64
65     [ObjCLegacyUnnamedParameters, Custom, RaisesException] Node insertBefore([CustomReturn] Node newChild,
66                                                             Node refChild);
67     [ObjCLegacyUnnamedParameters, Custom, RaisesException] Node replaceChild(Node newChild,
68                                                             [CustomReturn] Node oldChild);
69     [Custom, RaisesException] Node removeChild([CustomReturn] Node oldChild);
70     [Custom, RaisesException] Node appendChild([CustomReturn] Node newChild);
71
72     boolean            hasChildNodes();
73     Node               cloneNode([Default=Undefined] optional boolean deep);
74     void               normalize();
75
76     // Introduced in DOM Level 2:
77
78     [ObjCLegacyUnnamedParameters] boolean isSupported([Default=Undefined] optional DOMString feature, 
79                                        [TreatNullAs=NullString,Default=Undefined] optional DOMString version);
80
81     [TreatReturnedNullStringAs=Null] readonly attribute DOMString        namespaceURI;
82     [TreatReturnedNullStringAs=Null, TreatNullAs=NullString, SetterRaisesException] attribute DOMString prefix;
83     [TreatReturnedNullStringAs=Null] readonly attribute DOMString        localName;
84
85 #if defined(LANGUAGE_OBJECTIVE_C)
86     readonly attribute NamedNodeMap     attributes;
87     boolean            hasAttributes();
88 #endif
89
90
91     // Introduced in DOM Level 3:
92
93     [TreatReturnedNullStringAs=Null] readonly attribute DOMString       baseURI;
94
95     // FIXME: the spec says this can also raise on retrieval.
96     [TreatReturnedNullStringAs=Null, TreatNullAs=NullString, SetterRaisesException] attribute DOMString textContent;
97
98     boolean            isSameNode([Default=Undefined] optional Node other);
99     boolean            isEqualNode([Default=Undefined] optional Node other);
100     [TreatReturnedNullStringAs=Null] DOMString          lookupPrefix([TreatNullAs=NullString,Default=Undefined] optional DOMString namespaceURI);
101     boolean            isDefaultNamespace([TreatNullAs=NullString,Default=Undefined] optional DOMString namespaceURI);
102     [TreatReturnedNullStringAs=Null] DOMString          lookupNamespaceURI([TreatNullAs=NullString,Default=Undefined] optional DOMString prefix);
103
104     // DocumentPosition
105     const unsigned short      DOCUMENT_POSITION_DISCONNECTED = 0x01;
106     const unsigned short      DOCUMENT_POSITION_PRECEDING    = 0x02;
107     const unsigned short      DOCUMENT_POSITION_FOLLOWING    = 0x04;
108     const unsigned short      DOCUMENT_POSITION_CONTAINS     = 0x08;
109     const unsigned short      DOCUMENT_POSITION_CONTAINED_BY = 0x10;
110     const unsigned short      DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC = 0x20;
111
112     unsigned short     compareDocumentPosition([Default=Undefined] optional Node other);
113
114     // Introduced in DOM4
115     boolean contains([Default=Undefined] optional Node other);
116
117     // IE extensions
118     readonly attribute Element          parentElement;
119
120 #if defined(LANGUAGE_OBJECTIVE_C) && LANGUAGE_OBJECTIVE_C
121     // Objective-C extensions
122     readonly attribute boolean          isContentEditable;
123
124     void inspect();
125 #endif /* defined(LANGUAGE_OBJECTIVE_C) */
126
127 #if !defined(LANGUAGE_CPP) || !LANGUAGE_CPP
128 #if !defined(LANGUAGE_OBJECTIVE_C) || !LANGUAGE_OBJECTIVE_C
129     void addEventListener(DOMString type, 
130                           EventListener listener, 
131                           optional boolean useCapture);
132     void removeEventListener(DOMString type, 
133                              EventListener listener, 
134                              optional boolean useCapture);
135     [RaisesException] boolean dispatchEvent(Event event);
136 #endif
137 #endif
138
139 #if defined(LANGUAGE_CPP) && LANGUAGE_CPP
140     [Custom] void addEventListener(DOMString type, 
141                                       EventListener listener, 
142                                       boolean useCapture);
143     [Custom] void removeEventListener(DOMString type, 
144                                          EventListener listener, 
145                                          boolean useCapture);
146     [RaisesException] boolean dispatchEvent(Event event);
147 #endif
148
149 };
150