0c29194213f5f726bd8d70be90fab51b78e4dca0
[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 <WebKit2/WKWebView.h>
27
28 #if WK_API_ENABLED
29
30 typedef NS_OPTIONS(NSUInteger, _WKRenderingProgressEvents) {
31     _WKRenderingProgressEventFirstLayout = 1 << 0,
32     _WKRenderingProgressEventFirstPaintWithSignificantArea = 1 << 2,
33 };
34
35 typedef NS_ENUM(NSInteger, _WKPaginationMode) {
36     _WKPaginationModeUnpaginated,
37     _WKPaginationModeLeftToRight,
38     _WKPaginationModeRightToLeft,
39     _WKPaginationModeTopToBottom,
40     _WKPaginationModeBottomToTop,
41 };
42
43 @class WKBrowsingContextHandle;
44 @class WKRemoteObjectRegistry;
45 @protocol WKHistoryDelegatePrivate;
46
47 @interface WKWebView (WKPrivate)
48
49 @property (nonatomic, readonly) WKRemoteObjectRegistry *_remoteObjectRegistry;
50 @property (nonatomic, readonly) WKBrowsingContextHandle *_handle;
51
52 @property (nonatomic, setter=_setObservedRenderingProgressEvents:) _WKRenderingProgressEvents _observedRenderingProgressEvents;
53
54 @property (nonatomic, weak, setter=_setHistoryDelegate:) id <WKHistoryDelegatePrivate> _historyDelegate;
55
56 @property (nonatomic, readonly) NSURL *_unreachableURL;
57
58 - (void)_loadAlternateHTMLString:(NSString *)string baseURL:(NSURL *)baseURL forUnreachableURL:(NSURL *)unreachableURL;
59
60 - (WKNavigation *)_reload;
61
62 @property (nonatomic, readonly) NSArray *_certificateChain;
63 @property (nonatomic, readonly) NSURL *_committedURL;
64
65 @property (copy, setter=_setApplicationNameForUserAgent:) NSString *_applicationNameForUserAgent;
66 @property (copy, setter=_setCustomUserAgent:) NSString *_customUserAgent;
67
68 @property (nonatomic, readonly) pid_t _webProcessIdentifier;
69
70 @property (nonatomic, readonly) NSData *_sessionState;
71 - (void)_restoreFromSessionState:(NSData *)sessionState;
72
73 @property (nonatomic, setter=_setPrivateBrowsingEnabled:) BOOL _privateBrowsingEnabled;
74
75 @property (nonatomic, setter=_setAllowsRemoteInspection:) BOOL _allowsRemoteInspection;
76
77 - (void)_close;
78
79 #if TARGET_OS_IPHONE
80 @property (nonatomic, setter=_setMinimumLayoutSizeOverride:) CGSize _minimumLayoutSizeOverride;
81
82 // Define the inset of the scrollview unusable by the web page.
83 @property (nonatomic, setter=_setObscuredInsets:) UIEdgeInsets _obscuredInsets;
84
85 @property (nonatomic, setter=_setBackgroundExtendsBeyondPage:) BOOL _backgroundExtendsBeyondPage;
86
87 // This is deprecated and should be removed entirely: <rdar://problem/16294704>.
88 @property (readonly) UIColor *_pageExtendedBackgroundColor;
89
90 - (void)_beginInteractiveObscuredInsetsChange;
91 - (void)_endInteractiveObscuredInsetsChange;
92
93 - (void)_snapshotRect:(CGRect)rectInViewCoordinates intoImageOfWidth:(CGFloat)imageWidth completionHandler:(void(^)(CGImageRef))completionHandler;
94 #else
95 @property (readonly) NSColor *_pageExtendedBackgroundColor;
96 @property (nonatomic, setter=_setDrawsTransparentBackground:) BOOL _drawsTransparentBackground;
97 #endif
98
99 - (void)_runJavaScriptInMainFrame:(NSString *)scriptString;
100
101 @property (nonatomic, setter=_setPaginationMode:) _WKPaginationMode _paginationMode;
102 // Whether the column-break-{before,after} properties are respected instead of the
103 // page-break-{before,after} properties.
104 @property (nonatomic, setter=_setPaginationBehavesLikeColumns:) BOOL _paginationBehavesLikeColumns;
105 // Set to 0 to have the page length equal the view length.
106 @property (nonatomic, setter=_setPageLength:) CGFloat _pageLength;
107 @property (nonatomic, setter=_setGapBetweenPages:) CGFloat _gapBetweenPages;
108 @property (readonly) NSUInteger _pageCount;
109
110 @property (nonatomic, readonly) BOOL _supportsTextZoom;
111 @property (nonatomic, setter=_setTextZoomFactor:) double _textZoomFactor;
112 @property (nonatomic, setter=_setPageZoomFactor:) double _pageZoomFactor;
113
114 @end
115
116 #endif