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