586ac7b085a2686064b6bd5d15b9043d83f23ba7
[WebKit-https.git] / WebCore / dom / Element.idl
1 /*
2  * Copyright (C) 2006 Apple Computer, Inc.
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., 59 Temple Place - Suite 330,
18  * Boston, MA 02111-1307, USA.
19  */
20
21 module core {
22
23     interface [LegacyParent=KJS::DOMEventTargetNode, GenerateConstructor] Element : EventTargetNode {
24
25         // DOM Level 1 Core
26
27         readonly attribute [ConvertNullStringTo=Null] DOMString tagName;
28
29         [ConvertNullStringTo=Null] DOMString getAttribute(in DOMString name);
30
31         void setAttribute(in DOMString name,
32                           in DOMString value)
33             raises(DOMException);
34
35         void removeAttribute(in DOMString name)
36             raises(DOMException);
37
38         [UsesPassRefPtr] Attr getAttributeNode(in DOMString name);
39
40         [UsesPassRefPtr] Attr setAttributeNode(in Attr newAttr)
41             raises(DOMException);
42
43         [UsesPassRefPtr] Attr removeAttributeNode(in Attr oldAttr)
44             raises(DOMException);
45
46         [UsesPassRefPtr] NodeList getElementsByTagName(in DOMString name);
47
48         // DOM Level 2 Core
49
50         DOMString getAttributeNS(in [ConvertNullToNullString] DOMString namespaceURI,
51                                  in DOMString localName);
52
53         void setAttributeNS(in [ConvertNullToNullString] DOMString namespaceURI,
54                             in DOMString qualifiedName, 
55                             in DOMString value)
56             raises(DOMException);
57
58         void removeAttributeNS(in [ConvertNullToNullString] DOMString namespaceURI,
59                                in DOMString localName)
60             raises(DOMException);
61
62         [UsesPassRefPtr] NodeList getElementsByTagNameNS(in [ConvertNullToNullString] DOMString namespaceURI,
63                                                          in DOMString localName);
64
65         [UsesPassRefPtr] Attr getAttributeNodeNS(in [ConvertNullToNullString] DOMString namespaceURI,
66                                                  in DOMString localName);
67
68         [UsesPassRefPtr] Attr setAttributeNodeNS(in Attr newAttr)
69             raises(DOMException);
70
71         boolean hasAttribute(in DOMString name);
72
73         boolean hasAttributeNS(in [ConvertNullToNullString] DOMString namespaceURI,
74                                in DOMString localName);
75
76         readonly attribute [ObjCCatagory=DOMElementCSSInlineStyle] CSSStyleDeclaration style;
77
78         // Common extensions
79
80         readonly attribute [ObjCCatagory=DOMElementExtensions] long offsetLeft;
81
82         readonly attribute [ObjCCatagory=DOMElementExtensions] long offsetTop;
83
84         readonly attribute [ObjCCatagory=DOMElementExtensions] long offsetWidth;
85
86         readonly attribute [ObjCCatagory=DOMElementExtensions] long offsetHeight;
87
88         readonly attribute [ObjCCatagory=DOMElementExtensions] Element offsetParent;
89
90         readonly attribute [ObjCCatagory=DOMElementExtensions] long clientWidth;
91
92         readonly attribute [ObjCCatagory=DOMElementExtensions] long clientHeight;
93
94         attribute [ObjCCatagory=DOMElementExtensions] long scrollLeft;
95
96         attribute [ObjCCatagory=DOMElementExtensions] long scrollTop;
97
98         readonly attribute [ObjCCatagory=DOMElementExtensions] long scrollWidth;
99
100         readonly attribute [ObjCCatagory=DOMElementExtensions] long scrollHeight;
101
102         void focus();
103
104         void blur();
105
106         [ObjCCatagory=DOMElementExtensions] void scrollIntoView(in [Optional] boolean alignWithTop);
107
108         // IE extensions
109
110         [Exclude=ObjC] Node insertAdjacentElement(in DOMString position, 
111                                                   in Node newElement)
112             raises(DOMException);
113
114         [Exclude=ObjC] boolean contains(in Element element);
115
116         // WebKit extensions
117
118         [ObjCCatagory=DOMElementExtensions] void scrollIntoViewIfNeeded(in [Optional] boolean centerIfNeeded);
119
120         [Exclude=ObjC] void scrollByLines(in long lines);
121
122         [Exclude=ObjC] void scrollByPages(in long pages);
123
124     };
125
126 }