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