409df4c84357fb9497d15a8dd3b70a5ab69178bc
[WebKit-https.git] / Source / WebKit2 / UIProcess / API / Cocoa / WKViewPrivate.h
1 /*
2  * Copyright (C) 2011, 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/WKActionMenuTypes.h>
27 #import <WebKit/WKBase.h>
28 #import <WebKit/WKImmediateActionTypes.h>
29 #import <WebKit/WKView.h>
30
31 @interface WKView (Private)
32
33 /* C SPI support. */
34
35 @property (readonly) WKPageRef pageRef;
36
37 #if TARGET_OS_IPHONE
38 - (id)initWithFrame:(CGRect)frame contextRef:(WKContextRef)contextRef pageGroupRef:(WKPageGroupRef)pageGroupRef;
39 - (id)initWithFrame:(CGRect)frame contextRef:(WKContextRef)contextRef pageGroupRef:(WKPageGroupRef)pageGroupRef relatedToPage:(WKPageRef)relatedPage;
40 #else
41 - (id)initWithFrame:(NSRect)frame contextRef:(WKContextRef)contextRef pageGroupRef:(WKPageGroupRef)pageGroupRef;
42 - (id)initWithFrame:(NSRect)frame contextRef:(WKContextRef)contextRef pageGroupRef:(WKPageGroupRef)pageGroupRef relatedToPage:(WKPageRef)relatedPage;
43 - (id)initWithFrame:(NSRect)frame configurationRef:(WKPageConfigurationRef)configuration;
44 #endif
45
46 #if TARGET_OS_IPHONE
47
48 @property (nonatomic) CGSize minimumLayoutSizeOverride;
49
50 // Define the inset of the scrollview unusable by the web page.
51 @property (nonatomic, setter=_setObscuredInsets:) UIEdgeInsets _obscuredInsets;
52
53 @property (nonatomic, setter=_setBackgroundExtendsBeyondPage:) BOOL _backgroundExtendsBeyondPage;
54
55 // This is deprecated and should be removed entirely: <rdar://problem/16294704>.
56 @property (readonly) UIColor *_pageExtendedBackgroundColor;
57
58 - (void)_beginInteractiveObscuredInsetsChange;
59 - (void)_endInteractiveObscuredInsetsChange;
60 - (void)_didRelaunchProcess;
61
62 #else
63
64 - (NSPrintOperation *)printOperationWithPrintInfo:(NSPrintInfo *)printInfo forFrame:(WKFrameRef)frameRef;
65 - (BOOL)canChangeFrameLayout:(WKFrameRef)frameRef;
66
67 - (void)setFrame:(NSRect)rect andScrollBy:(NSSize)offset;
68
69 // Stops updating the size of the page as the WKView frame size updates.
70 // This should always be followed by enableFrameSizeUpdates. Calls can be nested.
71 - (void)disableFrameSizeUpdates;
72 // Immediately updates the size of the page to match WKView's frame size
73 // and allows subsequent updates as the frame size is set. Calls can be nested.
74 - (void)enableFrameSizeUpdates;
75 - (BOOL)frameSizeUpdatesDisabled;
76
77 + (void)hideWordDefinitionWindow;
78
79 @property (readwrite) CGFloat minimumLayoutWidth;
80 @property (readwrite) CGFloat minimumWidthForAutoLayout;
81 @property (readwrite) NSSize minimumSizeForAutoLayout;
82 @property (readwrite) BOOL shouldClipToVisibleRect;
83 @property (readwrite) BOOL shouldExpandToViewHeightForAutoLayout;
84 @property (readonly, getter=isUsingUISideCompositing) BOOL usingUISideCompositing;
85 @property (readwrite) BOOL allowsMagnification;
86 @property (readwrite) double magnification;
87 @property (readwrite, setter=_setIgnoresNonWheelEvents:) BOOL _ignoresNonWheelEvents;
88 @property (readwrite, setter=_setIgnoresAllEvents:) BOOL _ignoresAllEvents;
89 @property (readwrite) BOOL allowsBackForwardNavigationGestures;
90 @property (nonatomic, setter=_setTopContentInset:) CGFloat _topContentInset;
91 @property (nonatomic, setter=_setTotalHeightOfBanners:) CGFloat _totalHeightOfBanners;
92
93 @property (nonatomic, setter=_setOverrideDeviceScaleFactor:) CGFloat _overrideDeviceScaleFactor WK_AVAILABLE(WK_MAC_TBA, NA);
94
95 #if __MAC_OS_X_VERSION_MIN_REQUIRED >= 101000
96 @property (nonatomic, setter=_setAutomaticallyAdjustsContentInsets:) BOOL _automaticallyAdjustsContentInsets;
97 #endif
98
99 @property (readonly) NSColor *_pageExtendedBackgroundColor;
100 @property (copy, nonatomic) NSColor *underlayColor;
101
102 #if WK_API_ENABLED
103 @property (strong, nonatomic, setter=_setInspectorAttachmentView:) NSView *_inspectorAttachmentView WK_AVAILABLE(WK_MAC_TBA, NA);
104 #endif
105
106 - (NSView*)fullScreenPlaceholderView;
107 - (NSWindow*)createFullScreenWindow;
108
109 - (void)beginDeferringViewInWindowChanges;
110 - (void)endDeferringViewInWindowChanges;
111 - (void)endDeferringViewInWindowChangesSync;
112 - (BOOL)isDeferringViewInWindowChanges;
113 - (void)_prepareForMoveToWindow:(NSWindow *)targetWindow withCompletionHandler:(void(^)(void))completionHandler;
114
115 - (BOOL)windowOcclusionDetectionEnabled;
116 - (void)setWindowOcclusionDetectionEnabled:(BOOL)flag;
117
118 - (void)forceAsyncDrawingAreaSizeUpdate:(NSSize)size;
119 - (void)waitForAsyncDrawingAreaSizeUpdate;
120
121 - (void)setMagnification:(double)magnification centeredAtPoint:(NSPoint)point;
122
123 - (void)saveBackForwardSnapshotForCurrentItem;
124 - (void)saveBackForwardSnapshotForItem:(WKBackForwardListItemRef)item;
125
126 // Views must be layer-backed, have no transform applied, be in back-to-front z-order, and the whole set must be a contiguous opaque rectangle.
127 - (void)_setCustomSwipeViews:(NSArray *)customSwipeViews;
128 // The top content inset is applied in the window's coordinate space, to the union of the custom swipe view's frames.
129 - (void)_setCustomSwipeViewsTopContentInset:(float)topContentInset;
130 - (BOOL)_tryToSwipeWithEvent:(NSEvent *)event ignoringPinnedState:(BOOL)ignoringPinnedState;
131 // The rect returned is always that of the snapshot, and only if it is the view being manipulated by the swipe. This only works for layer-backed windows.
132 - (void)_setDidMoveSwipeSnapshotCallback:(void(^)(CGRect swipeSnapshotRectInWindowCoordinates))callback;
133
134 - (NSArray *)_actionMenuItemsForHitTestResult:(WKHitTestResultRef)hitTestResult withType:(_WKActionMenuType)type defaultActionMenuItems:(NSArray *)defaultMenuItems;
135 - (NSArray *)_actionMenuItemsForHitTestResult:(WKHitTestResultRef)hitTestResult withType:(_WKActionMenuType)type defaultActionMenuItems:(NSArray *)defaultMenuItems userData:(WKTypeRef)userData;
136
137 // Clients that want to maintain default behavior can return nil. To disable the immediate action entirely, return NSNull. And to
138 // do something custom, return an object that conforms to the NSImmediateActionAnimationController protocol.
139 - (id)_immediateActionAnimationControllerForHitTestResult:(WKHitTestResultRef)hitTestResult withType:(_WKImmediateActionType)type userData:(WKTypeRef)userData;
140
141 - (void)_prepareForImmediateActionAnimation;
142 - (void)_cancelImmediateActionAnimation;
143 - (void)_completeImmediateActionAnimation;
144
145 - (void)_dismissContentRelativeChildWindows;
146
147 - (void)_didChangeContentSize:(NSSize)newSize;
148 #endif
149
150 @end