167c3ef2c161cf86ff88d264da186326b5f14b95
[WebKit-https.git] / Source / WebKit / mac / WebView / WebFrameLoadDelegate.h
1 /*
2  * Copyright (C) 2003, 2004, 2005 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  *
8  * 1.  Redistributions of source code must retain the above copyright
9  *     notice, this list of conditions and the following disclaimer. 
10  * 2.  Redistributions in binary form must reproduce the above copyright
11  *     notice, this list of conditions and the following disclaimer in the
12  *     documentation and/or other materials provided with the distribution. 
13  * 3.  Neither the name of Apple Inc. ("Apple") nor the names of
14  *     its contributors may be used to endorse or promote products derived
15  *     from this software without specific prior written permission. 
16  *
17  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  */
28
29 #import <Foundation/Foundation.h>
30 #import <JavaScriptCore/JSBase.h>
31 #import <WebKitLegacy/WebKitAvailability.h>
32
33 #if !TARGET_OS_IPHONE
34 #import <AppKit/AppKit.h>
35 #endif
36
37 @class NSError;
38 @class WebFrame;
39 @class WebScriptObject;
40 @class WebView;
41
42 #if JSC_OBJC_API_ENABLED
43 @class JSContext;
44 #endif
45
46 /*!
47     @category WebFrameLoadDelegate
48     @discussion A WebView's WebFrameLoadDelegate tracks the loading progress of its frames.
49     When a data source of a frame starts to load, the data source is considered "provisional".
50     Once at least one byte is received, the data source is considered "committed". This is done
51     so the contents of the frame will not be lost if the new data source fails to successfully load.
52 */
53 @protocol WebFrameLoadDelegate <NSObject>
54
55 @optional
56 @end
57
58 @interface NSObject (WebFrameLoadDelegate)
59
60 /*!
61     @method webView:didStartProvisionalLoadForFrame:
62     @abstract Notifies the delegate that the provisional load of a frame has started
63     @param webView The WebView sending the message
64     @param frame The frame for which the provisional load has started
65     @discussion This method is called after the provisional data source of a frame
66     has started to load.
67 */
68 - (void)webView:(WebView *)sender didStartProvisionalLoadForFrame:(WebFrame *)frame;
69
70 /*!
71     @method webView:didReceiveServerRedirectForProvisionalLoadForFrame:
72     @abstract Notifies the delegate that a server redirect occurred during the provisional load
73     @param webView The WebView sending the message
74     @param frame The frame for which the redirect occurred
75 */
76 - (void)webView:(WebView *)sender didReceiveServerRedirectForProvisionalLoadForFrame:(WebFrame *)frame;
77
78 /*!
79     @method webView:didFailProvisionalLoadWithError:forFrame:
80     @abstract Notifies the delegate that the provisional load has failed
81     @param webView The WebView sending the message
82     @param error The error that occurred
83     @param frame The frame for which the error occurred
84     @discussion This method is called after the provisional data source has failed to load.
85     The frame will continue to display the contents of the committed data source if there is one.
86 */
87 - (void)webView:(WebView *)sender didFailProvisionalLoadWithError:(NSError *)error forFrame:(WebFrame *)frame;
88
89 /*!
90     @method webView:didCommitLoadForFrame:
91     @abstract Notifies the delegate that the load has changed from provisional to committed
92     @param webView The WebView sending the message
93     @param frame The frame for which the load has committed
94     @discussion This method is called after the provisional data source has become the
95     committed data source.
96
97     In some cases, a single load may be committed more than once. This happens
98     in the case of multipart/x-mixed-replace, also known as "server push". In this case,
99     a single location change leads to multiple documents that are loaded in sequence. When
100     this happens, a new commit will be sent for each document.
101 */
102 - (void)webView:(WebView *)sender didCommitLoadForFrame:(WebFrame *)frame;
103
104 /*!
105     @method webView:didReceiveTitle:forFrame:
106     @abstract Notifies the delegate that the page title for a frame has been received
107     @param webView The WebView sending the message
108     @param title The new page title
109     @param frame The frame for which the title has been received
110     @discussion The title may update during loading; clients should be prepared for this.
111 */
112 - (void)webView:(WebView *)sender didReceiveTitle:(NSString *)title forFrame:(WebFrame *)frame;
113
114 /*!
115     @method webView:didReceiveIcon:forFrame:
116     @abstract Notifies the delegate that a page icon image for a frame has been received
117     @param webView The WebView sending the message
118     @param image The icon image. Also known as a "favicon".
119     @param frame The frame for which a page icon has been received
120 */
121 #if !TARGET_OS_IPHONE
122 - (void)webView:(WebView *)sender didReceiveIcon:(NSImage *)image forFrame:(WebFrame *)frame;
123 #endif
124
125 /*!
126     @method webView:didFinishLoadForFrame:
127     @abstract Notifies the delegate that the committed load of a frame has completed
128     @param webView The WebView sending the message
129     @param frame The frame that finished loading
130     @discussion This method is called after the committed data source of a frame has successfully loaded
131     and will only be called when all subresources such as images and stylesheets are done loading.
132     Plug-In content and JavaScript-requested loads may occur after this method is called.
133 */
134 - (void)webView:(WebView *)sender didFinishLoadForFrame:(WebFrame *)frame;
135
136 /*!
137     @method webView:didFailLoadWithError:forFrame:
138     @abstract Notifies the delegate that the committed load of a frame has failed
139     @param webView The WebView sending the message
140     @param error The error that occurred
141     @param frame The frame that failed to load
142     @discussion This method is called after a data source has committed but failed to completely load.
143 */
144 - (void)webView:(WebView *)sender didFailLoadWithError:(NSError *)error forFrame:(WebFrame *)frame;
145
146 /*!
147     @method webView:didChangeLocationWithinPageForFrame:
148     @abstract Notifies the delegate that the scroll position in a frame has changed
149     @param webView The WebView sending the message
150     @param frame The frame that scrolled
151     @discussion This method is called when anchors within a page have been clicked.
152 */
153 - (void)webView:(WebView *)sender didChangeLocationWithinPageForFrame:(WebFrame *)frame;
154
155 /*!
156     @method webView:willPerformClientRedirectToURL:delay:fireDate:forFrame:
157     @abstract Notifies the delegate that a frame will perform a client-side redirect
158     @param webView The WebView sending the message
159     @param URL The URL to be redirected to
160     @param seconds Seconds in which the redirect will happen
161     @param date The fire date
162     @param frame The frame on which the redirect will occur
163     @discussion This method can be used to continue progress feedback while a client-side
164     redirect is pending.
165 */
166 - (void)webView:(WebView *)sender willPerformClientRedirectToURL:(NSURL *)URL delay:(NSTimeInterval)seconds fireDate:(NSDate *)date forFrame:(WebFrame *)frame;
167
168 /*!
169     @method webView:didCancelClientRedirectForFrame:
170     @abstract Notifies the delegate that a pending client-side redirect has been cancelled
171     @param webView The WebView sending the message
172     @param frame The frame for which the pending redirect was cancelled
173     @discussion A client-side redirect can be cancelled if a frame changes location before the timeout.
174 */
175 - (void)webView:(WebView *)sender didCancelClientRedirectForFrame:(WebFrame *)frame;
176
177 /*!
178     @method webView:willCloseFrame:
179     @abstract Notifies the delegate that a frame will be closed
180     @param webView The WebView sending the message
181     @param frame The frame that will be closed
182     @discussion This method is called right before WebKit is done with the frame
183     and the objects that it contains.
184 */
185 - (void)webView:(WebView *)sender willCloseFrame:(WebFrame *)frame;
186
187 /*!
188     @method webView:didClearWindowObject:forFrame:
189     @abstract Notifies the delegate that the JavaScript window object in a frame has 
190     been cleared in preparation for a new load. This is the preferred place to set custom 
191     properties on the window object using the WebScriptObject and JavaScriptCore APIs.
192     @param webView The webView sending the message.
193     @param windowObject The WebScriptObject representing the frame's JavaScript window object.
194     @param frame The WebFrame to which windowObject belongs.
195     @discussion If a delegate implements both webView:didClearWindowObject:forFrame:
196     and webView:windowScriptObjectAvailable:, only webView:didClearWindowObject:forFrame: 
197     will be invoked. This enables a delegate to implement both methods for backwards 
198     compatibility with older versions of WebKit.
199 */
200 - (void)webView:(WebView *)webView didClearWindowObject:(WebScriptObject *)windowObject forFrame:(WebFrame *)frame;
201
202 /*!
203     @method webView:windowScriptObjectAvailable:
204     @abstract Notifies the delegate that the scripting object for a page is available.  This is called
205     before the page is loaded.  It may be useful to allow delegates to bind native objects to the window.
206     @param webView The webView sending the message.
207     @param windowScriptObject The WebScriptObject for the window in the scripting environment.
208     @discussion This method is deprecated. Consider using webView:didClearWindowObject:forFrame:
209     instead.
210 */
211 - (void)webView:(WebView *)webView windowScriptObjectAvailable:(WebScriptObject *)windowScriptObject WEBKIT_DEPRECATED_MAC(10_4, 10_5);
212
213 #if JSC_OBJC_API_ENABLED
214 /*!
215     @method webView:didCreateJavaScriptContext:contextForFrame:
216     @abstract Notifies the delegate that a new JavaScript context has been created created.
217     @param webView The WebView sending the message.
218     @param context The JSContext representing the frame's JavaScript window object.
219     @param frame The WebFrame to which the context belongs.
220     @discussion If a delegate implements webView:didCreateJavaScriptContext:forFrame: along with either 
221     webView:didClearWindowObject:forFrame: or webView:windowScriptObjectAvailable:, only 
222     webView:didCreateJavaScriptContext:forFrame will be invoked. This enables a delegate to implement 
223     multiple versions to maintain backwards compatibility with older versions of WebKit.
224 */
225 - (void)webView:(WebView *)webView didCreateJavaScriptContext:(JSContext *)context forFrame:(WebFrame *)frame;
226 #endif
227
228 @end