2 * Copyright (C) 2009 Google Inc. All rights reserved.
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are
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
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.
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.
34 #include "../platform/WebReferrerPolicy.h"
35 #include "../platform/WebVector.h"
36 #include "WebDraggableRegion.h"
37 #include "WebExceptionCode.h"
39 #include "WebSecurityOrigin.h"
41 #if BLINK_IMPLEMENTATION
46 namespace WTF { template <typename T> class PassRefPtr; }
51 template <class T> class Handle;
56 class WebDocumentType;
60 class WebElementCollection;
65 // Provides readonly access to some properties of a DOM document.
66 class WebDocument : public WebNode {
69 WebDocument(const WebDocument& e) : WebNode(e) { }
71 WebDocument& operator=(const WebDocument& e)
76 void assign(const WebDocument& e) { WebNode::assign(e); }
78 BLINK_EXPORT WebURL url() const;
79 // Note: Security checks should use the securityOrigin(), not url().
80 BLINK_EXPORT WebSecurityOrigin securityOrigin() const;
82 BLINK_EXPORT WebString encoding() const;
83 BLINK_EXPORT WebString contentLanguage() const;
84 BLINK_EXPORT WebString referrer() const;
86 // The url of the OpenSearch Desription Document (if any).
87 BLINK_EXPORT WebURL openSearchDescriptionURL() const;
89 // Returns the frame the document belongs to or 0 if the document is frameless.
90 BLINK_EXPORT WebFrame* frame() const;
91 BLINK_EXPORT bool isHTMLDocument() const;
92 BLINK_EXPORT bool isXHTMLDocument() const;
93 BLINK_EXPORT bool isPluginDocument() const;
94 BLINK_EXPORT WebURL baseURL() const;
96 // The firstPartyForCookies is used to compute whether this document
97 // appears in a "third-party" context for the purpose of third-party
99 BLINK_EXPORT WebURL firstPartyForCookies() const;
101 BLINK_EXPORT WebElement documentElement() const;
102 BLINK_EXPORT WebElement body() const;
103 BLINK_EXPORT WebElement head();
104 BLINK_EXPORT WebString title() const;
105 BLINK_EXPORT WebElementCollection all();
106 BLINK_EXPORT void forms(WebVector<WebFormElement>&) const;
107 BLINK_EXPORT void images(WebVector<WebElement>&);
108 BLINK_EXPORT WebURL completeURL(const WebString&) const;
109 BLINK_EXPORT WebElement getElementById(const WebString&) const;
110 BLINK_EXPORT WebNode focusedNode() const;
111 BLINK_EXPORT WebDocumentType doctype() const;
112 BLINK_EXPORT void cancelFullScreen();
113 BLINK_EXPORT WebElement fullScreenElement() const;
114 BLINK_EXPORT WebDOMEvent createEvent(const WebString& eventType);
115 BLINK_EXPORT WebReferrerPolicy referrerPolicy() const;
116 BLINK_EXPORT WebElement createElement(const WebString& tagName);
118 // Accessibility support. These methods should only be called on the
119 // top-level document, because one accessibility cache spans all of
120 // the documents on the page.
122 // Gets the accessibility object for this document.
123 BLINK_EXPORT WebAXObject accessibilityObject() const;
125 // Gets the accessibility object for an object on this page by ID.
126 BLINK_EXPORT WebAXObject accessibilityObjectFromID(int axID) const;
127 // Inserts the given CSS source code as a stylesheet in the document.
128 BLINK_EXPORT void insertStyleSheet(const WebString& sourceCode);
130 // Arranges to call WebFrameClient::didMatchCSS(frame(), ...) when one of
131 // the selectors matches or stops matching an element in this document.
132 // Each call to this method overrides any previous calls.
133 BLINK_EXPORT void watchCSSSelectors(const WebVector<WebString>& selectors);
135 BLINK_EXPORT WebVector<WebDraggableRegion> draggableRegions() const;
137 BLINK_EXPORT v8::Handle<v8::Value> registerEmbedderCustomElement(const WebString& name, v8::Handle<v8::Value> options, WebExceptionCode&);
139 #if BLINK_IMPLEMENTATION
140 WebDocument(const WTF::PassRefPtr<WebCore::Document>&);
141 WebDocument& operator=(const WTF::PassRefPtr<WebCore::Document>&);
142 operator WTF::PassRefPtr<WebCore::Document>() const;