WinCairo build fails to link.
[WebKit-https.git] / Source / WebKit / chromium / public / WebElement.h
1 /*
2  * Copyright (C) 2009 Google Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are
6  * met:
7  *
8  *     * Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  *     * Redistributions in binary form must reproduce the above
11  * copyright notice, this list of conditions and the following disclaimer
12  * in the documentation and/or other materials provided with the
13  * distribution.
14  *     * Neither the name of Google Inc. nor the names of its
15  * contributors may be used to endorse or promote products derived from
16  * this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30
31 #ifndef WebElement_h
32 #define WebElement_h
33
34 #include "WebNode.h"
35
36 #if WEBKIT_IMPLEMENTATION
37 namespace WebCore { class Element; }
38 #endif
39
40 namespace WebKit {
41 struct WebRect;
42
43     // Provides access to some properties of a DOM element node.
44     class WebElement : public WebNode {
45     public:
46         WebElement() : WebNode() { }
47         WebElement(const WebElement& e) : WebNode(e) { }
48
49         WebElement& operator=(const WebElement& e) { WebNode::assign(e); return *this; }
50         void assign(const WebElement& e) { WebNode::assign(e); }
51
52         WEBKIT_EXPORT bool isFormControlElement() const;
53         WEBKIT_EXPORT bool isTextFormControlElement() const;
54         // Returns the qualified name, which may contain a prefix and a colon.
55         WEBKIT_EXPORT WebString tagName() const;
56         // Check if this element has the specified qualified name. This function
57         // doesn't makes much sense because we have no ways to check namespace
58         // URI. Do not use this.
59         WEBKIT_EXPORT bool hasTagName(const WebString&) const;
60         // Check if this element has the specified local tag name, and the HTML
61         // namespace. Tag name matching is case-insensitive.
62         WEBKIT_EXPORT bool hasHTMLTagName(const WebString&) const;
63         WEBKIT_EXPORT bool hasAttribute(const WebString&) const;
64         WEBKIT_EXPORT void removeAttribute(const WebString&);
65         WEBKIT_EXPORT WebString getAttribute(const WebString&) const;
66         WEBKIT_EXPORT bool setAttribute(const WebString& name, const WebString& value);
67         WEBKIT_EXPORT WebString innerText();
68         WEBKIT_EXPORT WebDocument document() const;
69         WEBKIT_EXPORT void requestFullScreen();
70         WEBKIT_EXPORT WebString attributeLocalName(unsigned index) const;
71         WEBKIT_EXPORT WebString attributeValue(unsigned index) const;
72         WEBKIT_EXPORT unsigned attributeCount() const;
73         WEBKIT_EXPORT WebNode shadowRoot() const;
74
75         // Returns the language code specified for this element.  This attribute
76         // is inherited, so the returned value is drawn from the closest parent
77         // element that has the lang attribute set, or from the HTTP
78         // "Content-Language" header as a fallback.
79         WEBKIT_EXPORT WebString computeInheritedLanguage() const;
80
81         // Returns the bounds of the element in viewport space. The bounds
82         // have been adjusted to include any transformations. This view is
83         // also called the Root View in WebKit.
84         // This function will update the layout if required.
85         WEBKIT_EXPORT WebRect boundsInViewportSpace();
86
87 #if WEBKIT_IMPLEMENTATION
88         WebElement(const WTF::PassRefPtr<WebCore::Element>&);
89         WebElement& operator=(const WTF::PassRefPtr<WebCore::Element>&);
90         operator WTF::PassRefPtr<WebCore::Element>() const;
91 #endif
92     };
93
94 } // namespace WebKit
95
96 #endif