iOS build fix after r176299. This method is not defined in WKViewIOS.mm.
[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/WKView.h>
29
30 @interface WKView (Private)
31
32 /* C SPI support. */
33
34 @property (readonly) WKPageRef pageRef;
35
36 #if TARGET_OS_IPHONE
37 - (id)initWithFrame:(CGRect)frame contextRef:(WKContextRef)contextRef pageGroupRef:(WKPageGroupRef)pageGroupRef;
38 - (id)initWithFrame:(CGRect)frame contextRef:(WKContextRef)contextRef pageGroupRef:(WKPageGroupRef)pageGroupRef relatedToPage:(WKPageRef)relatedPage;
39 #else
40 - (id)initWithFrame:(NSRect)frame contextRef:(WKContextRef)contextRef pageGroupRef:(WKPageGroupRef)pageGroupRef;
41 - (id)initWithFrame:(NSRect)frame contextRef:(WKContextRef)contextRef pageGroupRef:(WKPageGroupRef)pageGroupRef relatedToPage:(WKPageRef)relatedPage;
42 #endif
43
44 #if TARGET_OS_IPHONE
45
46 @property (nonatomic) CGSize minimumLayoutSizeOverride;
47
48 // Define the inset of the scrollview unusable by the web page.
49 @property (nonatomic, setter=_setObscuredInsets:) UIEdgeInsets _obscuredInsets;
50
51 @property (nonatomic, setter=_setBackgroundExtendsBeyondPage:) BOOL _backgroundExtendsBeyondPage;
52
53 // This is deprecated and should be removed entirely: <rdar://problem/16294704>.
54 @property (readonly) UIColor *_pageExtendedBackgroundColor;
55
56 - (void)_beginInteractiveObscuredInsetsChange;
57 - (void)_endInteractiveObscuredInsetsChange;
58
59 #else
60
61 - (NSPrintOperation *)printOperationWithPrintInfo:(NSPrintInfo *)printInfo forFrame:(WKFrameRef)frameRef;
62 - (BOOL)canChangeFrameLayout:(WKFrameRef)frameRef;
63
64 - (void)setFrame:(NSRect)rect andScrollBy:(NSSize)offset;
65
66 // Stops updating the size of the page as the WKView frame size updates.
67 // This should always be followed by enableFrameSizeUpdates. Calls can be nested.
68 - (void)disableFrameSizeUpdates;
69 // Immediately updates the size of the page to match WKView's frame size
70 // and allows subsequent updates as the frame size is set. Calls can be nested.
71 - (void)enableFrameSizeUpdates;
72 - (BOOL)frameSizeUpdatesDisabled;
73
74 + (void)hideWordDefinitionWindow;
75
76 @property (readwrite) CGFloat minimumLayoutWidth;
77 @property (readwrite) CGFloat minimumWidthForAutoLayout;
78 @property (readwrite) NSSize minimumSizeForAutoLayout;
79 @property (readwrite) BOOL shouldClipToVisibleRect;
80 @property (readwrite) BOOL shouldExpandToViewHeightForAutoLayout;
81 @property (readonly, getter=isUsingUISideCompositing) BOOL usingUISideCompositing;
82 @property (readwrite) BOOL allowsMagnification;
83 @property (readwrite) double magnification;
84 @property (readwrite, setter=_setIgnoresNonWheelMouseEvents:) BOOL _ignoresNonWheelMouseEvents;
85 @property (readwrite) BOOL allowsBackForwardNavigationGestures;
86 @property (nonatomic, setter=_setTopContentInset:) CGFloat _topContentInset;
87
88 #if __MAC_OS_X_VERSION_MIN_REQUIRED >= 101000
89 @property (nonatomic, setter=_setAutomaticallyAdjustsContentInsets:) BOOL _automaticallyAdjustsContentInsets;
90 #endif
91
92 @property (readonly) NSColor *_pageExtendedBackgroundColor;
93 @property(copy, nonatomic) NSColor *underlayColor;
94
95 - (NSView*)fullScreenPlaceholderView;
96 - (NSWindow*)createFullScreenWindow;
97
98 - (void)beginDeferringViewInWindowChanges;
99 - (void)endDeferringViewInWindowChanges;
100 - (void)endDeferringViewInWindowChangesSync;
101 - (BOOL)isDeferringViewInWindowChanges;
102
103 - (BOOL)windowOcclusionDetectionEnabled;
104 - (void)setWindowOcclusionDetectionEnabled:(BOOL)flag;
105
106 - (void)forceAsyncDrawingAreaSizeUpdate:(NSSize)size;
107 - (void)waitForAsyncDrawingAreaSizeUpdate;
108
109 - (void)setMagnification:(double)magnification centeredAtPoint:(NSPoint)point;
110
111 - (void)saveBackForwardSnapshotForCurrentItem;
112 - (void)saveBackForwardSnapshotForItem:(WKBackForwardListItemRef)item;
113
114 // 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.
115 - (void)_setCustomSwipeViews:(NSArray *)customSwipeViews;
116 // The top content inset is applied in the window's coordinate space, to the union of the custom swipe view's frames.
117 - (void)_setCustomSwipeViewsTopContentInset:(float)topContentInset;
118 - (BOOL)_tryToSwipeWithEvent:(NSEvent *)event ignoringPinnedState:(BOOL)ignoringPinnedState;
119 // 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.
120 - (void)_setDidMoveSwipeSnapshotCallback:(void(^)(CGRect swipeSnapshotRectInWindowCoordinates))callback;
121
122 - (NSArray *)_actionMenuItemsForHitTestResult:(WKHitTestResultRef)hitTestResult withType:(_WKActionMenuType)type defaultActionMenuItems:(NSArray *)defaultMenuItems;
123 - (NSArray *)_actionMenuItemsForHitTestResult:(WKHitTestResultRef)hitTestResult withType:(_WKActionMenuType)type defaultActionMenuItems:(NSArray *)defaultMenuItems userData:(WKTypeRef)userData;
124
125 - (NSView *)_viewForPreviewingURL:(NSURL *)url initialFrameSize:(NSSize)initialFrameSize;
126 - (void)_finishPreviewingURL:(NSURL *)url withPreviewView:(NSView *)previewView;
127 #endif
128
129 #if PLATFORM(MAC)
130 - (void)_dismissActionMenuPopovers;
131 #endif
132
133 @end