Expose a WKWebView API for allowing programmatic focus to trigger node assistance
[WebKit-https.git] / Source / WebKit2 / UIProcess / API / Cocoa / WKWebViewConfiguration.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 #import <WebKit/WKFoundation.h>
27
28 #if WK_API_ENABLED
29
30 #import <Foundation/Foundation.h>
31
32 WK_ASSUME_NONNULL_BEGIN
33
34 @class WKPreferences;
35 @class WKProcessPool;
36 @class WKUserContentController;
37 @class WKWebsiteDataStore;
38
39 #if TARGET_OS_IPHONE
40 /*! @enum WKSelectionGranularity
41  @abstract The granularity with which a selection can be created and modified interactively.
42  @constant WKSelectionGranularityDynamic    Selection granularity varies automatically based on the selection.
43  @constant WKSelectionGranularityCharacter  Selection endpoints can be placed at any character boundary.
44  @discussion An example of how granularity may vary when WKSelectionGranularityDynamic is used is
45  that when the selection is within a single block, the granularity may be single character, and when
46  the selection is not confined to a single block, the selection granularity may be single block.
47  */
48 typedef NS_ENUM(NSInteger, WKSelectionGranularity) {
49     WKSelectionGranularityDynamic,
50     WKSelectionGranularityCharacter,
51 } WK_ENUM_AVAILABLE_IOS(8_0);
52 #endif
53
54 /*! A WKWebViewConfiguration object is a collection of properties with
55  which to initialize a web view.
56  @helps Contains properties used to configure a @link WKWebView @/link.
57  */
58 WK_CLASS_AVAILABLE(10_10, 8_0)
59 @interface WKWebViewConfiguration : NSObject <NSCopying>
60
61 /*! @abstract The process pool from which to obtain the view's web content
62  process.
63  @discussion When a web view is initialized, a new web content process
64  will be created for it from the specified pool, or an existing process in
65  that pool will be used.
66 */
67 @property (nonatomic, strong) WKProcessPool *processPool;
68
69 /*! @abstract The preference settings to be used by the web view.
70 */
71 @property (nonatomic, strong) WKPreferences *preferences;
72
73 /*! @abstract The user content controller to associate with the web view.
74 */
75 @property (nonatomic, strong) WKUserContentController *userContentController;
76
77 /*! @abstract The website data store to be used by the web view.
78  */
79 @property (nonatomic, strong) WKWebsiteDataStore *websiteDataStore WK_AVAILABLE(10_11, 9_0);
80
81 /*! @abstract A Boolean value indicating whether the web view suppresses
82  content rendering until it is fully loaded into memory.
83  @discussion The default value is NO.
84  */
85 @property (nonatomic) BOOL suppressesIncrementalRendering;
86
87 /*! @abstract The name of the application as used in the user agent string.
88 */
89 @property (WK_NULLABLE_PROPERTY nonatomic, copy) NSString *applicationNameForUserAgent WK_AVAILABLE(10_11, 9_0);
90
91 /*! @abstract A Boolean value indicating whether AirPlay is allowed.
92  @discussion The default value is YES.
93  */
94 @property (nonatomic) BOOL allowsAirPlayForMediaPlayback WK_AVAILABLE(10_11, 9_0);
95
96 #if TARGET_OS_IPHONE
97 /*! @abstract A Boolean value indicating whether HTML5 videos play inline
98  (YES) or use the native full-screen controller (NO).
99  @discussion The default value is NO.
100  */
101 @property (nonatomic) BOOL allowsInlineMediaPlayback;
102
103 /*! @abstract A Boolean value indicating whether HTML5 videos require the
104  user to start playing them (YES) or can play automatically (NO).
105  @discussion The default value is YES.
106  */
107 @property (nonatomic) BOOL requiresUserActionForMediaPlayback WK_AVAILABLE(NA, 9_0);
108
109 /*! @abstract The level of granularity with which the user can interactively
110  select content in the web view.
111  @discussion Possible values are described in WKSelectionGranularity.
112  The default value is WKSelectionGranularityDynamic.
113  */
114 @property (nonatomic) WKSelectionGranularity selectionGranularity;
115
116 /*! @abstract A Boolean value indicating whether HTML5 videos may play
117  picture-in-picture.
118  @discussion The default value is YES.
119  */
120 @property (nonatomic) BOOL allowsPictureInPictureMediaPlayback WK_AVAILABLE(NA, 9_0);
121
122 /*! @abstract A Boolean value indicating whether programmatic focus on
123  an element is allowed to trigger assistance.
124  @discussion The default value is NO.
125  */
126 @property (nonatomic) BOOL canAssistOnProgrammaticFocus;
127
128 #endif
129
130 @end
131
132 @interface WKWebViewConfiguration (WKDeprecated)
133
134 #if TARGET_OS_IPHONE
135 @property (nonatomic) BOOL mediaPlaybackRequiresUserAction WK_DEPRECATED(NA, NA, 8_0, 9_0, "Please use requiresUserActionForMediaPlayback");
136 @property (nonatomic) BOOL mediaPlaybackAllowsAirPlay WK_DEPRECATED(NA, NA, 8_0, 9_0, "Please use allowsAirPlayForMediaPlayback");
137 #endif
138
139 @end
140
141 WK_ASSUME_NONNULL_END
142
143 #endif