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 WebDocument_h 32 #define WebDocument_h 33 34 #include "../platform/WebReferrerPolicy.h" 35 #include "../platform/WebVector.h" 36 #include "WebDraggableRegion.h" 37 #include "WebExceptionCode.h" 38 #include "WebFrame.h" 39 #include "WebNode.h" 40 #include "WebSecurityOrigin.h" 41 42 #if BLINK_IMPLEMENTATION 43 namespace WebCore { 44 class Document; 45 class DocumentType; 46 } 47 namespace WTF { template <typename T> class PassRefPtr; } 48 #endif 49 50 namespace v8 { 51 class Value; 52 template <class T> class Handle; 53 } 54 55 namespace blink { 56 class WebAXObject; 57 class WebDocumentType; 58 class WebElement; 59 class WebFormElement; 60 class WebElementCollection; 61 class WebNodeList; 62 class WebString; 63 class WebURL; 64 65 // Provides readonly access to some properties of a DOM document. 66 class WebDocument : public WebNode { 67 public: WebDocument()68 WebDocument() { } WebDocument(const WebDocument & e)69 WebDocument(const WebDocument& e) : WebNode(e) { } 70 71 WebDocument& operator=(const WebDocument& e) 72 { 73 WebNode::assign(e); 74 return *this; 75 } assign(const WebDocument & e)76 void assign(const WebDocument& e) { WebNode::assign(e); } 77 78 BLINK_EXPORT WebURL url() const; 79 // Note: Security checks should use the securityOrigin(), not url(). 80 BLINK_EXPORT WebSecurityOrigin securityOrigin() const; 81 82 BLINK_EXPORT WebString encoding() const; 83 BLINK_EXPORT WebString contentLanguage() const; 84 BLINK_EXPORT WebString referrer() const; 85 BLINK_EXPORT WebColor themeColor() const; 86 // TODO: Remove when chromium is changed to themeColor(). brandColor()87 BLINK_EXPORT WebColor brandColor() const { return 0; } 88 // The url of the OpenSearch Desription Document (if any). 89 BLINK_EXPORT WebURL openSearchDescriptionURL() const; 90 91 // Returns the frame the document belongs to or 0 if the document is frameless. 92 BLINK_EXPORT WebLocalFrame* frame() const; 93 BLINK_EXPORT bool isHTMLDocument() const; 94 BLINK_EXPORT bool isXHTMLDocument() const; 95 BLINK_EXPORT bool isPluginDocument() const; 96 BLINK_EXPORT WebURL baseURL() const; 97 98 // The firstPartyForCookies is used to compute whether this document 99 // appears in a "third-party" context for the purpose of third-party 100 // cookie blocking. 101 BLINK_EXPORT WebURL firstPartyForCookies() const; 102 103 BLINK_EXPORT WebElement documentElement() const; 104 BLINK_EXPORT WebElement body() const; 105 BLINK_EXPORT WebElement head(); 106 BLINK_EXPORT WebString title() const; 107 BLINK_EXPORT WebElementCollection all(); 108 BLINK_EXPORT void forms(WebVector<WebFormElement>&) const; 109 BLINK_EXPORT void images(WebVector<WebElement>&); 110 BLINK_EXPORT WebURL completeURL(const WebString&) const; 111 BLINK_EXPORT WebElement getElementById(const WebString&) const; 112 BLINK_EXPORT WebElement focusedElement() const; 113 BLINK_EXPORT WebDocumentType doctype() const; 114 BLINK_EXPORT void cancelFullScreen(); 115 BLINK_EXPORT WebElement fullScreenElement() const; 116 BLINK_EXPORT WebDOMEvent createEvent(const WebString& eventType); 117 BLINK_EXPORT WebReferrerPolicy referrerPolicy() const; 118 BLINK_EXPORT WebElement createElement(const WebString& tagName); 119 120 // Accessibility support. These methods should only be called on the 121 // top-level document, because one accessibility cache spans all of 122 // the documents on the page. 123 124 // Gets the accessibility object for this document. 125 BLINK_EXPORT WebAXObject accessibilityObject() const; 126 127 // Gets the accessibility object for an object on this page by ID. 128 BLINK_EXPORT WebAXObject accessibilityObjectFromID(int axID) const; 129 // Inserts the given CSS source code as a stylesheet in the document. 130 BLINK_EXPORT void insertStyleSheet(const WebString& sourceCode); 131 132 // Arranges to call WebFrameClient::didMatchCSS(frame(), ...) when one of 133 // the selectors matches or stops matching an element in this document. 134 // Each call to this method overrides any previous calls. 135 BLINK_EXPORT void watchCSSSelectors(const WebVector<WebString>& selectors); 136 137 BLINK_EXPORT WebVector<WebDraggableRegion> draggableRegions() const; 138 139 BLINK_EXPORT v8::Handle<v8::Value> registerEmbedderCustomElement(const WebString& name, v8::Handle<v8::Value> options, WebExceptionCode&); 140 141 #if BLINK_IMPLEMENTATION 142 WebDocument(const PassRefPtrWillBeRawPtr<WebCore::Document>&); 143 WebDocument& operator=(const PassRefPtrWillBeRawPtr<WebCore::Document>&); 144 operator PassRefPtrWillBeRawPtr<WebCore::Document>() const; 145 #endif 146 }; 147 148 } // namespace blink 149 150 #endif 151