f876a2c59616ff38034c221db080e00b7b741044
[WebKit-https.git] / Source / WebKit2 / 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 #if WK_API_ENABLED
29
30 #import <WebKit/_WKFindOptions.h>
31 #import <WebKit/_WKLayoutMode.h>
32 #import <WebKit/_WKRenderingProgressEvents.h>
33
34 typedef NS_ENUM(NSInteger, _WKPaginationMode) {
35     _WKPaginationModeUnpaginated,
36     _WKPaginationModeLeftToRight,
37     _WKPaginationModeRightToLeft,
38     _WKPaginationModeTopToBottom,
39     _WKPaginationModeBottomToTop,
40 } WK_ENUM_AVAILABLE(10_10, 8_0);
41
42 WK_EXTERN NSString * const _WKShouldOpenExternalURLsKey WK_AVAILABLE(WK_MAC_TBA, WK_IOS_TBA);
43
44 @class WKBrowsingContextHandle;
45 @class _WKRemoteObjectRegistry;
46 @class _WKSessionState;
47 @class _WKWebViewPrintFormatter;
48
49 @protocol WKHistoryDelegatePrivate;
50 @protocol _WKDiagnosticLoggingDelegate;
51 @protocol _WKFindDelegate;
52 @protocol _WKFormDelegate;
53
54 @interface WKWebView (WKPrivate)
55
56 // FIXME: This should return a _WKRemoteObjectRegistry *.
57 @property (nonatomic, readonly) id _remoteObjectRegistry;
58 @property (nonatomic, readonly) WKBrowsingContextHandle *_handle;
59
60 @property (nonatomic, setter=_setObservedRenderingProgressEvents:) _WKRenderingProgressEvents _observedRenderingProgressEvents;
61
62 @property (nonatomic, weak, setter=_setHistoryDelegate:) id <WKHistoryDelegatePrivate> _historyDelegate;
63
64 @property (nonatomic, readonly) NSURL *_unreachableURL;
65
66 - (void)_loadAlternateHTMLString:(NSString *)string baseURL:(NSURL *)baseURL forUnreachableURL:(NSURL *)unreachableURL;
67
68 @property (nonatomic, readonly) NSArray *_certificateChain;
69 @property (nonatomic, readonly) NSURL *_committedURL;
70 @property (nonatomic, readonly) NSString *_MIMEType;
71 @property (nonatomic, readonly) NSString *_userAgent WK_AVAILABLE(WK_MAC_TBA, WK_IOS_TBA);
72
73 @property (copy, setter=_setApplicationNameForUserAgent:) NSString *_applicationNameForUserAgent;
74 @property (copy, setter=_setCustomUserAgent:) NSString *_customUserAgent;
75
76 @property (nonatomic, readonly) pid_t _webProcessIdentifier;
77
78 @property (nonatomic, getter=_isEditable, setter=_setEditable:) BOOL _editable WK_AVAILABLE(WK_MAC_TBA, WK_IOS_TBA);
79
80 // FIXME: Remove these once nobody is using them.
81 @property (nonatomic, readonly) NSData *_sessionStateData;
82 - (void)_restoreFromSessionStateData:(NSData *)sessionStateData;
83
84 @property (nonatomic, readonly) _WKSessionState *_sessionState;
85 - (WKNavigation *)_restoreSessionState:(_WKSessionState *)sessionState andNavigate:(BOOL)navigate;
86
87 @property (nonatomic, setter=_setAllowsRemoteInspection:) BOOL _allowsRemoteInspection;
88
89 @property (nonatomic, setter=_setAddsVisitedLinks:) BOOL _addsVisitedLinks;
90
91 @property (nonatomic, readonly) BOOL _networkRequestsInProgress;
92
93 @property (nonatomic, readonly, getter=_isShowingNavigationGestureSnapshot) BOOL _showingNavigationGestureSnapshot;
94
95 - (void)_close;
96
97 @property (nonatomic, setter=_setLayoutMode:) _WKLayoutMode _layoutMode;
98 // For use with _layoutMode = _WKLayoutModeFixedSize:
99 @property (nonatomic, setter=_setFixedLayoutSize:) CGSize _fixedLayoutSize;
100 // For use with _layoutMode = _WKLayoutModeDynamicSizeWithMinimumViewSize:
101 @property (nonatomic, setter=_setMinimumViewSize:) CGSize _minimumViewSize;
102
103 @property (nonatomic, setter=_setViewScale:) CGFloat _viewScale;
104
105 #if TARGET_OS_IPHONE
106 // DERECATED: The setters of the three following function are deprecated, please use overrideLayoutParameters.
107 // Define the smallest size a page take with a regular viewport.
108 @property (nonatomic, readonly) CGSize _minimumLayoutSizeOverride;
109 // Define the largest size the unobscured area can get for the current view bounds. This value is used to define viewport units.
110 @property (nonatomic, readonly) CGSize _maximumUnobscuredSizeOverride;
111
112 // Define the inset of the scrollview unusable by the web page.
113 @property (nonatomic, setter=_setObscuredInsets:) UIEdgeInsets _obscuredInsets;
114
115 // Override the interface orientation. Clients using _beginAnimatedResizeWithUpdates: must update the interface orientation
116 // in the update block.
117 @property (nonatomic, setter=_setInterfaceOrientationOverride:) UIInterfaceOrientation _interfaceOrientationOverride;
118
119 @property (nonatomic, setter=_setBackgroundExtendsBeyondPage:) BOOL _backgroundExtendsBeyondPage;
120
121 // FIXME: Remove these three properties once we expose WKWebViewContentProvider as API.
122 @property (nonatomic, readonly, getter=_isDisplayingPDF) BOOL _displayingPDF;
123 @property (nonatomic, readonly) NSData *_dataForDisplayedPDF;
124 // FIXME: This can be removed once WKNavigation's response property is implemented.
125 @property (nonatomic, readonly) NSString *_suggestedFilenameForDisplayedPDF;
126
127 // The viewport meta tag width is negative if the value is not defined.
128 @property (nonatomic, readonly) CGFloat _viewportMetaTagWidth;
129
130 @property (nonatomic, readonly) _WKWebViewPrintFormatter *_webViewPrintFormatter;
131
132 // Indicating whether link preview is allowed. The default value is YES.
133 @property (nonatomic, getter=_allowsLinkPreview, setter=_setAllowsLinkPreview:) BOOL _allowsLinkPreview WK_AVAILABLE(NA, WK_IOS_TBA);
134
135 - (void)_beginInteractiveObscuredInsetsChange;
136 - (void)_endInteractiveObscuredInsetsChange;
137
138 - (void)_beginAnimatedResizeWithUpdates:(void (^)(void))updateBlock;
139 - (void)_endAnimatedResize;
140 - (void)_resizeWhileHidingContentWithUpdates:(void (^)(void))updateBlock;
141
142 - (void)_snapshotRect:(CGRect)rectInViewCoordinates intoImageOfWidth:(CGFloat)imageWidth completionHandler:(void(^)(CGImageRef))completionHandler;
143
144 // Deprecated: Use [_overrideLayoutParametersWithMinimumLayoutSize:maximumUnobscuredSizeOverride:] instead.
145 // This function is kept for binary compatibility with iOS 8.0, it can be removed after the bincompat window.
146 - (void)_overrideLayoutParametersWithMinimumLayoutSize:(CGSize)minimumLayoutSize minimumLayoutSizeForMinimalUI:(CGSize)minimumLayoutSizeForMinimalUI maximumUnobscuredSizeOverride:(CGSize)maximumUnobscuredSizeOverride WK_DEPRECATED(NA, NA, 8_0, WK_IOS_TBA, "use -_overrideLayoutParametersWithMinimumLayoutSize:maximumUnobscuredSizeOverride:");
147
148 - (void)_overrideLayoutParametersWithMinimumLayoutSize:(CGSize)minimumLayoutSize maximumUnobscuredSizeOverride:(CGSize)maximumUnobscuredSizeOverride WK_AVAILABLE(NA, WK_IOS_TBA);
149
150 - (UIView *)_viewForFindUI;
151
152 - (void)_setOverlaidAccessoryViewsInset:(CGSize)inset;
153
154 - (void)_killWebContentProcess;
155 - (void)_didRelaunchProcess;
156
157 // Puts the view into a state where being taken out of the view hierarchy and resigning first responder
158 // will not count as becoming inactive and unfocused. The returned block must be called to exit the state.
159 - (void (^)(void))_retainActiveFocusedState WK_AVAILABLE(NA, WK_IOS_TBA);
160
161 - (void)_becomeFirstResponderWithSelectionMovingForward:(BOOL)selectingForward completionHandler:(void (^)(BOOL didBecomeFirstResponder))completionHandler WK_AVAILABLE(NA, WK_IOS_TBA);
162
163 #else
164 @property (readonly) NSColor *_pageExtendedBackgroundColor;
165 @property (nonatomic, setter=_setDrawsTransparentBackground:) BOOL _drawsTransparentBackground;
166 @property (nonatomic, setter=_setTopContentInset:) CGFloat _topContentInset;
167
168 #if __MAC_OS_X_VERSION_MIN_REQUIRED >= 101000
169 @property (nonatomic, setter=_setAutomaticallyAdjustsContentInsets:) BOOL _automaticallyAdjustsContentInsets;
170 #endif
171
172 // 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.
173 @property (nonatomic, setter=_setOverrideDeviceScaleFactor:) CGFloat _overrideDeviceScaleFactor WK_AVAILABLE(WK_MAC_TBA, NA);
174 #endif
175
176 - (void)_getMainResourceDataWithCompletionHandler:(void (^)(NSData *, NSError *))completionHandler;
177 - (void)_getWebArchiveDataWithCompletionHandler:(void (^)(NSData *, NSError *))completionHandler;
178
179 @property (nonatomic, setter=_setPaginationMode:) _WKPaginationMode _paginationMode;
180 // Whether the column-break-{before,after} properties are respected instead of the
181 // page-break-{before,after} properties.
182 @property (nonatomic, setter=_setPaginationBehavesLikeColumns:) BOOL _paginationBehavesLikeColumns;
183 // Set to 0 to have the page length equal the view length.
184 @property (nonatomic, setter=_setPageLength:) CGFloat _pageLength;
185 @property (nonatomic, setter=_setGapBetweenPages:) CGFloat _gapBetweenPages;
186 @property (readonly) NSUInteger _pageCount;
187
188 @property (nonatomic, readonly) BOOL _supportsTextZoom;
189 @property (nonatomic, setter=_setTextZoomFactor:) double _textZoomFactor;
190 @property (nonatomic, setter=_setPageZoomFactor:) double _pageZoomFactor;
191
192 @property (nonatomic, weak, setter=_setDiagnosticLoggingDelegate:) id <_WKDiagnosticLoggingDelegate> _diagnosticLoggingDelegate WK_AVAILABLE(WK_MAC_TBA, WK_IOS_TBA);
193 @property (nonatomic, weak, setter=_setFindDelegate:) id <_WKFindDelegate> _findDelegate;
194 - (void)_findString:(NSString *)string options:(_WKFindOptions)options maxCount:(NSUInteger)maxCount;
195 - (void)_countStringMatches:(NSString *)string options:(_WKFindOptions)options maxCount:(NSUInteger)maxCount;
196 - (void)_hideFindUI;
197
198 @property (nonatomic, weak, setter=_setFormDelegate:) id <_WKFormDelegate> _formDelegate;
199
200 @property (nonatomic, readonly, getter=_isDisplayingStandaloneImageDocument) BOOL _displayingStandaloneImageDocument;
201
202 @property (nonatomic, setter=_setScrollPerformanceDataCollectionEnabled:) BOOL _scrollPerformanceDataCollectionEnabled WK_AVAILABLE(WK_MAC_TBA, WK_IOS_TBA);
203 @property (nonatomic, readonly) NSArray *_scrollPerformanceData WK_AVAILABLE(WK_MAC_TBA, WK_IOS_TBA);
204
205 - (WKNavigation *)_loadRequest:(NSURLRequest *)request withOptions:(NSDictionary *)loadOptions WK_AVAILABLE(WK_MAC_TBA, WK_IOS_TBA);
206
207 @end
208
209 #endif