Make it easy to test enabling formal delegate protocols
[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
57 #ifndef WK_ENABLE_FORMAL_DELEGATE_PROTOCOLS
58 @end
59
60 @interface NSObject (WebFrameLoadDelegate)
61 #endif
62
63 /*!
64     @method webView:didStartProvisionalLoadForFrame:
65     @abstract Notifies the delegate that the provisional load of a frame has started
66     @param webView The WebView sending the message
67     @param frame The frame for which the provisional load has started
68     @discussion This method is called after the provisional data source of a frame
69     has started to load.
70 */
71 - (void)webView:(WebView *)sender didStartProvisionalLoadForFrame:(WebFrame *)frame;
72
73 /*!
74     @method webView:didReceiveServerRedirectForProvisionalLoadForFrame:
75     @abstract Notifies the delegate that a server redirect occurred during the provisional load
76     @param webView The WebView sending the message
77     @param frame The frame for which the redirect occurred
78 */
79 - (void)webView:(WebView *)sender didReceiveServerRedirectForProvisionalLoadForFrame:(WebFrame *)frame;
80
81 /*!
82     @method webView:didFailProvisionalLoadWithError:forFrame:
83     @abstract Notifies the delegate that the provisional load has failed
84     @param webView The WebView sending the message
85     @param error The error that occurred
86     @param frame The frame for which the error occurred
87     @discussion This method is called after the provisional data source has failed to load.
88     The frame will continue to display the contents of the committed data source if there is one.
89 */
90 - (void)webView:(WebView *)sender didFailProvisionalLoadWithError:(NSError *)error forFrame:(WebFrame *)frame;
91
92 /*!
93     @method webView:didCommitLoadForFrame:
94     @abstract Notifies the delegate that the load has changed from provisional to committed
95     @param webView The WebView sending the message
96     @param frame The frame for which the load has committed
97     @discussion This method is called after the provisional data source has become the
98     committed data source.
99
100     In some cases, a single load may be committed more than once. This happens
101     in the case of multipart/x-mixed-replace, also known as "server push". In this case,
102     a single location change leads to multiple documents that are loaded in sequence. When
103     this happens, a new commit will be sent for each document.
104 */
105 - (void)webView:(WebView *)sender didCommitLoadForFrame:(WebFrame *)frame;
106
107 /*!
108     @method webView:didReceiveTitle:forFrame:
109     @abstract Notifies the delegate that the page title for a frame has been received
110     @param webView The WebView sending the message
111     @param title The new page title
112     @param frame The frame for which the title has been received
113     @discussion The title may update during loading; clients should be prepared for this.
114 */
115 - (void)webView:(WebView *)sender didReceiveTitle:(NSString *)title forFrame:(WebFrame *)frame;
116
117 /*!
118     @method webView:didReceiveIcon:forFrame:
119     @abstract Notifies the delegate that a page icon image for a frame has been received
120     @param webView The WebView sending the message
121     @param image The icon image. Also known as a "favicon".
122     @param frame The frame for which a page icon has been received
123 */
124 #if !TARGET_OS_IPHONE
125 - (void)webView:(WebView *)sender didReceiveIcon:(NSImage *)image forFrame:(WebFrame *)frame;
126 #endif
127
128 /*!
129     @method webView:didFinishLoadForFrame:
130     @abstract Notifies the delegate that the committed load of a frame has completed
131     @param webView The WebView sending the message
132     @param frame The frame that finished loading
133     @discussion This method is called after the committed data source of a frame has successfully loaded
134     and will only be called when all subresources such as images and stylesheets are done loading.
135     Plug-In content and JavaScript-requested loads may occur after this method is called.
136 */
137 - (void)webView:(WebView *)sender didFinishLoadForFrame:(WebFrame *)frame;
138
139 /*!
140     @method webView:didFailLoadWithError:forFrame:
141     @abstract Notifies the delegate that the committed load of a frame has failed
142     @param webView The WebView sending the message
143     @param error The error that occurred
144     @param frame The frame that failed to load
145     @discussion This method is called after a data source has committed but failed to completely load.
146 */
147 - (void)webView:(WebView *)sender didFailLoadWithError:(NSError *)error forFrame:(WebFrame *)frame;
148
149 /*!
150     @method webView:didChangeLocationWithinPageForFrame:
151     @abstract Notifies the delegate that the scroll position in a frame has changed
152     @param webView The WebView sending the message
153     @param frame The frame that scrolled
154     @discussion This method is called when anchors within a page have been clicked.
155 */
156 - (void)webView:(WebView *)sender didChangeLocationWithinPageForFrame:(WebFrame *)frame;
157
158 /*!
159     @method webView:willPerformClientRedirectToURL:delay:fireDate:forFrame:
160     @abstract Notifies the delegate that a frame will perform a client-side redirect
161     @param webView The WebView sending the message
162     @param URL The URL to be redirected to
163     @param seconds Seconds in which the redirect will happen
164     @param date The fire date
165     @param frame The frame on which the redirect will occur
166     @discussion This method can be used to continue progress feedback while a client-side
167     redirect is pending.
168 */
169 - (void)webView:(WebView *)sender willPerformClientRedirectToURL:(NSURL *)URL delay:(NSTimeInterval)seconds fireDate:(NSDate *)date forFrame:(WebFrame *)frame;
170
171 /*!
172     @method webView:didCancelClientRedirectForFrame:
173     @abstract Notifies the delegate that a pending client-side redirect has been cancelled
174     @param webView The WebView sending the message
175     @param frame The frame for which the pending redirect was cancelled
176     @discussion A client-side redirect can be cancelled if a frame changes location before the timeout.
177 */
178 - (void)webView:(WebView *)sender didCancelClientRedirectForFrame:(WebFrame *)frame;
179
180 /*!
181     @method webView:willCloseFrame:
182     @abstract Notifies the delegate that a frame will be closed
183     @param webView The WebView sending the message
184     @param frame The frame that will be closed
185     @discussion This method is called right before WebKit is done with the frame
186     and the objects that it contains.
187 */
188 - (void)webView:(WebView *)sender willCloseFrame:(WebFrame *)frame;
189
190 /*!
191     @method webView:didClearWindowObject:forFrame:
192     @abstract Notifies the delegate that the JavaScript window object in a frame has 
193     been cleared in preparation for a new load. This is the preferred place to set custom 
194     properties on the window object using the WebScriptObject and JavaScriptCore APIs.
195     @param webView The webView sending the message.
196     @param windowObject The WebScriptObject representing the frame's JavaScript window object.
197     @param frame The WebFrame to which windowObject belongs.
198     @discussion If a delegate implements both webView:didClearWindowObject:forFrame:
199     and webView:windowScriptObjectAvailable:, only webView:didClearWindowObject:forFrame: 
200     will be invoked. This enables a delegate to implement both methods for backwards 
201     compatibility with older versions of WebKit.
202 */
203 - (void)webView:(WebView *)webView didClearWindowObject:(WebScriptObject *)windowObject forFrame:(WebFrame *)frame;
204
205 /*!
206     @method webView:windowScriptObjectAvailable:
207     @abstract Notifies the delegate that the scripting object for a page is available.  This is called
208     before the page is loaded.  It may be useful to allow delegates to bind native objects to the window.
209     @param webView The webView sending the message.
210     @param windowScriptObject The WebScriptObject for the window in the scripting environment.
211     @discussion This method is deprecated. Consider using webView:didClearWindowObject:forFrame:
212     instead.
213 */
214 - (void)webView:(WebView *)webView windowScriptObjectAvailable:(WebScriptObject *)windowScriptObject WEBKIT_DEPRECATED_MAC(10_4, 10_5);
215
216 #if JSC_OBJC_API_ENABLED
217 /*!
218     @method webView:didCreateJavaScriptContext:contextForFrame:
219     @abstract Notifies the delegate that a new JavaScript context has been created created.
220     @param webView The WebView sending the message.
221     @param context The JSContext representing the frame's JavaScript window object.
222     @param frame The WebFrame to which the context belongs.
223     @discussion If a delegate implements webView:didCreateJavaScriptContext:forFrame: along with either 
224     webView:didClearWindowObject:forFrame: or webView:windowScriptObjectAvailable:, only 
225     webView:didCreateJavaScriptContext:forFrame will be invoked. This enables a delegate to implement 
226     multiple versions to maintain backwards compatibility with older versions of WebKit.
227 */
228 - (void)webView:(WebView *)webView didCreateJavaScriptContext:(JSContext *)context forFrame:(WebFrame *)frame;
229 #endif
230
231 @end