Unreviewed, rolling out r251045.
[WebKit-https.git] / Source / WebKit / UIProcess / ios / WKActionSheetAssistant.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 #if PLATFORM(IOS_FAMILY)
27
28 #import "GestureTypes.h"
29 #import "WKActionSheet.h"
30 #import <UIKit/UIPopoverController.h>
31 #import <pal/spi/ios/DataDetectorsUISPI.h>
32 #import <wtf/RetainPtr.h>
33
34 namespace WebKit {
35 class WebPageProxy;
36 struct InteractionInformationAtPosition;
37 }
38
39 @class WKActionSheetAssistant;
40 @class _WKActivatedElementInfo;
41 @class _WKElementAction;
42 @protocol WKActionSheetDelegate;
43
44 @protocol WKActionSheetAssistantDelegate <NSObject>
45 @required
46 - (Optional<WebKit::InteractionInformationAtPosition>)positionInformationForActionSheetAssistant:(WKActionSheetAssistant *)assistant;
47 - (void)actionSheetAssistant:(WKActionSheetAssistant *)assistant performAction:(WebKit::SheetAction)action;
48 - (void)actionSheetAssistant:(WKActionSheetAssistant *)assistant openElementAtLocation:(CGPoint)location;
49 - (void)actionSheetAssistant:(WKActionSheetAssistant *)assistant shareElementWithURL:(NSURL *)url rect:(CGRect)boundingRect;
50 #if HAVE(APP_LINKS)
51 - (BOOL)actionSheetAssistant:(WKActionSheetAssistant *)assistant shouldIncludeAppLinkActionsForElement:(_WKActivatedElementInfo *)element;
52 #endif
53 - (RetainPtr<NSArray>)actionSheetAssistant:(WKActionSheetAssistant *)assistant decideActionsForElement:(_WKActivatedElementInfo *)element defaultActions:(RetainPtr<NSArray>)defaultActions;
54
55 @optional
56 - (BOOL)actionSheetAssistant:(WKActionSheetAssistant *)assistant showCustomSheetForElement:(_WKActivatedElementInfo *)element;
57 - (void)updatePositionInformationForActionSheetAssistant:(WKActionSheetAssistant *)assistant;
58 - (CGRect)unoccludedWindowBoundsForActionSheetAssistant:(WKActionSheetAssistant *)assistant;
59 - (void)actionSheetAssistant:(WKActionSheetAssistant *)assistant willStartInteractionWithElement:(_WKActivatedElementInfo *)element;
60 - (void)actionSheetAssistantDidStopInteraction:(WKActionSheetAssistant *)assistant;
61 - (NSDictionary *)dataDetectionContextForActionSheetAssistant:(WKActionSheetAssistant *)assistant;
62 - (NSString *)selectedTextForActionSheetAssistant:(WKActionSheetAssistant *)assistant;
63 - (void)actionSheetAssistant:(WKActionSheetAssistant *)assistant getAlternateURLForImage:(UIImage *)image completion:(void (^)(NSURL *alternateURL, NSDictionary *userInfo))completion;
64
65 @end
66
67 #if ENABLE(DATA_DETECTION)
68 @interface WKActionSheetAssistant : NSObject <WKActionSheetDelegate, DDDetectionControllerInteractionDelegate>
69 #else
70 @interface WKActionSheetAssistant : NSObject <WKActionSheetDelegate>
71 #endif
72 @property (nonatomic, weak) id <WKActionSheetAssistantDelegate> delegate;
73 @property (nonatomic) BOOL needsLinkIndicator;
74 - (id)initWithView:(UIView *)view;
75 - (void)showLinkSheet;
76 - (void)showImageSheet;
77 - (void)showDataDetectorsSheet;
78 - (void)cleanupSheet;
79 - (void)updateSheetPosition;
80 - (RetainPtr<NSArray<_WKElementAction *>>)defaultActionsForLinkSheet:(_WKActivatedElementInfo *)elementInfo;
81 - (RetainPtr<NSArray<_WKElementAction *>>)defaultActionsForImageSheet:(_WKActivatedElementInfo *)elementInfo;
82 - (BOOL)isShowingSheet;
83 - (void)interactionDidStartWithPositionInformation:(const WebKit::InteractionInformationAtPosition&)information;
84 - (NSArray *)currentAvailableActionTitles;
85 - (Optional<WebKit::InteractionInformationAtPosition>)currentPositionInformation;
86 @end
87
88 #endif // PLATFORM(IOS_FAMILY)