ed6362d4680a6178580eb74f1cc1f315dfe6229d
[WebKit-https.git] / Source / WebKit / UIProcess / API / Cocoa / WKWebViewPrivate.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/WKWebView.h>
27
28 #import <WebKit/WKDataDetectorTypes.h>
29 #import <WebKit/_WKActivatedElementInfo.h>
30 #import <WebKit/_WKAttachment.h>
31 #import <WebKit/_WKFindOptions.h>
32 #import <WebKit/_WKLayoutMode.h>
33 #import <WebKit/_WKOverlayScrollbarStyle.h>
34 #import <WebKit/_WKRenderingProgressEvents.h>
35
36 typedef NS_ENUM(NSInteger, _WKPaginationMode) {
37     _WKPaginationModeUnpaginated,
38     _WKPaginationModeLeftToRight,
39     _WKPaginationModeRightToLeft,
40     _WKPaginationModeTopToBottom,
41     _WKPaginationModeBottomToTop,
42 } WK_API_AVAILABLE(macosx(10.10), ios(8.0));
43
44 typedef NS_OPTIONS(NSUInteger, _WKMediaCaptureState) {
45     _WKMediaCaptureStateNone = 0,
46     _WKMediaCaptureStateActiveMicrophone = 1 << 0,
47     _WKMediaCaptureStateActiveCamera = 1 << 1,
48     _WKMediaCaptureStateMutedMicrophone = 1 << 2,
49     _WKMediaCaptureStateMutedCamera = 1 << 3,
50 } WK_API_AVAILABLE(macosx(10.13), ios(11.0));
51
52 typedef NS_OPTIONS(NSUInteger, _WKMediaMutedState) {
53     _WKMediaNoneMuted = 0,
54     _WKMediaAudioMuted = 1 << 0,
55     _WKMediaCaptureDevicesMuted = 1 << 1,
56 } WK_API_AVAILABLE(macosx(10.13), ios(11.0));
57
58 typedef NS_OPTIONS(NSUInteger, _WKCaptureDevices) {
59     _WKCaptureDeviceMicrophone = 1 << 0,
60     _WKCaptureDeviceCamera = 1 << 1,
61     _WKCaptureDeviceDisplay = 1 << 2,
62 } WK_API_AVAILABLE(macosx(10.13), ios(11.0));
63
64 typedef NS_OPTIONS(NSUInteger, _WKSelectionAttributes) {
65     _WKSelectionAttributeNoSelection = 0,
66     _WKSelectionAttributeIsCaret = 1 << 0,
67     _WKSelectionAttributeIsRange = 1 << 1,
68     _WKSelectionAttributeAtStartOfSentence = 1 << 2,
69 } WK_API_AVAILABLE(macosx(WK_MAC_TBA), ios(WK_IOS_TBA));
70
71 #if TARGET_OS_IPHONE
72
73 typedef NS_ENUM(NSUInteger, _WKDragInteractionPolicy) {
74     _WKDragInteractionPolicyDefault = 0,
75     _WKDragInteractionPolicyAlwaysEnable,
76     _WKDragInteractionPolicyAlwaysDisable
77 } WK_API_AVAILABLE(ios(11.0));
78
79 #else
80 #import <WebKit/WKBase.h>
81 #endif
82
83 #if !TARGET_OS_IPHONE
84
85 typedef NS_ENUM(NSInteger, _WKImmediateActionType) {
86     _WKImmediateActionNone,
87     _WKImmediateActionLinkPreview,
88     _WKImmediateActionDataDetectedItem,
89     _WKImmediateActionLookupText,
90     _WKImmediateActionMailtoLink,
91     _WKImmediateActionTelLink
92 } WK_API_AVAILABLE(macosx(10.12));
93
94 typedef NS_OPTIONS(NSUInteger, _WKRectEdge) {
95     _WKRectEdgeNone = 0,
96     _WKRectEdgeLeft = 1 << CGRectMinXEdge,
97     _WKRectEdgeTop = 1 << CGRectMinYEdge,
98     _WKRectEdgeRight = 1 << CGRectMaxXEdge,
99     _WKRectEdgeBottom = 1 << CGRectMaxYEdge,
100     _WKRectEdgeAll = _WKRectEdgeLeft | _WKRectEdgeTop | _WKRectEdgeRight | _WKRectEdgeBottom,
101 } WK_API_AVAILABLE(macosx(10.13.4));
102
103 #endif
104
105 @class WKBrowsingContextHandle;
106 @class _WKApplicationManifest;
107 @class _WKFrameHandle;
108 @class _WKHitTestResult;
109 @class _WKIconLoadingDelegate;
110 @class _WKInspector;
111 @class _WKRemoteObjectRegistry;
112 @class _WKSafeBrowsingWarning;
113 @class _WKSessionState;
114 @class _WKThumbnailView;
115 @class _WKWebsitePolicies;
116 @class _WKWebViewPrintFormatter;
117
118 @protocol WKHistoryDelegatePrivate;
119 @protocol _WKDiagnosticLoggingDelegate;
120 @protocol _WKFindDelegate;
121 @protocol _WKIconLoadingDelegate;
122 @protocol _WKInputDelegate;
123 @protocol _WKFullscreenDelegate;
124
125 @interface WKWebView (WKPrivate)
126
127 // FIXME: This should return a _WKRemoteObjectRegistry *.
128 @property (nonatomic, readonly) id _remoteObjectRegistry;
129 @property (nonatomic, readonly) WKBrowsingContextHandle *_handle;
130
131 @property (nonatomic, setter=_setObservedRenderingProgressEvents:) _WKRenderingProgressEvents _observedRenderingProgressEvents;
132
133 @property (nonatomic, weak, setter=_setHistoryDelegate:) id <WKHistoryDelegatePrivate> _historyDelegate;
134 @property (nonatomic, weak, setter=_setIconLoadingDelegate:) id <_WKIconLoadingDelegate> _iconLoadingDelegate;
135
136 @property (nonatomic, readonly) NSURL *_unreachableURL;
137
138 - (void)_loadAlternateHTMLString:(NSString *)string baseURL:(NSURL *)baseURL forUnreachableURL:(NSURL *)unreachableURL;
139 - (WKNavigation *)_loadData:(NSData *)data MIMEType:(NSString *)MIMEType characterEncodingName:(NSString *)characterEncodingName baseURL:(NSURL *)baseURL userData:(id)userData WK_API_AVAILABLE(macosx(10.12), ios(10.0));
140 - (WKNavigation *)_loadRequest:(NSURLRequest *)request shouldOpenExternalURLs:(BOOL)shouldOpenExternalURLs WK_API_AVAILABLE(macosx(10.13), ios(11.0));
141
142 @property (nonatomic, readonly) NSArray *_certificateChain WK_API_DEPRECATED_WITH_REPLACEMENT("certificateChain", macosx(10.10, 10.11), ios(8.0, 9.0));
143 @property (nonatomic, readonly) NSURL *_committedURL;
144 @property (nonatomic, readonly) NSString *_MIMEType;
145 @property (nonatomic, readonly) NSString *_userAgent WK_API_AVAILABLE(macosx(10.11), ios(9.0));
146
147 @property (nonatomic, readonly, getter=_isPlayingAudio) BOOL _playingAudio WK_API_AVAILABLE(macosx(10.13.4), ios(11.3));
148
149 @property (copy, setter=_setApplicationNameForUserAgent:) NSString *_applicationNameForUserAgent;
150 @property (copy, setter=_setCustomUserAgent:) NSString *_customUserAgent;
151
152 @property (nonatomic, setter=_setUserContentExtensionsEnabled:) BOOL _userContentExtensionsEnabled WK_API_AVAILABLE(macosx(10.11), ios(9.0));
153
154 @property (nonatomic, readonly) pid_t _webProcessIdentifier;
155 @property (nonatomic, readonly) pid_t _provisionalWebProcessIdentifier WK_API_AVAILABLE(macosx(WK_MAC_TBA), ios(WK_IOS_TBA));
156
157 @property (nonatomic, getter=_isEditable, setter=_setEditable:) BOOL _editable WK_API_AVAILABLE(macosx(10.11), ios(9.0));
158
159 // FIXME: Remove these once nobody is using them.
160 @property (nonatomic, readonly) NSData *_sessionStateData;
161 - (void)_restoreFromSessionStateData:(NSData *)sessionStateData;
162
163 @property (nonatomic, readonly) _WKSessionState *_sessionState;
164 - (WKNavigation *)_restoreSessionState:(_WKSessionState *)sessionState andNavigate:(BOOL)navigate;
165 - (_WKSessionState *)_sessionStateWithFilter:(BOOL (^)(WKBackForwardListItem *item))filter;
166
167 @property (nonatomic, setter=_setAllowsRemoteInspection:) BOOL _allowsRemoteInspection;
168 @property (nonatomic, copy, setter=_setRemoteInspectionNameOverride:) NSString *_remoteInspectionNameOverride WK_API_AVAILABLE(macosx(10.12), ios(10.0));
169
170 @property (nonatomic, setter=_setAddsVisitedLinks:) BOOL _addsVisitedLinks;
171
172 @property (nonatomic, readonly) BOOL _networkRequestsInProgress;
173
174 @property (nonatomic, readonly, getter=_isShowingNavigationGestureSnapshot) BOOL _showingNavigationGestureSnapshot;
175
176 - (void)_close;
177
178 - (void)_updateWebsitePolicies:(_WKWebsitePolicies *)websitePolicies WK_API_AVAILABLE(macosx(10.13), ios(11.0));
179
180 - (void)_evaluateJavaScriptWithoutUserGesture:(NSString *)javaScriptString completionHandler:(void (^)(id, NSError *))completionHandler WK_API_AVAILABLE(macosx(10.13), ios(11.0));
181
182 @property (nonatomic, setter=_setLayoutMode:) _WKLayoutMode _layoutMode;
183 // For use with _layoutMode = _WKLayoutModeFixedSize:
184 @property (nonatomic, setter=_setFixedLayoutSize:) CGSize _fixedLayoutSize;
185
186 @property (nonatomic, setter=_setViewportSizeForCSSViewportUnits:) CGSize _viewportSizeForCSSViewportUnits WK_API_AVAILABLE(macosx(10.13), ios(11.0));
187
188 @property (nonatomic, setter=_setViewScale:) CGFloat _viewScale WK_API_AVAILABLE(macosx(10.11), ios(9.0));
189
190 @property (nonatomic, setter=_setMinimumEffectiveDeviceWidth:) CGFloat _minimumEffectiveDeviceWidth WK_API_AVAILABLE(macosx(WK_MAC_TBA), ios(WK_IOS_TBA));
191
192 @property (nonatomic, setter=_setBackgroundExtendsBeyondPage:) BOOL _backgroundExtendsBeyondPage WK_API_AVAILABLE(macosx(10.13.4), ios(8.0));
193
194 - (_WKAttachment *)_insertAttachmentWithFilename:(NSString *)filename contentType:(NSString *)contentType data:(NSData *)data options:(_WKAttachmentDisplayOptions *)options completion:(void(^)(BOOL success))completionHandler WK_API_DEPRECATED_WITH_REPLACEMENT("-_insertAttachmentWithFileWrapper:contentType:options:completion:", macosx(10.13.4, WK_MAC_TBA), ios(11.3, WK_IOS_TBA));
195 - (_WKAttachment *)_insertAttachmentWithFileWrapper:(NSFileWrapper *)fileWrapper contentType:(NSString *)contentType options:(_WKAttachmentDisplayOptions *)options completion:(void(^)(BOOL success))completionHandler WK_API_DEPRECATED_WITH_REPLACEMENT("-_insertAttachmentWithFileWrapper:contentType:completion:", macosx(WK_MAC_TBA, WK_MAC_TBA), ios(WK_IOS_TBA, WK_IOS_TBA));
196 - (_WKAttachment *)_insertAttachmentWithFileWrapper:(NSFileWrapper *)fileWrapper contentType:(NSString *)contentType completion:(void(^)(BOOL success))completionHandler WK_API_AVAILABLE(macosx(WK_MAC_TBA), ios(WK_IOS_TBA));
197 - (_WKAttachment *)_attachmentForIdentifier:(NSString *)identifier WK_API_AVAILABLE(macosx(WK_MAC_TBA), ios(WK_IOS_TBA));
198
199 - (void)_simulateDeviceOrientationChangeWithAlpha:(double)alpha beta:(double)beta gamma:(double)gamma WK_API_AVAILABLE(macosx(WK_MAC_TBA), ios(WK_IOS_TBA));
200
201 + (BOOL)_handlesSafeBrowsing WK_API_AVAILABLE(macosx(WK_MAC_TBA), ios(WK_IOS_TBA));
202 + (NSURL *)_confirmMalwareSentinel WK_API_AVAILABLE(macosx(WK_MAC_TBA), ios(WK_IOS_TBA));
203 + (NSURL *)_visitUnsafeWebsiteSentinel WK_API_AVAILABLE(macosx(WK_MAC_TBA), ios(WK_IOS_TBA));
204 - (void)_showSafeBrowsingWarningWithTitle:(NSString *)title warning:(NSString *)warning details:(NSAttributedString *)details completionHandler:(void(^)(BOOL))completionHandler WK_API_AVAILABLE(macosx(WK_MAC_TBA), ios(WK_IOS_TBA));
205 - (void)_showSafeBrowsingWarningWithURL:(NSURL *)url title:(NSString *)title warning:(NSString *)warning details:(NSAttributedString *)details completionHandler:(void(^)(BOOL))completionHandler WK_API_AVAILABLE(macosx(WK_MAC_TBA), ios(WK_IOS_TBA));
206
207 - (void)_isJITEnabled:(void(^)(BOOL))completionHandler WK_API_AVAILABLE(macosx(WK_MAC_TBA), ios(WK_IOS_TBA));
208 - (void)_removeDataDetectedLinks:(dispatch_block_t)completion WK_API_AVAILABLE(macosx(WK_MAC_TBA), ios(WK_IOS_TBA));
209
210 - (IBAction)_alignCenter:(id)sender WK_API_AVAILABLE(macosx(WK_MAC_TBA), ios(WK_IOS_TBA));
211 - (IBAction)_alignJustified:(id)sender WK_API_AVAILABLE(macosx(WK_MAC_TBA), ios(WK_IOS_TBA));
212 - (IBAction)_alignLeft:(id)sender WK_API_AVAILABLE(macosx(WK_MAC_TBA), ios(WK_IOS_TBA));
213 - (IBAction)_alignRight:(id)sender WK_API_AVAILABLE(macosx(WK_MAC_TBA), ios(WK_IOS_TBA));
214 - (IBAction)_indent:(id)sender WK_API_AVAILABLE(macosx(WK_MAC_TBA), ios(WK_IOS_TBA));
215 - (IBAction)_outdent:(id)sender WK_API_AVAILABLE(macosx(WK_MAC_TBA), ios(WK_IOS_TBA));
216 - (IBAction)_toggleStrikeThrough:(id)sender WK_API_AVAILABLE(macosx(WK_MAC_TBA), ios(WK_IOS_TBA));
217 - (IBAction)_insertOrderedList:(id)sender WK_API_AVAILABLE(macosx(WK_MAC_TBA), ios(WK_IOS_TBA));
218 - (IBAction)_insertUnorderedList:(id)sender WK_API_AVAILABLE(macosx(WK_MAC_TBA), ios(WK_IOS_TBA));
219 - (IBAction)_insertNestedOrderedList:(id)sender WK_API_AVAILABLE(macosx(WK_MAC_TBA), ios(WK_IOS_TBA));
220 - (IBAction)_insertNestedUnorderedList:(id)sender WK_API_AVAILABLE(macosx(WK_MAC_TBA), ios(WK_IOS_TBA));
221 - (IBAction)_increaseListLevel:(id)sender WK_API_AVAILABLE(macosx(WK_MAC_TBA), ios(WK_IOS_TBA));
222 - (IBAction)_decreaseListLevel:(id)sender WK_API_AVAILABLE(macosx(WK_MAC_TBA), ios(WK_IOS_TBA));
223 - (IBAction)_changeListType:(id)sender WK_API_AVAILABLE(macosx(WK_MAC_TBA), ios(WK_IOS_TBA));
224 - (IBAction)_pasteAsQuotation:(id)sender WK_API_AVAILABLE(macosx(WK_MAC_TBA), ios(WK_IOS_TBA));
225 - (IBAction)_pasteAndMatchStyle:(id)sender WK_API_AVAILABLE(macosx(WK_MAC_TBA), ios(WK_IOS_TBA));
226 - (IBAction)_takeFindStringFromSelection:(id)sender WK_API_AVAILABLE(macosx(WK_MAC_TBA), ios(WK_IOS_TBA));
227
228 @property (class, nonatomic, copy, setter=_setStringForFind:) NSString *_stringForFind WK_API_AVAILABLE(macosx(WK_MAC_TBA), ios(WK_IOS_TBA));
229 @property (nonatomic, readonly) _WKSelectionAttributes _selectionAttributes WK_API_AVAILABLE(macosx(WK_MAC_TBA), ios(WK_IOS_TBA));
230
231 #if TARGET_OS_IPHONE
232
233 - (void)_setFont:(UIFont *)font sender:(id)sender WK_API_AVAILABLE(ios(WK_IOS_TBA));
234 - (void)_setFontSize:(CGFloat)fontSize sender:(id)sender WK_API_AVAILABLE(ios(WK_IOS_TBA));
235 - (void)_setTextColor:(UIColor *)color sender:(id)sender WK_API_AVAILABLE(ios(WK_IOS_TBA));
236
237 - (void)_detectDataWithTypes:(WKDataDetectorTypes)types completionHandler:(dispatch_block_t)completion WK_API_AVAILABLE(ios(WK_IOS_TBA));
238
239 // DERECATED: The setters of the three following function are deprecated, please use overrideLayoutParameters.
240 // Define the smallest size a page take with a regular viewport.
241 @property (nonatomic, readonly) CGSize _minimumLayoutSizeOverride;
242 // Define the largest size the unobscured area can get for the current view bounds. This value is used to define viewport units.
243 @property (nonatomic, readonly) CGSize _maximumUnobscuredSizeOverride;
244
245 // Define the inset of the scrollview unusable by the web page.
246 @property (nonatomic, setter=_setObscuredInsets:) UIEdgeInsets _obscuredInsets;
247
248 @property (nonatomic, setter=_setUnobscuredSafeAreaInsets:) UIEdgeInsets _unobscuredSafeAreaInsets WK_API_AVAILABLE(ios(11.0));
249 @property (nonatomic, readonly) BOOL _safeAreaShouldAffectObscuredInsets WK_API_AVAILABLE(ios(11.0));
250 @property (nonatomic, setter=_setObscuredInsetEdgesAffectedBySafeArea:) UIRectEdge _obscuredInsetEdgesAffectedBySafeArea WK_API_AVAILABLE(ios(11.0));
251
252 // An ancestor view whose bounds will be intersected with those of this WKWebView to determine the visible region of content to render.
253 @property (nonatomic, readonly) UIView *_enclosingViewForExposedRectComputation WK_API_AVAILABLE(ios(11.0));
254
255 // Override the interface orientation. Clients using _beginAnimatedResizeWithUpdates: must update the interface orientation
256 // in the update block.
257 @property (nonatomic, setter=_setInterfaceOrientationOverride:) UIInterfaceOrientation _interfaceOrientationOverride;
258
259 @property (nonatomic, setter=_setAllowsViewportShrinkToFit:) BOOL _allowsViewportShrinkToFit;
260
261 // FIXME: Remove these three properties once we expose WKWebViewContentProvider as API.
262 @property (nonatomic, readonly, getter=_isDisplayingPDF) BOOL _displayingPDF;
263 @property (nonatomic, readonly) NSData *_dataForDisplayedPDF;
264 // FIXME: This can be removed once WKNavigation's response property is implemented.
265 @property (nonatomic, readonly) NSString *_suggestedFilenameForDisplayedPDF;
266
267 @property (nonatomic, readonly) _WKWebViewPrintFormatter *_webViewPrintFormatter;
268
269 @property (nonatomic, setter=_setDragInteractionPolicy:) _WKDragInteractionPolicy _dragInteractionPolicy WK_API_AVAILABLE(ios(11.0));
270
271 - (void)_beginInteractiveObscuredInsetsChange;
272 - (void)_endInteractiveObscuredInsetsChange;
273 - (void)_hideContentUntilNextUpdate;
274
275 - (void)_beginAnimatedResizeWithUpdates:(void (^)(void))updateBlock;
276 - (void)_endAnimatedResize;
277 - (void)_resizeWhileHidingContentWithUpdates:(void (^)(void))updateBlock;
278
279 - (void)_snapshotRect:(CGRect)rectInViewCoordinates intoImageOfWidth:(CGFloat)imageWidth completionHandler:(void(^)(CGImageRef))completionHandler;
280
281 - (void)_overrideLayoutParametersWithMinimumLayoutSize:(CGSize)minimumLayoutSize maximumUnobscuredSizeOverride:(CGSize)maximumUnobscuredSizeOverride WK_API_AVAILABLE(ios(9_0));
282
283 - (void)_clearOverrideLayoutParameters WK_API_AVAILABLE(ios(11.0));
284 - (void)_clearInterfaceOrientationOverride WK_API_AVAILABLE(ios(11.0));
285
286 - (UIView *)_viewForFindUI;
287
288 - (void)_setOverlaidAccessoryViewsInset:(CGSize)inset;
289
290 // Puts the view into a state where being taken out of the view hierarchy and resigning first responder
291 // will not count as becoming inactive and unfocused. The returned block must be called to exit the state.
292 - (void (^)(void))_retainActiveFocusedState WK_API_AVAILABLE(ios(9_0));
293
294 - (void)_becomeFirstResponderWithSelectionMovingForward:(BOOL)selectingForward completionHandler:(void (^)(BOOL didBecomeFirstResponder))completionHandler WK_API_AVAILABLE(ios(9_0));
295
296 - (id)_snapshotLayerContentsForBackForwardListItem:(WKBackForwardListItem *)item WK_API_AVAILABLE(ios(9_0));
297 - (NSArray *)_dataDetectionResults;
298
299 - (void)_accessibilityRetrieveSpeakSelectionContent WK_API_AVAILABLE(ios(11.0));
300 - (void)_accessibilityDidGetSpeakSelectionContent:(NSString *)content WK_API_AVAILABLE(ios(11.0));
301
302 @property (nonatomic, readonly) UIView *_safeBrowsingWarning WK_API_AVAILABLE(macosx(WK_MAC_TBA), ios(WK_IOS_TBA));
303 #else
304 @property (nonatomic, readonly) NSView *_safeBrowsingWarning WK_API_AVAILABLE(macosx(WK_MAC_TBA), ios(WK_IOS_TBA));
305
306 @property (nonatomic, readonly) _WKRectEdge _pinnedState WK_API_AVAILABLE(macosx(10.13.4));
307 @property (nonatomic, setter=_setRubberBandingEnabled:) _WKRectEdge _rubberBandingEnabled WK_API_AVAILABLE(macosx(10.13.4));
308
309 @property (readonly) NSColor *_pageExtendedBackgroundColor;
310 @property (nonatomic, setter=_setBackgroundColor:) NSColor *_backgroundColor WK_API_AVAILABLE(macosx(10.14));
311 @property (nonatomic, setter=_setDrawsBackground:) BOOL _drawsBackground;
312 @property (nonatomic, setter=_setTopContentInset:) CGFloat _topContentInset;
313
314 @property (nonatomic, setter=_setAutomaticallyAdjustsContentInsets:) BOOL _automaticallyAdjustsContentInsets;
315
316 // Default value is 0. A value of 0 means the window's backing scale factor will be used and automatically update when the window moves screens.
317 @property (nonatomic, setter=_setOverrideDeviceScaleFactor:) CGFloat _overrideDeviceScaleFactor WK_API_AVAILABLE(macosx(10.11));
318
319 @property (nonatomic, setter=_setWindowOcclusionDetectionEnabled:) BOOL _windowOcclusionDetectionEnabled;
320
321 @property (nonatomic, readonly) NSInteger _spellCheckerDocumentTag WK_API_AVAILABLE(macosx(10.14));
322
323 - (void)_setShouldSuppressFirstResponderChanges:(BOOL)shouldSuppress;
324
325 // Clients that want to maintain default behavior can return nil. To disable the immediate action entirely, return NSNull. And to
326 // do something custom, return an object that conforms to the NSImmediateActionAnimationController protocol.
327 - (id)_immediateActionAnimationControllerForHitTestResult:(_WKHitTestResult *)hitTestResult withType:(_WKImmediateActionType)type userData:(id<NSSecureCoding>)userData;
328
329 @property (nonatomic, setter=_setMinimumLayoutWidth:) CGFloat _minimumLayoutWidth WK_API_AVAILABLE(macosx(10.12));
330
331 // When using _minimumLayoutWidth, the web content will lay out to the intrinsic height
332 // of the content; use this property to force it to lay out to the height of the view instead.
333 @property (nonatomic, setter=_setShouldExpandContentToViewHeightForAutoLayout:) BOOL _shouldExpandContentToViewHeightForAutoLayout WK_API_AVAILABLE(macosx(10.12));
334
335 @property (nonatomic, setter=_setAlwaysShowsHorizontalScroller:) BOOL _alwaysShowsHorizontalScroller WK_API_AVAILABLE(macosx(10.13.4));
336 @property (nonatomic, setter=_setAlwaysShowsVerticalScroller:) BOOL _alwaysShowsVerticalScroller WK_API_AVAILABLE(macosx(10.13.4));
337
338 - (NSPrintOperation *)_printOperationWithPrintInfo:(NSPrintInfo *)printInfo;
339 - (NSPrintOperation *)_printOperationWithPrintInfo:(NSPrintInfo *)printInfo forFrame:(_WKFrameHandle *)frameHandle WK_API_AVAILABLE(macosx(10.12), ios(10.0));
340
341 // FIXME: This SPI should become a part of the WKUIDelegate. rdar://problem/26561537
342 @property (nonatomic, readwrite, setter=_setWantsMediaPlaybackControlsView:) BOOL _wantsMediaPlaybackControlsView WK_API_AVAILABLE(macosx(10.12.3));
343 @property (nonatomic, readonly) id _mediaPlaybackControlsView WK_API_AVAILABLE(macosx(10.13));
344 - (void)_addMediaPlaybackControlsView:(id)mediaPlaybackControlsView WK_API_AVAILABLE(macosx(10.13));
345 - (void)_removeMediaPlaybackControlsView WK_API_AVAILABLE(macosx(10.12.3));
346
347 - (void)_prepareForMoveToWindow:(NSWindow *)targetWindow completionHandler:(void(^)(void))completionHandler WK_API_AVAILABLE(macosx(10.13));
348
349 @property (nonatomic, setter=_setOverlayScrollbarStyle:) _WKOverlayScrollbarStyle _overlayScrollbarStyle WK_API_AVAILABLE(macosx(10.13.4));
350 @property (strong, nonatomic, setter=_setInspectorAttachmentView:) NSView *_inspectorAttachmentView WK_API_AVAILABLE(macosx(10.13.4));
351
352 @property (nonatomic, setter=_setThumbnailView:) _WKThumbnailView *_thumbnailView WK_API_AVAILABLE(macosx(10.13.4));
353 @property (nonatomic, setter=_setIgnoresAllEvents:) BOOL _ignoresAllEvents WK_API_AVAILABLE(macosx(10.13.4));
354
355 #endif
356
357 - (WKNavigation *)_reloadWithoutContentBlockers WK_API_AVAILABLE(macosx(10.12), ios(10.0));
358 - (WKNavigation *)_reloadExpiredOnly WK_API_AVAILABLE(macosx(10.13), ios(11.0));
359
360 - (void)_killWebContentProcess;
361 - (void)_killWebContentProcessAndResetState;
362
363 - (void)_getMainResourceDataWithCompletionHandler:(void (^)(NSData *, NSError *))completionHandler;
364 - (void)_getWebArchiveDataWithCompletionHandler:(void (^)(NSData *, NSError *))completionHandler;
365 - (void)_getContentsAsStringWithCompletionHandler:(void (^)(NSString *, NSError *))completionHandler WK_API_AVAILABLE(macosx(10.13), ios(11.0));
366
367 - (void)_getApplicationManifestWithCompletionHandler:(void (^)(_WKApplicationManifest *))completionHandler WK_API_AVAILABLE(macosx(10.13.4), ios(11.3));
368
369 @property (nonatomic, setter=_setPaginationMode:) _WKPaginationMode _paginationMode;
370 // Whether the column-break-{before,after} properties are respected instead of the
371 // page-break-{before,after} properties.
372 @property (nonatomic, setter=_setPaginationBehavesLikeColumns:) BOOL _paginationBehavesLikeColumns;
373 // Set to 0 to have the page length equal the view length.
374 @property (nonatomic, setter=_setPageLength:) CGFloat _pageLength;
375 @property (nonatomic, setter=_setGapBetweenPages:) CGFloat _gapBetweenPages;
376 @property (nonatomic, setter=_setPaginationLineGridEnabled:) BOOL _paginationLineGridEnabled;
377 @property (readonly) NSUInteger _pageCount;
378
379 @property (nonatomic, readonly) BOOL _supportsTextZoom;
380 @property (nonatomic, setter=_setTextZoomFactor:) double _textZoomFactor;
381 @property (nonatomic, setter=_setPageZoomFactor:) double _pageZoomFactor;
382
383 @property (nonatomic, weak, setter=_setDiagnosticLoggingDelegate:) id <_WKDiagnosticLoggingDelegate> _diagnosticLoggingDelegate WK_API_AVAILABLE(macosx(10.11), ios(9.0));
384 @property (nonatomic, weak, setter=_setFindDelegate:) id <_WKFindDelegate> _findDelegate;
385 - (void)_findString:(NSString *)string options:(_WKFindOptions)options maxCount:(NSUInteger)maxCount;
386 - (void)_countStringMatches:(NSString *)string options:(_WKFindOptions)options maxCount:(NSUInteger)maxCount;
387 - (void)_hideFindUI;
388
389 @property (nonatomic, weak, setter=_setInputDelegate:) id <_WKInputDelegate> _inputDelegate WK_API_AVAILABLE(macosx(10.12), ios(10.0));
390
391 @property (nonatomic, readonly, getter=_isDisplayingStandaloneImageDocument) BOOL _displayingStandaloneImageDocument;
392 @property (nonatomic, readonly, getter=_isDisplayingStandaloneMediaDocument) BOOL _displayingStandaloneMediaDocument;
393
394 @property (nonatomic, setter=_setScrollPerformanceDataCollectionEnabled:) BOOL _scrollPerformanceDataCollectionEnabled WK_API_AVAILABLE(macosx(10.11), ios(9.0));
395 @property (nonatomic, readonly) NSArray *_scrollPerformanceData WK_API_AVAILABLE(macosx(10.11), ios(9.0));
396
397 - (void)_saveBackForwardSnapshotForItem:(WKBackForwardListItem *)item WK_API_AVAILABLE(macosx(10.11), ios(9.0));
398
399 @property (nonatomic, getter=_allowsMediaDocumentInlinePlayback, setter=_setAllowsMediaDocumentInlinePlayback:) BOOL _allowsMediaDocumentInlinePlayback;
400
401 @property (nonatomic, readonly) BOOL _webProcessIsResponsive WK_API_AVAILABLE(macosx(10.12), ios(10.0));
402
403 @property (nonatomic, setter=_setFullscreenDelegate:) id<_WKFullscreenDelegate> _fullscreenDelegate WK_API_AVAILABLE(macosx(10.13), ios(11.0));
404 @property (nonatomic, readonly) BOOL _isInFullscreen WK_API_AVAILABLE(macosx(10.12.3));
405
406 @property (nonatomic, readonly) _WKMediaCaptureState _mediaCaptureState WK_API_AVAILABLE(macosx(WK_MAC_TBA), ios(WK_IOS_TBA));
407
408 - (void)_setMediaCaptureMuted:(BOOL)muted WK_API_AVAILABLE(macosx(WK_MAC_TBA), ios(WK_IOS_TBA));
409 - (void)_muteMediaCapture WK_API_AVAILABLE(macosx(10.13), ios(11.0));
410 - (void)_setPageMuted:(_WKMediaMutedState)mutedState WK_API_AVAILABLE(macosx(10.13), ios(11.0));
411
412 @property (nonatomic, setter=_setMediaCaptureEnabled:) BOOL _mediaCaptureEnabled WK_API_AVAILABLE(macosx(10.13), ios(11.0));
413
414 @property (nonatomic, readonly) BOOL _canTogglePictureInPicture;
415 @property (nonatomic, readonly) BOOL _isPictureInPictureActive;
416 - (void)_updateMediaPlaybackControlsManager;
417 - (void)_togglePictureInPicture;
418 - (void)_stopAllMediaPlayback;
419 - (void)_suspendAllMediaPlayback;
420 - (void)_resumeAllMediaPlayback;
421 @end
422
423 #if TARGET_OS_IPHONE
424
425 @interface WKWebView () <UIResponderStandardEditActions>
426 @end
427
428 #else
429
430 @interface WKWebView (WKNSTextFinderClient) <NSTextFinderClient>
431 @end
432
433 #endif
434
435 @interface WKWebView (WKTesting)
436
437 - (NSDictionary *)_contentsOfUserInterfaceItem:(NSString *)userInterfaceItem WK_API_AVAILABLE(macosx(10.12.3), ios(10.3));
438
439 #if TARGET_OS_IPHONE
440
441 @property (nonatomic, readonly) CGRect _contentVisibleRect WK_API_AVAILABLE(ios(10.0));
442 - (CGPoint)_convertPointFromContentsToView:(CGPoint)point WK_API_AVAILABLE(ios(10.0));
443 - (CGPoint)_convertPointFromViewToContents:(CGPoint)point WK_API_AVAILABLE(ios(10.0));
444
445 - (void)keyboardAccessoryBarNext WK_API_AVAILABLE(ios(10.0));
446 - (void)keyboardAccessoryBarPrevious WK_API_AVAILABLE(ios(10.0));
447 - (void)dismissFormAccessoryView WK_API_AVAILABLE(ios(10.3));
448 - (void)selectFormAccessoryPickerRow:(int)rowIndex WK_API_AVAILABLE(ios(10.3));
449 @property (nonatomic, readonly) NSString *textContentTypeForTesting WK_API_AVAILABLE(ios(12.0));
450 @property (nonatomic, readonly) NSString *selectFormPopoverTitle WK_API_AVAILABLE(ios(12.0));
451 @property (nonatomic, readonly) NSString *formInputLabel WK_API_AVAILABLE(ios(12.0));
452 - (void)setTimePickerValueToHour:(NSInteger)hour minute:(NSInteger)minute WK_API_AVAILABLE(ios(12.0));
453
454 - (void)applyAutocorrection:(NSString *)newString toString:(NSString *)oldString withCompletionHandler:(void (^)(void))completionHandler WK_API_AVAILABLE(ios(11.0));
455
456 - (void)didStartFormControlInteraction WK_API_AVAILABLE(ios(10.3));
457 - (void)didEndFormControlInteraction WK_API_AVAILABLE(ios(10.3));
458
459 - (void)_didShowForcePressPreview WK_API_AVAILABLE(ios(10.3));
460 - (void)_didDismissForcePressPreview WK_API_AVAILABLE(ios(10.3));
461 - (void)_doAfterNextStablePresentationUpdate:(dispatch_block_t)updateBlock WK_API_AVAILABLE(ios(10.3));
462
463 @property (nonatomic, readonly) NSArray<NSValue *> *_uiTextSelectionRects WK_API_AVAILABLE(ios(10.3));
464 @property (nonatomic, readonly) CGRect _uiTextCaretRect WK_API_AVAILABLE(ios(10.3));
465 @property (nonatomic, readonly) CGRect _inputViewBounds WK_API_AVAILABLE(ios(10.3));
466
467 @property (nonatomic, readonly) NSString *_scrollingTreeAsText WK_API_AVAILABLE(ios(10.3));
468
469 @property (nonatomic, readonly) NSNumber *_stableStateOverride WK_API_AVAILABLE(ios(10.3));
470
471 - (NSDictionary *)_propertiesOfLayerWithID:(unsigned long long)layerID WK_API_AVAILABLE(ios(11.0));
472 - (void)_simulateLongPressActionAtLocation:(CGPoint)location WK_API_AVAILABLE(ios(11.0));
473 - (void)_simulateTextEntered:(NSString *)text WK_API_AVAILABLE(ios(12.0));
474
475 @property (nonatomic, readonly) CGRect _dragCaretRect WK_API_AVAILABLE(ios(11.0));
476
477 - (void)_requestActivatedElementAtPosition:(CGPoint)position completionBlock:(void (^)(_WKActivatedElementInfo *))block WK_API_AVAILABLE(ios(11.0));
478 - (void)_accessibilityRetrieveRectsAtSelectionOffset:(NSInteger)offset withText:(NSString *)text completionHandler:(void (^)(NSArray<NSValue *> *rects))completionHandler WK_API_AVAILABLE(ios(11.3));
479 - (void)_accessibilityStoreSelection WK_API_AVAILABLE(ios(11.3));
480 - (void)_accessibilityClearSelection WK_API_AVAILABLE(ios(11.3));
481 - (UIView *)_fullScreenPlaceholderView WK_API_AVAILABLE(ios(12.0));
482
483 @property (nonatomic, readonly) BOOL _contentViewIsFirstResponder WK_API_AVAILABLE(ios(WK_IOS_TBA));
484 #else
485 - (void)_dismissContentRelativeChildWindows WK_API_AVAILABLE(macosx(10.13.4));
486 - (void)_setFrame:(NSRect)rect andScrollBy:(NSSize)offset WK_API_AVAILABLE(macosx(10.13.4));
487 - (void)_beginDeferringViewInWindowChanges WK_API_AVAILABLE(macosx(10.13.4));
488 - (void)_endDeferringViewInWindowChanges WK_API_AVAILABLE(macosx(10.13.4));
489 - (void)_endDeferringViewInWindowChangesSync WK_API_AVAILABLE(macosx(10.13.4));
490 - (void)_gestureEventWasNotHandledByWebCore:(NSEvent *)event WK_API_AVAILABLE(macosx(10.13.4));
491 - (void)_setCustomSwipeViews:(NSArray *)customSwipeViews WK_API_AVAILABLE(macosx(10.13.4));
492 - (void)_setCustomSwipeViewsTopContentInset:(float)topContentInset WK_API_AVAILABLE(macosx(10.13.4));
493 - (NSView *)_fullScreenPlaceholderView WK_API_AVAILABLE(macosx(10.13.4));
494 - (NSWindow *)_fullScreenWindow WK_API_AVAILABLE(macosx(10.13.4));
495 - (void)_disableFrameSizeUpdates WK_API_AVAILABLE(macosx(10.13.4));
496 - (void)_enableFrameSizeUpdates WK_API_AVAILABLE(macosx(10.13.4));
497 - (void)_prepareForImmediateActionAnimation WK_API_AVAILABLE(macosx(10.13.4));
498 - (void)_cancelImmediateActionAnimation WK_API_AVAILABLE(macosx(10.13.4));
499 - (void)_completeImmediateActionAnimation WK_API_AVAILABLE(macosx(10.13.4));
500 - (BOOL)_canChangeFrameLayout:(_WKFrameHandle *)frameHandle WK_API_AVAILABLE(macosx(10.13.4));
501 - (BOOL)_tryToSwipeWithEvent:(NSEvent *)event ignoringPinnedState:(BOOL)ignoringPinnedState WK_API_AVAILABLE(macosx(10.13.4));
502 - (void)_setDidMoveSwipeSnapshotCallback:(void(^)(CGRect))callback WK_API_AVAILABLE(macosx(10.13.4));
503 @property (nonatomic, setter=_setTotalHeightOfBanners:) CGFloat _totalHeightOfBanners WK_API_AVAILABLE(macosx(10.13.4));
504 @property (nonatomic, copy, setter=_setUnderlayColor:) NSColor *_underlayColor WK_API_AVAILABLE(macosx(10.13.4));
505 @property (nonatomic, readwrite, setter=_setIgnoresNonWheelEvents:) BOOL _ignoresNonWheelEvents WK_API_AVAILABLE(macosx(10.13.4));
506 @property (nonatomic, readonly) WKPageRef _pageRefForTransitionToWKWebView  WK_API_AVAILABLE(macosx(10.13.4));
507 @property (nonatomic, readonly) BOOL _hasActiveVideoForControlsManager WK_API_AVAILABLE(macosx(10.12));
508 - (void)_requestControlledElementID WK_API_AVAILABLE(macosx(10.12.3));
509 - (void)_handleControlledElementIDResponse:(NSString *)identifier WK_API_AVAILABLE(macosx(10.12.3));
510 - (void)_handleAcceptedCandidate:(NSTextCheckingResult *)candidate WK_API_AVAILABLE(macosx(10.12.3));
511 - (void)_didHandleAcceptedCandidate WK_API_AVAILABLE(macosx(10.12.3));
512 - (void)_forceRequestCandidates WK_API_AVAILABLE(macosx(10.12.3));
513 - (void)_didUpdateCandidateListVisibility:(BOOL)visible WK_API_AVAILABLE(macosx(10.12.3));
514 @property (nonatomic, readonly) BOOL _shouldRequestCandidates WK_API_AVAILABLE(macosx(10.12.3));
515 - (void)_insertText:(id)string replacementRange:(NSRange)replacementRange WK_API_AVAILABLE(macosx(10.12.3));
516 - (NSRect)_candidateRect WK_API_AVAILABLE(macosx(10.13));
517 @property (nonatomic, readwrite, setter=_setUseSystemAppearance:) BOOL _useSystemAppearance WK_API_AVAILABLE(macosx(10.14));
518
519 - (void)_setHeaderBannerHeight:(int)height WK_API_AVAILABLE(macosx(10.12.3));
520 - (void)_setFooterBannerHeight:(int)height WK_API_AVAILABLE(macosx(10.12.3));
521 - (void)_doAfterProcessingAllPendingMouseEvents:(dispatch_block_t)action WK_API_AVAILABLE(macosx(WK_MAC_TBA));
522 #endif
523
524 - (void)_requestActiveNowPlayingSessionInfo:(void(^)(BOOL, BOOL, NSString*, double, double, NSInteger))callback WK_API_AVAILABLE(macosx(10.13.4), ios(11.3));
525
526 - (void)_setPageScale:(CGFloat)scale withOrigin:(CGPoint)origin WK_API_AVAILABLE(ios(10.3));
527 - (CGFloat)_pageScale WK_API_AVAILABLE(ios(10.3));
528
529 - (void)_doAfterNextPresentationUpdate:(void (^)(void))updateBlock WK_API_AVAILABLE(macosx(10.12), ios(10.0));
530 - (void)_doAfterNextPresentationUpdateWithoutWaitingForAnimatedResizeForTesting:(void (^)(void))updateBlock WK_API_AVAILABLE(macosx(10.14), ios(12.0));
531 - (void)_doAfterNextPresentationUpdateWithoutWaitingForPainting:(void (^)(void))updateBlock WK_API_AVAILABLE(macosx(10.12.3), ios(10.3));
532 - (void)_doAfterNextVisibleContentRectUpdate:(void (^)(void))updateBlock WK_API_AVAILABLE(macosx(10.13), ios(11.0));
533
534 - (void)_disableBackForwardSnapshotVolatilityForTesting WK_API_AVAILABLE(macosx(10.12.3), ios(10.3));
535 - (void)_executeEditCommand:(NSString *)command argument:(NSString *)argument completion:(void (^)(BOOL))completion WK_API_AVAILABLE(macosx(10.13.4), ios(11.3));
536
537 - (void)_denyNextUserMediaRequest WK_API_AVAILABLE(macosx(10.14), ios(12.0));
538
539 - (BOOL)_beginBackSwipeForTesting;
540 - (BOOL)_completeBackSwipeForTesting;
541 - (void)_setDefersLoadingForTesting:(BOOL)defersLoading;
542
543 - (void)_setShareSheetCompletesImmediatelyWithResolutionForTesting:(BOOL)resolved WK_API_AVAILABLE(macosx(WK_MAC_TBA), ios(WK_IOS_TBA));
544
545 @property (nonatomic, readonly) BOOL _hasInspectorFrontend WK_API_AVAILABLE(macosx(WK_MAC_TBA), ios(WK_IOS_TBA));
546 @property (nonatomic, readonly) _WKInspector *_inspector WK_API_AVAILABLE(macosx(WK_MAC_TBA), ios(WK_IOS_TBA));
547 @property (nonatomic, readonly) _WKFrameHandle *_mainFrame WK_API_AVAILABLE(macosx(WK_MAC_TBA), ios(WK_IOS_TBA));
548
549 - (void)_processWillSuspendImminentlyForTesting;
550 - (void)_processDidResumeForTesting;
551
552 @end