1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
//! This file has been automatically generated by `objc2`'s `header-translator`.
//! DO NOT EDIT
use core::ffi::*;
use objc2::__framework_prelude::*;
#[cfg(feature = "objc2-app-kit")]
#[cfg(target_os = "macos")]
use objc2_app_kit::*;
use objc2_foundation::*;
use crate::*;
extern_protocol!(
/// A WebView's WebFrameLoadDelegate tracks the loading progress of its frames.
/// When a data source of a frame starts to load, the data source is considered "provisional".
/// Once at least one byte is received, the data source is considered "committed". This is done
/// so the contents of the frame will not be lost if the new data source fails to successfully load.
///
/// See also [Apple's documentation](https://developer.apple.com/documentation/webkit/webframeloaddelegate?language=objc)
#[deprecated]
pub unsafe trait WebFrameLoadDelegate: NSObjectProtocol {
#[cfg(all(feature = "WebFrame", feature = "WebView", feature = "objc2-app-kit"))]
#[cfg(target_os = "macos")]
/// Notifies the delegate that the provisional load of a frame has started
///
/// Parameter `sender`: The WebView sending the message
///
/// Parameter `frame`: The frame for which the provisional load has started
///
/// This method is called after the provisional data source of a frame
/// has started to load.
#[deprecated]
#[optional]
#[unsafe(method(webView:didStartProvisionalLoadForFrame:))]
#[unsafe(method_family = none)]
unsafe fn webView_didStartProvisionalLoadForFrame(
&self,
sender: Option<&WebView>,
frame: Option<&WebFrame>,
);
#[cfg(all(feature = "WebFrame", feature = "WebView", feature = "objc2-app-kit"))]
#[cfg(target_os = "macos")]
/// Notifies the delegate that a server redirect occurred during the provisional load
///
/// Parameter `sender`: The WebView sending the message
///
/// Parameter `frame`: The frame for which the redirect occurred
#[deprecated]
#[optional]
#[unsafe(method(webView:didReceiveServerRedirectForProvisionalLoadForFrame:))]
#[unsafe(method_family = none)]
unsafe fn webView_didReceiveServerRedirectForProvisionalLoadForFrame(
&self,
sender: Option<&WebView>,
frame: Option<&WebFrame>,
);
#[cfg(all(feature = "WebFrame", feature = "WebView", feature = "objc2-app-kit"))]
#[cfg(target_os = "macos")]
/// Notifies the delegate that the provisional load has failed
///
/// Parameter `sender`: The WebView sending the message
///
/// Parameter `error`: The error that occurred
///
/// Parameter `frame`: The frame for which the error occurred
///
/// This method is called after the provisional data source has failed to load.
/// The frame will continue to display the contents of the committed data source if there is one.
#[deprecated]
#[optional]
#[unsafe(method(webView:didFailProvisionalLoadWithError:forFrame:))]
#[unsafe(method_family = none)]
unsafe fn webView_didFailProvisionalLoadWithError_forFrame(
&self,
sender: Option<&WebView>,
error: Option<&NSError>,
frame: Option<&WebFrame>,
);
#[cfg(all(feature = "WebFrame", feature = "WebView", feature = "objc2-app-kit"))]
#[cfg(target_os = "macos")]
/// Notifies the delegate that the load has changed from provisional to committed
///
/// Parameter `sender`: The WebView sending the message
///
/// Parameter `frame`: The frame for which the load has committed
///
/// This method is called after the provisional data source has become the
/// committed data source.
///
/// In some cases, a single load may be committed more than once. This happens
/// in the case of multipart/x-mixed-replace, also known as "server push". In this case,
/// a single location change leads to multiple documents that are loaded in sequence. When
/// this happens, a new commit will be sent for each document.
#[deprecated]
#[optional]
#[unsafe(method(webView:didCommitLoadForFrame:))]
#[unsafe(method_family = none)]
unsafe fn webView_didCommitLoadForFrame(
&self,
sender: Option<&WebView>,
frame: Option<&WebFrame>,
);
#[cfg(all(feature = "WebFrame", feature = "WebView", feature = "objc2-app-kit"))]
#[cfg(target_os = "macos")]
/// Notifies the delegate that the page title for a frame has been received
///
/// Parameter `sender`: The WebView sending the message
///
/// Parameter `title`: The new page title
///
/// Parameter `frame`: The frame for which the title has been received
///
/// The title may update during loading; clients should be prepared for this.
#[deprecated]
#[optional]
#[unsafe(method(webView:didReceiveTitle:forFrame:))]
#[unsafe(method_family = none)]
unsafe fn webView_didReceiveTitle_forFrame(
&self,
sender: Option<&WebView>,
title: Option<&NSString>,
frame: Option<&WebFrame>,
);
#[cfg(all(feature = "WebFrame", feature = "WebView", feature = "objc2-app-kit"))]
#[cfg(target_os = "macos")]
/// Notifies the delegate that a page icon image for a frame has been received
///
/// Parameter `webView`: The WebView sending the message
///
/// Parameter `image`: The icon image. Also known as a "favicon".
///
/// Parameter `frame`: The frame for which a page icon has been received
#[deprecated]
#[optional]
#[unsafe(method(webView:didReceiveIcon:forFrame:))]
#[unsafe(method_family = none)]
unsafe fn webView_didReceiveIcon_forFrame(
&self,
sender: Option<&WebView>,
image: Option<&NSImage>,
frame: Option<&WebFrame>,
);
#[cfg(all(feature = "WebFrame", feature = "WebView", feature = "objc2-app-kit"))]
#[cfg(target_os = "macos")]
/// Notifies the delegate that the committed load of a frame has completed
///
/// Parameter `sender`: The WebView sending the message
///
/// Parameter `frame`: The frame that finished loading
///
/// This method is called after the committed data source of a frame has successfully loaded
/// and will only be called when all subresources such as images and stylesheets are done loading.
/// Plug-In content and JavaScript-requested loads may occur after this method is called.
#[deprecated]
#[optional]
#[unsafe(method(webView:didFinishLoadForFrame:))]
#[unsafe(method_family = none)]
unsafe fn webView_didFinishLoadForFrame(
&self,
sender: Option<&WebView>,
frame: Option<&WebFrame>,
);
#[cfg(all(feature = "WebFrame", feature = "WebView", feature = "objc2-app-kit"))]
#[cfg(target_os = "macos")]
/// Notifies the delegate that the committed load of a frame has failed
///
/// Parameter `sender`: The WebView sending the message
///
/// Parameter `error`: The error that occurred
///
/// Parameter `frame`: The frame that failed to load
///
/// This method is called after a data source has committed but failed to completely load.
#[deprecated]
#[optional]
#[unsafe(method(webView:didFailLoadWithError:forFrame:))]
#[unsafe(method_family = none)]
unsafe fn webView_didFailLoadWithError_forFrame(
&self,
sender: Option<&WebView>,
error: Option<&NSError>,
frame: Option<&WebFrame>,
);
#[cfg(all(feature = "WebFrame", feature = "WebView", feature = "objc2-app-kit"))]
#[cfg(target_os = "macos")]
/// Notifies the delegate that the scroll position in a frame has changed
///
/// Parameter `sender`: The WebView sending the message
///
/// Parameter `frame`: The frame that scrolled
///
/// This method is called when anchors within a page have been clicked.
#[deprecated]
#[optional]
#[unsafe(method(webView:didChangeLocationWithinPageForFrame:))]
#[unsafe(method_family = none)]
unsafe fn webView_didChangeLocationWithinPageForFrame(
&self,
sender: Option<&WebView>,
frame: Option<&WebFrame>,
);
#[cfg(all(feature = "WebFrame", feature = "WebView", feature = "objc2-app-kit"))]
#[cfg(target_os = "macos")]
/// Notifies the delegate that a frame will perform a client-side redirect
///
/// Parameter `sender`: The WebView sending the message
///
/// Parameter `URL`: The URL to be redirected to
///
/// Parameter `seconds`: Seconds in which the redirect will happen
///
/// Parameter `date`: The fire date
///
/// Parameter `frame`: The frame on which the redirect will occur
///
/// This method can be used to continue progress feedback while a client-side
/// redirect is pending.
#[deprecated]
#[optional]
#[unsafe(method(webView:willPerformClientRedirectToURL:delay:fireDate:forFrame:))]
#[unsafe(method_family = none)]
unsafe fn webView_willPerformClientRedirectToURL_delay_fireDate_forFrame(
&self,
sender: Option<&WebView>,
url: Option<&NSURL>,
seconds: NSTimeInterval,
date: Option<&NSDate>,
frame: Option<&WebFrame>,
);
#[cfg(all(feature = "WebFrame", feature = "WebView", feature = "objc2-app-kit"))]
#[cfg(target_os = "macos")]
/// Notifies the delegate that a pending client-side redirect has been cancelled
///
/// Parameter `sender`: The WebView sending the message
///
/// Parameter `frame`: The frame for which the pending redirect was cancelled
///
/// A client-side redirect can be cancelled if a frame changes location before the timeout.
#[deprecated]
#[optional]
#[unsafe(method(webView:didCancelClientRedirectForFrame:))]
#[unsafe(method_family = none)]
unsafe fn webView_didCancelClientRedirectForFrame(
&self,
sender: Option<&WebView>,
frame: Option<&WebFrame>,
);
#[cfg(all(feature = "WebFrame", feature = "WebView", feature = "objc2-app-kit"))]
#[cfg(target_os = "macos")]
/// Notifies the delegate that a frame will be closed
///
/// Parameter `sender`: The WebView sending the message
///
/// Parameter `frame`: The frame that will be closed
///
/// This method is called right before WebKit is done with the frame
/// and the objects that it contains.
#[deprecated]
#[optional]
#[unsafe(method(webView:willCloseFrame:))]
#[unsafe(method_family = none)]
unsafe fn webView_willCloseFrame(&self, sender: Option<&WebView>, frame: Option<&WebFrame>);
#[cfg(all(
feature = "WebFrame",
feature = "WebScriptObject",
feature = "WebView",
feature = "objc2-app-kit"
))]
#[cfg(target_os = "macos")]
/// Notifies the delegate that the JavaScript window object in a frame has
/// been cleared in preparation for a new load. This is the preferred place to set custom
/// properties on the window object using the WebScriptObject and JavaScriptCore APIs.
///
/// Parameter `webView`: The webView sending the message.
///
/// Parameter `windowObject`: The WebScriptObject representing the frame's JavaScript window object.
///
/// Parameter `frame`: The WebFrame to which windowObject belongs.
///
/// If a delegate implements both webView:didClearWindowObject:forFrame:
/// and webView:windowScriptObjectAvailable:, only webView:didClearWindowObject:forFrame:
/// will be invoked. This enables a delegate to implement both methods for backwards
/// compatibility with older versions of WebKit.
#[deprecated]
#[optional]
#[unsafe(method(webView:didClearWindowObject:forFrame:))]
#[unsafe(method_family = none)]
unsafe fn webView_didClearWindowObject_forFrame(
&self,
web_view: Option<&WebView>,
window_object: Option<&WebScriptObject>,
frame: Option<&WebFrame>,
);
#[cfg(all(
feature = "WebScriptObject",
feature = "WebView",
feature = "objc2-app-kit"
))]
#[cfg(target_os = "macos")]
/// Notifies the delegate that the scripting object for a page is available. This is called
/// before the page is loaded. It may be useful to allow delegates to bind native objects to the window.
///
/// Parameter `webView`: The webView sending the message.
///
/// Parameter `windowScriptObject`: The WebScriptObject for the window in the scripting environment.
///
/// This method is deprecated. Consider using webView:didClearWindowObject:forFrame:
/// instead.
#[deprecated]
#[optional]
#[unsafe(method(webView:windowScriptObjectAvailable:))]
#[unsafe(method_family = none)]
unsafe fn webView_windowScriptObjectAvailable(
&self,
web_view: Option<&WebView>,
window_script_object: Option<&WebScriptObject>,
);
}
);