Speculative build fix.
[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 #if !TARGET_OS_IPHONE
27
28 #import <WebKit/WKBase.h>
29 #import <WebKit/WKImmediateActionTypes.h>
30 #import <WebKit/WKLayoutMode.h>
31 #import <WebKit/WKView.h>
32 #import <WebKit/_WKOverlayScrollbarStyle.h>
33
34 @interface WKView (Private)
35
36 /* C SPI support. */
37
38 @property (readonly) WKPageRef pageRef;
39
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 - (id)initWithFrame:(NSRect)frame configurationRef:(WKPageConfigurationRef)configuration;
43
44 - (NSPrintOperation *)printOperationWithPrintInfo:(NSPrintInfo *)printInfo forFrame:(WKFrameRef)frameRef;
45 - (BOOL)canChangeFrameLayout:(WKFrameRef)frameRef;
46
47 - (void)setFrame:(NSRect)rect andScrollBy:(NSSize)offset;
48
49 // Stops updating the size of the page as the WKView frame size updates.
50 // This should always be followed by enableFrameSizeUpdates. Calls can be nested.
51 - (void)disableFrameSizeUpdates;
52 // Immediately updates the size of the page to match WKView's frame size
53 // and allows subsequent updates as the frame size is set. Calls can be nested.
54 - (void)enableFrameSizeUpdates;
55 - (BOOL)frameSizeUpdatesDisabled;
56
57 + (void)hideWordDefinitionWindow;
58
59 @property (readwrite) NSSize minimumSizeForAutoLayout;
60 @property (readwrite) BOOL shouldClipToVisibleRect;
61 @property (readwrite) BOOL shouldExpandToViewHeightForAutoLayout;
62 @property (readonly, getter=isUsingUISideCompositing) BOOL usingUISideCompositing;
63 @property (readwrite) BOOL allowsMagnification;
64 @property (readwrite) double magnification;
65 @property (readwrite, setter=_setIgnoresNonWheelEvents:) BOOL _ignoresNonWheelEvents;
66 @property (readwrite, setter=_setIgnoresAllEvents:) BOOL _ignoresAllEvents;
67 @property (readwrite) BOOL allowsBackForwardNavigationGestures;
68 @property (nonatomic, setter=_setTopContentInset:) CGFloat _topContentInset;
69 @property (nonatomic, setter=_setTotalHeightOfBanners:) CGFloat _totalHeightOfBanners;
70
71 @property (nonatomic, setter=_setOverlayScrollbarStyle:) _WKOverlayScrollbarStyle _overlayScrollbarStyle;
72
73 @property (nonatomic, setter=_setLayoutMode:) WKLayoutMode _layoutMode;
74 // For use with _layoutMode = kWKLayoutModeFixedSize:
75 @property (nonatomic, setter=_setFixedLayoutSize:) CGSize _fixedLayoutSize;
76
77 @property (nonatomic, setter=_setViewScale:) CGFloat _viewScale;
78
79 @property (nonatomic, setter=_setOverrideDeviceScaleFactor:) CGFloat _overrideDeviceScaleFactor WK_API_AVAILABLE(macosx(10.11));
80
81 @property (nonatomic, setter=_setAutomaticallyAdjustsContentInsets:) BOOL _automaticallyAdjustsContentInsets;
82
83 @property (readonly) NSColor *_pageExtendedBackgroundColor;
84 @property (copy, nonatomic) NSColor *underlayColor;
85
86 #if WK_API_ENABLED
87 @property (strong, nonatomic, setter=_setInspectorAttachmentView:) NSView *_inspectorAttachmentView WK_API_AVAILABLE(macosx(10.11));
88 #endif
89
90 @property (nonatomic, readwrite, setter=_setRequiresUserActionForEditingControlsManager:) BOOL _requiresUserActionForEditingControlsManager;
91
92 - (NSView*)fullScreenPlaceholderView;
93 - (NSWindow*)createFullScreenWindow;
94
95 - (void)beginDeferringViewInWindowChanges;
96 - (void)endDeferringViewInWindowChanges;
97 - (void)endDeferringViewInWindowChangesSync;
98 - (BOOL)isDeferringViewInWindowChanges;
99 - (void)_prepareForMoveToWindow:(NSWindow *)targetWindow withCompletionHandler:(void(^)(void))completionHandler;
100
101 - (BOOL)windowOcclusionDetectionEnabled;
102 - (void)setWindowOcclusionDetectionEnabled:(BOOL)flag;
103
104 - (void)setMagnification:(double)magnification centeredAtPoint:(NSPoint)point;
105
106 - (void)setAllowsLinkPreview:(BOOL)allowsLinkPreview;
107 - (BOOL)allowsLinkPreview;
108
109 - (void)saveBackForwardSnapshotForCurrentItem;
110 - (void)saveBackForwardSnapshotForItem:(WKBackForwardListItemRef)item;
111
112 // 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.
113 - (void)_setCustomSwipeViews:(NSArray *)customSwipeViews;
114 // The top content inset is applied in the window's coordinate space, to the union of the custom swipe view's frames.
115 - (void)_setCustomSwipeViewsTopContentInset:(float)topContentInset;
116 - (BOOL)_tryToSwipeWithEvent:(NSEvent *)event ignoringPinnedState:(BOOL)ignoringPinnedState;
117 // 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.
118 - (void)_setDidMoveSwipeSnapshotCallback:(void(^)(CGRect swipeSnapshotRectInWindowCoordinates))callback;
119
120 // Clients that want to maintain default behavior can return nil. To disable the immediate action entirely, return NSNull. And to
121 // do something custom, return an object that conforms to the NSImmediateActionAnimationController protocol.
122 - (id)_immediateActionAnimationControllerForHitTestResult:(WKHitTestResultRef)hitTestResult withType:(uint32_t)type userData:(WKTypeRef)userData;
123
124 - (void)_prepareForImmediateActionAnimation;
125 - (void)_cancelImmediateActionAnimation;
126 - (void)_completeImmediateActionAnimation;
127
128 - (void)_dismissContentRelativeChildWindows;
129 - (void)_dismissContentRelativeChildWindowsWithAnimation:(BOOL)withAnimation;
130
131 - (void)_didChangeContentSize:(NSSize)newSize;
132
133 - (void)_gestureEventWasNotHandledByWebCore:(NSEvent *)event;
134
135 @property (nonatomic, readwrite, setter=_setWantsMediaPlaybackControlsView:) BOOL _wantsMediaPlaybackControlsView;
136 @property (nonatomic, readonly)  id _mediaPlaybackControlsView;
137 - (void)_addMediaPlaybackControlsView:(id)mediaPlaybackControlsView;
138 - (void)_removeMediaPlaybackControlsView;
139
140 @end
141
142 #endif // !TARGET_OS_IPHONE