2010-07-11 Maciej Stachowiak <mjs@apple.com>
[WebKit.git] / WebKit2 / WebProcess / WebPage / WebFrame.h
1 /*
2  * Copyright (C) 2010 Apple 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
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #ifndef WebFrame_h
27 #define WebFrame_h
28
29 #include "ImmutableArray.h"
30 #include "WebFrameLoaderClient.h"
31 #include <WebCore/FrameLoaderClient.h>
32 #include <WebCore/FrameLoaderTypes.h>
33 #include <WebCore/PolicyChecker.h>
34 #include <wtf/PassRefPtr.h>
35 #include <wtf/RefCounted.h>
36 #include <wtf/RefPtr.h>
37
38 namespace WebCore {
39     class Frame;
40     class HTMLFrameOwnerElement;
41     class String;
42 }
43
44 namespace WebKit {
45
46 class WebPage;
47
48 class WebFrame : public RefCounted<WebFrame> {
49 public:
50     static PassRefPtr<WebFrame> createMainFrame(WebPage*);
51     static PassRefPtr<WebFrame> createSubframe(WebPage*, const WebCore::String& frameName, WebCore::HTMLFrameOwnerElement*);
52     ~WebFrame();
53
54     // Called when the FrameLoaderClient (and therefore the WebCore::Frame) is being torn down.
55     void invalidate();
56
57     WebPage* page() const { return m_page; }
58     WebCore::Frame* coreFrame() const { return m_coreFrame; }
59
60     uint64_t frameID() const { return m_frameID; }
61
62     uint64_t setUpPolicyListener(WebCore::FramePolicyFunction);
63     void invalidatePolicyListener();
64     void didReceivePolicyDecision(uint64_t listenerID, WebCore::PolicyAction);
65
66     // WKBundleFrame API functions
67     bool isMainFrame() const;
68     WebCore::String url() const;
69     WebCore::String innerText() const;
70     PassRefPtr<ImmutableArray> childFrames();
71
72     unsigned numberOfActiveAnimations();
73     bool pauseAnimationOnElementWithId(const WebCore::String& animationName, const WebCore::String& elementID, double time);
74     
75 private:
76     static PassRefPtr<WebFrame> create(WebPage*, const WebCore::String& frameName, WebCore::HTMLFrameOwnerElement*);
77     WebFrame(WebPage*, const WebCore::String& frameName, WebCore::HTMLFrameOwnerElement*);
78
79     WebPage* m_page;
80     WebCore::Frame* m_coreFrame;
81
82     uint64_t m_policyListenerID;
83     WebCore::FramePolicyFunction m_policyFunction;
84
85     WebFrameLoaderClient m_frameLoaderClient;
86
87     uint64_t m_frameID;
88 };
89
90 } // namespace WebKit
91
92 #endif // WebFrame_h