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