daa29a0910bdb27ad1b65b7592212ed49c37df4a
[WebKit-https.git] / Tools / TestWebKitAPI / ios / UIKitSPI.h
1 /*
2  * Copyright (C) 2017 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 <UIKit/UITextInputTraits.h>
29
30 #if USE(APPLE_INTERNAL_SDK)
31
32 #import <UIKit/UIApplication_Private.h>
33 #import <UIKit/UIKeyboard_Private.h>
34 #import <UIKit/UIResponder_Private.h>
35 #import <UIKit/UITextInputMultiDocument.h>
36 #import <UIKit/UITextInputTraits_Private.h>
37 #import <UIKit/UITextInput_Private.h>
38 #import <UIKit/UIViewController_Private.h>
39
40 #if ENABLE(DRAG_SUPPORT)
41 @protocol UIDragSession;
42 @class UIDragInteraction;
43 @class UIDragItem;
44 #import <UIKit/NSItemProvider+UIKitAdditions_Private.h>
45 #import <UIKit/UIDragInteraction_Private.h>
46 #endif // ENABLE(DRAG_SUPPORT)
47
48 #else
49
50 WTF_EXTERN_C_BEGIN
51
52 void UIApplicationInitialize(void);
53
54 WTF_EXTERN_C_END
55
56 @interface UITextSuggestion : NSObject
57
58 @end
59
60 @interface UITextInputTraits : NSObject <UITextInputTraits>
61 @end
62
63 @protocol UIDragInteractionDelegate_ForWebKitOnly <UIDragInteractionDelegate>
64 @optional
65 - (void)_dragInteraction:(UIDragInteraction *)interaction prepareForSession:(id<UIDragSession>)session completion:(void(^)(void))completion;
66 @end
67
68 @protocol UITextInputTraits_Private <NSObject, UITextInputTraits>
69 @property (nonatomic, readonly) UIColor *insertionPointColor;
70 @end
71
72 @class WebEvent;
73
74 @protocol UITextInputPrivate <UITextInput, UITextInputTraits_Private>
75 - (UITextInputTraits *)textInputTraits;
76 - (void)insertTextSuggestion:(UITextSuggestion *)textSuggestion;
77 - (void)handleKeyWebEvent:(WebEvent *)theEvent withCompletionHandler:(void (^)(WebEvent *, BOOL))completionHandler;
78 - (BOOL)_shouldSuppressSelectionCommands;
79 @end
80
81 @protocol UITextInputMultiDocument <NSObject>
82 @optional
83 - (void)_preserveFocusWithToken:(id <NSCopying, NSSecureCoding>)token destructively:(BOOL)destructively;
84 - (BOOL)_restoreFocusWithToken:(id <NSCopying, NSSecureCoding>)token;
85 @end
86
87 @interface NSURL ()
88 @property (nonatomic, copy, setter=_setTitle:) NSString *_title;
89 @end
90
91 @interface UIKeyboard : UIView
92 @end
93
94 #endif
95
96 @protocol UITextInputTraits_Private_Proposed_SPI_34583628 <UITextInputPrivate>
97 - (NSDictionary *)_autofillContext;
98 @end
99
100 #if ENABLE(DRAG_SUPPORT)
101 @protocol UIDragInteractionDelegate_Proposed_SPI_33146803 <UIDragInteractionDelegate>
102 - (void)_dragInteraction:(UIDragInteraction *)interaction itemsForAddingToSession:(id <UIDragSession>)session withTouchAtPoint:(CGPoint)point completion:(void(^)(NSArray<UIDragItem *> *))completion;
103 @end
104 #endif
105
106 #if __has_include(<UIKit/UITextAutofillSuggestion.h>)
107 // FIXME: Move this import under USE(APPLE_INTERNAL_SDK) once <rdar://problem/34583628> lands in the SDK.
108 #import <UIKit/UITextAutofillSuggestion.h>
109 @interface UITextAutofillSuggestion ()
110 + (instancetype)autofillSuggestionWithUsername:(NSString *)username password:(NSString *)password;
111 @end
112 #else
113 @interface UITextAutofillSuggestion : UITextSuggestion
114 @property (nonatomic, assign) NSString *username;
115 @property (nonatomic, assign) NSString *password;
116 + (instancetype)autofillSuggestionWithUsername:(NSString *)username password:(NSString *)password;
117 @end
118 #endif
119
120 @interface NSURL (UIKitSPI)
121 @property (nonatomic, copy, setter=_setTitle:) NSString *_title;
122 @end
123
124 @interface UIViewController (UIKitSPI)
125 + (UIViewController *)_viewControllerForFullScreenPresentationFromView:(UIView *)view;
126 @end
127
128 @interface UIResponder (UIKitSPI)
129 - (UIResponder *)firstResponder;
130 - (void)makeTextWritingDirectionNatural:(id)sender;
131 @end
132
133 @interface UIKeyboard ()
134 + (BOOL)isInHardwareKeyboardMode;
135 @end
136
137 #endif // PLATFORM(IOS_FAMILY)