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 "../platform/WebImage.h"
35#include "WebNode.h"
36
37namespace blink {
38
39class Element;
40struct WebRect;
41
42// Provides access to some properties of a DOM element node.
43class WebElement : public WebNode {
44public:
45    WebElement() : WebNode() { }
46    WebElement(const WebElement& e) : WebNode(e) { }
47
48    WebElement& operator=(const WebElement& e) { WebNode::assign(e); return *this; }
49    void assign(const WebElement& e) { WebNode::assign(e); }
50
51    BLINK_EXPORT bool isFormControlElement() const;
52    BLINK_EXPORT bool isTextFormControlElement() const;
53    // Returns the qualified name, which may contain a prefix and a colon.
54    BLINK_EXPORT WebString tagName() const;
55    // Check if this element has the specified local tag name, and the HTML
56    // namespace. Tag name matching is case-insensitive.
57    BLINK_EXPORT bool hasHTMLTagName(const WebString&) const;
58    BLINK_EXPORT bool hasAttribute(const WebString&) const;
59    BLINK_EXPORT void removeAttribute(const WebString&);
60    BLINK_EXPORT WebString getAttribute(const WebString&) const;
61    BLINK_EXPORT bool setAttribute(const WebString& name, const WebString& value);
62    BLINK_EXPORT WebString innerText();
63    BLINK_EXPORT void requestFullScreen();
64    BLINK_EXPORT WebString attributeLocalName(unsigned index) const;
65    BLINK_EXPORT WebString attributeValue(unsigned index) const;
66    BLINK_EXPORT unsigned attributeCount() const;
67    BLINK_EXPORT WebNode shadowRoot() const;
68
69    // Returns the language code specified for this element. This attribute
70    // is inherited, so the returned value is drawn from the closest parent
71    // element that has the lang attribute set, or from the HTTP
72    // "Content-Language" header as a fallback.
73    BLINK_EXPORT WebString computeInheritedLanguage() const;
74
75    // Returns the bounds of the element in viewport space. The bounds
76    // have been adjusted to include any transformations. This view is
77    // also called the Root View in Blink.
78    // This function will update the layout if required.
79    BLINK_EXPORT WebRect boundsInViewportSpace();
80
81    // Returns the image contents of this element or a null WebImage
82    // if there isn't any.
83    BLINK_EXPORT WebImage imageContents();
84
85#if BLINK_IMPLEMENTATION
86    WebElement(const PassRefPtrWillBeRawPtr<Element>&);
87    WebElement& operator=(const PassRefPtrWillBeRawPtr<Element>&);
88    operator PassRefPtrWillBeRawPtr<Element>() const;
89#endif
90};
91
92} // namespace blink
93
94#endif
95