dd6f87b162cc5c0779f9e125415ce549f333ab92
[WebKit-https.git] / Source / WebKit / UIProcess / API / Cocoa / WKWebView.h
1 /*
2  * Copyright (C) 2014 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 #import <WebKit/WKFoundation.h>
27
28 #if TARGET_OS_IPHONE
29 #import <UIKit/UIKit.h>
30 #else
31 #import <AppKit/AppKit.h>
32 #endif
33
34 NS_ASSUME_NONNULL_BEGIN
35
36 @class WKBackForwardList;
37 @class WKBackForwardListItem;
38 @class WKNavigation;
39 @class WKPDFConfiguration;
40 @class WKSnapshotConfiguration;
41 @class WKWebViewConfiguration;
42
43 @protocol WKNavigationDelegate;
44 @protocol WKUIDelegate;
45
46 /*!
47  A WKWebView object displays interactive Web content.
48  @helperclass @link WKWebViewConfiguration @/link
49  Used to configure @link WKWebView @/link instances.
50  */
51 #if TARGET_OS_IPHONE
52 WK_CLASS_AVAILABLE(macos(10.10), ios(8.0))
53 @interface WKWebView : UIView
54 #else
55 WK_CLASS_AVAILABLE(macos(10.10), ios(8.0))
56 @interface WKWebView : NSView
57 #endif
58
59 /*! @abstract A copy of the configuration with which the web view was
60  initialized. */
61 @property (nonatomic, readonly, copy) WKWebViewConfiguration *configuration;
62
63 /*! @abstract The web view's navigation delegate. */
64 @property (nullable, nonatomic, weak) id <WKNavigationDelegate> navigationDelegate;
65
66 /*! @abstract The web view's user interface delegate. */
67 @property (nullable, nonatomic, weak) id <WKUIDelegate> UIDelegate;
68
69 /*! @abstract The web view's back-forward list. */
70 @property (nonatomic, readonly, strong) WKBackForwardList *backForwardList;
71
72 /*! @abstract Returns a web view initialized with a specified frame and
73  configuration.
74  @param frame The frame for the new web view.
75  @param configuration The configuration for the new web view.
76  @result An initialized web view, or nil if the object could not be
77  initialized.
78  @discussion This is a designated initializer. You can use
79  @link -initWithFrame: @/link to initialize an instance with the default
80  configuration. The initializer copies the specified configuration, so
81  mutating the configuration after invoking the initializer has no effect
82  on the web view.
83  */
84 - (instancetype)initWithFrame:(CGRect)frame configuration:(WKWebViewConfiguration *)configuration NS_DESIGNATED_INITIALIZER;
85
86 - (nullable instancetype)initWithCoder:(NSCoder *)coder NS_DESIGNATED_INITIALIZER;
87
88 /*! @abstract Navigates to a requested URL.
89  @param request The request specifying the URL to which to navigate.
90  @result A new navigation for the given request.
91  */
92 - (nullable WKNavigation *)loadRequest:(NSURLRequest *)request;
93
94 /*! @abstract Navigates to the requested file URL on the filesystem.
95  @param URL The file URL to which to navigate.
96  @param readAccessURL The URL to allow read access to.
97  @discussion If readAccessURL references a single file, only that file may be loaded by WebKit.
98  If readAccessURL references a directory, files inside that file may be loaded by WebKit.
99  @result A new navigation for the given file URL.
100  */
101 - (nullable WKNavigation *)loadFileURL:(NSURL *)URL allowingReadAccessToURL:(NSURL *)readAccessURL WK_API_AVAILABLE(macos(10.11), ios(9.0));
102
103 /*! @abstract Sets the webpage contents and base URL.
104  @param string The string to use as the contents of the webpage.
105  @param baseURL A URL that is used to resolve relative URLs within the document.
106  @result A new navigation.
107  */
108 - (nullable WKNavigation *)loadHTMLString:(NSString *)string baseURL:(nullable NSURL *)baseURL;
109
110 /*! @abstract Sets the webpage contents and base URL.
111  @param data The data to use as the contents of the webpage.
112  @param MIMEType The MIME type of the data.
113  @param characterEncodingName The data's character encoding name.
114  @param baseURL A URL that is used to resolve relative URLs within the document.
115  @result A new navigation.
116  */
117 - (nullable WKNavigation *)loadData:(NSData *)data MIMEType:(NSString *)MIMEType characterEncodingName:(NSString *)characterEncodingName baseURL:(NSURL *)baseURL WK_API_AVAILABLE(macos(10.11), ios(9.0));
118
119 /*! @abstract Navigates to an item from the back-forward list and sets it
120  as the current item.
121  @param item The item to which to navigate. Must be one of the items in the
122  web view's back-forward list.
123  @result A new navigation to the requested item, or nil if it is already
124  the current item or is not part of the web view's back-forward list.
125  @seealso backForwardList
126  */
127 - (nullable WKNavigation *)goToBackForwardListItem:(WKBackForwardListItem *)item;
128
129 /*! @abstract The page title.
130  @discussion @link WKWebView @/link is key-value observing (KVO) compliant
131  for this property.
132  */
133 @property (nullable, nonatomic, readonly, copy) NSString *title;
134
135 /*! @abstract The active URL.
136  @discussion This is the URL that should be reflected in the user
137  interface.
138  @link WKWebView @/link is key-value observing (KVO) compliant for this
139  property.
140  */
141 @property (nullable, nonatomic, readonly, copy) NSURL *URL;
142
143 /*! @abstract A Boolean value indicating whether the view is currently
144  loading content.
145  @discussion @link WKWebView @/link is key-value observing (KVO) compliant
146  for this property.
147  */
148 @property (nonatomic, readonly, getter=isLoading) BOOL loading;
149
150 /*! @abstract An estimate of what fraction of the current navigation has been completed.
151  @discussion This value ranges from 0.0 to 1.0 based on the total number of
152  bytes expected to be received, including the main document and all of its
153  potential subresources. After a navigation completes, the value remains at 1.0
154  until a new navigation starts, at which point it is reset to 0.0.
155  @link WKWebView @/link is key-value observing (KVO) compliant for this
156  property.
157  */
158 @property (nonatomic, readonly) double estimatedProgress;
159
160 /*! @abstract A Boolean value indicating whether all resources on the page
161  have been loaded over securely encrypted connections.
162  @discussion @link WKWebView @/link is key-value observing (KVO) compliant
163  for this property.
164  */
165 @property (nonatomic, readonly) BOOL hasOnlySecureContent;
166
167 /*! @abstract A SecTrustRef for the currently committed navigation.
168  @discussion @link WKWebView @/link is key-value observing (KVO) compliant 
169  for this property.
170  */
171 @property (nonatomic, readonly, nullable) SecTrustRef serverTrust WK_API_AVAILABLE(macos(10.12), ios(10.0));
172
173 /*! @abstract A Boolean value indicating whether there is a back item in
174  the back-forward list that can be navigated to.
175  @discussion @link WKWebView @/link is key-value observing (KVO) compliant
176  for this property.
177  @seealso backForwardList.
178  */
179 @property (nonatomic, readonly) BOOL canGoBack;
180
181 /*! @abstract A Boolean value indicating whether there is a forward item in
182  the back-forward list that can be navigated to.
183  @discussion @link WKWebView @/link is key-value observing (KVO) compliant
184  for this property.
185  @seealso backForwardList.
186  */
187 @property (nonatomic, readonly) BOOL canGoForward;
188
189 /*! @abstract Navigates to the back item in the back-forward list.
190  @result A new navigation to the requested item, or nil if there is no back
191  item in the back-forward list.
192  */
193 - (nullable WKNavigation *)goBack;
194
195 /*! @abstract Navigates to the forward item in the back-forward list.
196  @result A new navigation to the requested item, or nil if there is no
197  forward item in the back-forward list.
198  */
199 - (nullable WKNavigation *)goForward;
200
201 /*! @abstract Reloads the current page.
202  @result A new navigation representing the reload.
203  */
204 - (nullable WKNavigation *)reload;
205
206 /*! @abstract Reloads the current page, performing end-to-end revalidation
207  using cache-validating conditionals if possible.
208  @result A new navigation representing the reload.
209  */
210 - (nullable WKNavigation *)reloadFromOrigin;
211
212 /*! @abstract Stops loading all resources on the current page.
213  */
214 - (void)stopLoading;
215
216 /* @abstract Evaluates the given JavaScript string.
217  @param javaScriptString The JavaScript string to evaluate.
218  @param completionHandler A block to invoke when script evaluation completes or fails.
219  @discussion The completionHandler is passed the result of the script evaluation or an error.
220 */
221 - (void)evaluateJavaScript:(NSString *)javaScriptString completionHandler:(void (^ _Nullable)(_Nullable id, NSError * _Nullable error))completionHandler;
222
223 /*! @abstract Get a snapshot for the visible viewport of WKWebView.
224  @param snapshotConfiguration An object that specifies how the snapshot is configured.
225  @param completionHandler A block to invoke when the snapshot is ready.
226  @discussion If the WKSnapshotConfiguration is nil, the method will snapshot the bounds of the 
227  WKWebView and create an image that is the width of the bounds of the WKWebView and scaled to the 
228  device scale. The completionHandler is passed the image of the viewport contents or an error.
229  */
230 #if TARGET_OS_IPHONE
231 - (void)takeSnapshotWithConfiguration:(nullable WKSnapshotConfiguration *)snapshotConfiguration completionHandler:(void (^)(UIImage * _Nullable snapshotImage, NSError * _Nullable error))completionHandler WK_API_AVAILABLE(ios(11.0));
232 #else
233 - (void)takeSnapshotWithConfiguration:(nullable WKSnapshotConfiguration *)snapshotConfiguration completionHandler:(void (^)(NSImage * _Nullable snapshotImage, NSError * _Nullable error))completionHandler WK_API_AVAILABLE(macos(10.13));
234 #endif
235
236 /*! @abstract Create a PDF document representation from the web page currently displayed in the WKWebView
237 @param pdfConfiguration An object that specifies how the PDF capture is configured.
238 @param completionHandler A block to invoke when the pdf document data is ready.
239 @discussion If the WKPDFConfiguration is nil, the method will create a PDF document representing the bounds of the currently displayed web page.
240 The completionHandler is passed the resulting PDF document data or an error.
241 The data can be used to create a PDFDocument object.
242 If the data is written to a file the resulting file is a valid PDF document.
243 */
244 - (void)createPDFWithConfiguration:(nullable WKPDFConfiguration *)pdfConfiguration completionHandler:(void (^)(NSData * _Nullable pdfDocumentData, NSError * _Nullable error))completionHandler NS_REFINED_FOR_SWIFT WK_API_AVAILABLE(macos(WK_MAC_TBA), ios(WK_IOS_TBA));
245
246 /* @abstract Create WebKit web archive data representing the current web content of the WKWebView
247 @param completionHandler A block to invoke when the web archive data is ready.
248 @discussion WebKit web archive data represents a snapshot of web content.
249 It can be used to represent web content on a pasteboard, loaded into a WKWebView directly, and saved to a file for later use.
250 The uniform type identifier kUTTypeWebArchive can be used get the related pasteboard type and MIME type.
251 */
252 - (void)createWebArchiveDataWithCompletionHandler:(void (^)(NSData *, NSError *))completionHandler NS_REFINED_FOR_SWIFT WK_API_AVAILABLE(macos(WK_MAC_TBA), ios(WK_IOS_TBA));
253
254 /*! @abstract A Boolean value indicating whether horizontal swipe gestures
255  will trigger back-forward list navigations.
256  @discussion The default value is NO.
257  */
258 @property (nonatomic) BOOL allowsBackForwardNavigationGestures;
259
260 /*! @abstract The custom user agent string or nil if no custom user agent string has been set.
261 */
262 @property (nullable, nonatomic, copy) NSString *customUserAgent WK_API_AVAILABLE(macos(10.11), ios(9.0));
263
264 /*! @abstract A Boolean value indicating whether link preview is allowed for any
265  links inside this WKWebView.
266  @discussion The default value is YES on Mac and iOS.
267  */
268 @property (nonatomic) BOOL allowsLinkPreview WK_API_AVAILABLE(macos(10.11), ios(9.0));
269
270 #if TARGET_OS_IPHONE
271 /*! @abstract The scroll view associated with the web view.
272  */
273 @property (nonatomic, readonly, strong) UIScrollView *scrollView;
274 #endif
275
276 #if !TARGET_OS_IPHONE
277 /* @abstract A Boolean value indicating whether magnify gestures will
278  change the web view's magnification.
279  @discussion It is possible to set the magnification property even if
280  allowsMagnification is set to NO.
281  The default value is NO.
282  */
283 @property (nonatomic) BOOL allowsMagnification;
284
285 /* @abstract The factor by which the viewport of the page is currently scaled.
286  @discussion The default value is 1.0.
287  */
288 @property (nonatomic) CGFloat magnification;
289
290 /* @abstract Scales the page content by a specified factor and centers the
291  result on a specified point.
292  * @param magnification The factor by which to scale the content.
293  * @param point The point (in view space) on which to center magnification.
294  */
295 - (void)setMagnification:(CGFloat)magnification centeredAtPoint:(CGPoint)point;
296
297 #endif
298
299 /* @abstract The factor by which page content is scaled relative to the viewport.
300 @discussion The default value is 1.0.
301  Changing this value is equivalent to web content setting the CSS "zoom"
302  property on all page content.
303 */
304 @property (nonatomic) CGFloat pageZoom WK_API_AVAILABLE(macos(WK_MAC_TBA), ios(WK_IOS_TBA));
305
306 /* @abstract Checks whether or not WKWebViews handle the given URL scheme by default.
307  @param scheme The URL scheme to check.
308  */
309 + (BOOL)handlesURLScheme:(NSString *)urlScheme WK_API_AVAILABLE(macos(10.13), ios(11.0));
310
311 #if !TARGET_OS_IPHONE
312 /* @abstract Returns an NSPrintOperation object configured to print the contents of this WKWebView
313 @param printInfo The print info object used to configure the resulting print operation.
314 */
315 - (NSPrintOperation *)printOperationWithPrintInfo:(NSPrintInfo *)printInfo WK_API_AVAILABLE(macos(WK_MAC_TBA));
316 #endif
317 @end
318
319 #if !TARGET_OS_IPHONE
320
321 @interface WKWebView (WKIBActions) <NSUserInterfaceValidations>
322
323 /*! @abstract Action method that navigates to the back item in the
324  back-forward list.
325  @param sender The object that sent this message.
326  */
327 - (IBAction)goBack:(nullable id)sender;
328
329 /*! @abstract Action method that navigates to the forward item in the
330  back-forward list.
331  @param sender The object that sent this message.
332  */
333 - (IBAction)goForward:(nullable id)sender;
334
335 /*! @abstract Action method that reloads the current page.
336  @param sender The object that sent this message.
337  */
338 - (IBAction)reload:(nullable id)sender;
339
340 /*! @abstract Action method that reloads the current page, performing
341  end-to-end revalidation using cache-validating conditionals if possible.
342  @param sender The object that sent this message.
343  */
344 - (IBAction)reloadFromOrigin:(nullable id)sender;
345
346 /*! @abstract Action method that stops loading all resources on the current
347  page.
348  @param sender The object that sent this message.
349  */
350 - (IBAction)stopLoading:(nullable id)sender;
351
352 @end
353
354 #endif
355
356 @interface WKWebView (WKDeprecated)
357
358 @property (nonatomic, readonly, copy) NSArray *certificateChain WK_API_DEPRECATED_WITH_REPLACEMENT("serverTrust", macos(10.11, 10.12), ios(9.0, 10.0));
359
360 @end
361
362 NS_ASSUME_NONNULL_END