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