Implement Data Detectors immediate actions for WebKit2
[WebKit-https.git] / Source / WebKit2 / UIProcess / mac / WKImmediateActionController.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 #ifndef WKImmediateActionController_h
27 #define WKImmediateActionController_h
28
29 #if PLATFORM(MAC) && __MAC_OS_X_VERSION_MIN_REQUIRED >= 101000
30
31 #import "ActionMenuHitTestResult.h"
32 #import "WKImmediateActionTypes.h"
33 #import <WebCore/NSImmediateActionGestureRecognizerSPI.h>
34 #import <wtf/RetainPtr.h>
35
36 namespace WebKit {
37 class WebPageProxy;
38
39 enum class ImmediateActionState {
40     None = 0,
41     Pending,
42     TimedOut,
43     Ready
44 };
45 }
46
47 @class DDActionContext;
48 @class WKPagePreviewViewController;
49 @class WKView;
50
51 @interface WKImmediateActionController : NSObject <NSImmediateActionGestureRecognizerDelegate> {
52 @private
53     WebKit::WebPageProxy *_page;
54     WKView *_wkView;
55
56     WebKit::ImmediateActionState _state;
57     WebKit::ActionMenuHitTestResult _hitTestResult;
58     RefPtr<API::Object> _userData;
59     _WKImmediateActionType _type;
60     NSImmediateActionGestureRecognizer *_immediateActionRecognizer;
61
62     NSPoint _eventLocationInView;
63
64     BOOL _hasActivatedActionContext;
65     RetainPtr<DDActionContext> _currentActionContext;
66
67 #if WK_API_ENABLED
68     RetainPtr<NSPopover> _previewPopover;
69     String _previewPopoverOriginalURL;
70     NSRect _popoverOriginRect;
71     RetainPtr<WKPagePreviewViewController> _previewViewController;
72 #endif
73 }
74
75 - (instancetype)initWithPage:(WebKit::WebPageProxy&)page view:(WKView *)wkView recognizer:(NSImmediateActionGestureRecognizer *)immediateActionRecognizer;
76 - (void)willDestroyView:(WKView *)view;
77 - (void)didPerformActionMenuHitTest:(const WebKit::ActionMenuHitTestResult&)hitTestResult userData:(API::Object*)userData;
78 - (void)wkView:(WKView *)wkView willHandleMouseDown:(NSEvent *)event;
79
80 #if WK_API_ENABLED
81 - (void)setPreviewTitle:(NSString *)previewTitle;
82 - (void)hidePreview;
83 #endif // WK_API_ENABLED
84
85 @end
86
87 #endif // PLATFORM(MAC) && __MAC_OS_X_VERSION_MIN_REQUIRED >= 101000
88
89 #endif // WKImmediateActionController_h