[iOS] Shift + Tab does not focus previous field
[WebKit-https.git] / Tools / TestRunnerShared / UIScriptContext / Bindings / UIScriptController.idl
1 /*
2  * Copyright (C) 2015-2018 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 enum DeviceOrientation {
27     "portrait",
28     "portrait-upsidedown",
29     "landscape-left",
30     "landscape-right"
31 };
32
33 enum ModifierKey {
34     "alt",
35     "capsLock",
36     "ctrl",
37     "meta", // Command key on Mac and iOS
38     "shift"
39 };
40
41 interface UIScriptController {
42
43     void doAsyncTask(object callback); // Used to test the harness.
44     void uiScriptComplete(DOMString result);
45
46     void doAfterPresentationUpdate(object callback); // Call the callback after sending a message to the WebProcess and receiving a subsequent update.
47     void doAfterNextStablePresentationUpdate(object callback);
48
49     void doAfterVisibleContentRectUpdate(object callback);
50
51     void simulateAccessibilitySettingsChangeNotification(object callback);
52
53     // Interaction.
54     // These functions post events asynchronously. The callback is fired when the events have been dispatched, but any
55     // resulting behavior may also be asynchronous.
56     void touchDownAtPoint(long x, long y, long touchCount, object callback);
57     void liftUpAtPoint(long x, long y, long touchCount, object callback);
58     void singleTapAtPoint(long x, long y, object callback);
59     void doubleTapAtPoint(long x, long y, object callback);
60     void dragFromPointToPoint(long startX, long startY, long endX, long endY, double durationSeconds, object callback);
61
62     void longPressAtPoint(long x, long y, object callback);
63
64     void stylusDownAtPoint(long x, long y, float azimuthAngle, float altitudeAngle, float pressure, object callback);
65     void stylusMoveToPoint(long x, long y, float azimuthAngle, float altitudeAngle, float pressure, object callback);
66     void stylusUpAtPoint(long x, long y, object callback);
67     void stylusTapAtPoint(long x, long y, float azimuthAngle, float altitudeAngle, float pressure, object callback);
68
69     void enterText(DOMString text);
70     void typeCharacterUsingHardwareKeyboard(DOMString character, object callback);
71
72     void keyDown(DOMString character, object modifierArray);
73
74     // eventsJSON describes a series of user events in JSON form. For the keys, see HIDEventGenerator.mm.
75     // For example, this JSON describes a touch down followed by a touch up (i.e. a single tap).
76     //  {
77     //      "events" : [
78     //          {
79     //              "inputType" : "hand",
80     //              "timeOffset" : 0,
81     //              "coordinateSpace" : "content",
82     //              "touches" : [
83     //                  {
84     //                      "inputType" : "finger",
85     //                      "phase" : "began",
86     //                      "id" : 1,
87     //                      "x" : 100,
88     //                      "y" : 120
89     //                  }
90     //              ]
91     //          },
92     //          // This is a basic force press
93     //          {
94     //              "interpolate" : "linear",
95     //              "timestep" : 0.025,
96     //              "coordinateSpace" : "global",
97     //              "startEvent" : {
98     //                  "inputType" : "hand",
99     //                  "timeOffset" : 0.025,
100     //                  "touches" : [
101     //                      {
102     //                          "inputType" : "finger",
103     //                          "phase" : "began",
104     //                          "id" : 1,
105     //                          "x" : 100,
106     //                          "y" : 120,
107     //                          "pressure" : 0
108     //                      }
109     //                  ]
110     //              },
111     //              "endEvent" : {
112     //                  "inputType" : "hand",
113     //                  "timeOffset" : 3.0,
114     //                  "touches" : [
115     //                      {
116     //                          "inputType" : "finger",
117     //                          "phase" : "stationary",
118     //                          "id" : 1,
119     //                          "x" : 100,
120     //                          "y" : 120,
121     //                          "pressure" : 500
122     //                      }
123     //                  ]
124     //              }
125     //          },
126     //          //This is a basic drag
127     //          {
128     //              "interpolate" : "linear",
129     //              "timestep" : 0.025,
130     //              "coordinateSpace" : "content",
131     //              "startEvent" : {
132     //                  "inputType" : "hand",
133     //                  "timeOffset" : 3.025,
134     //                  "touches" : [
135     //                      {
136     //                          "inputType" : "finger",
137     //                          "phase" : "moved",
138     //                          "id" : 1,
139     //                          "x" : 100,
140     //                          "y" : 120,
141     //                          "pressure" : 0
142     //                      }
143     //                  ]
144     //              },
145     //              "endEvent" : {
146     //                  "inputType" : "hand",
147     //                  "timeOffset" : 4.0,
148     //                  "touches" : [
149     //                      {
150     //                          "inputType" : "finger",
151     //                          "phase" : "moved",
152     //                          "id" : 1,
153     //                          "x" : 20,
154     //                          "y" : 40,
155     //                          "pressure" : 0
156     //                      }
157     //                  ]
158     //              }
159     //          },
160     //          //ending lift
161     //          {
162     //              "inputType" : "hand",
163     //              "timeOffset" : 4.025, // seconds relative to the first event
164     //              "coordinateSpace" : "content",
165     //              "touches" : [
166     //                  {
167     //                      "inputType" : "finger",
168     //                      "phase" : "ended",
169     //                      "id" : 1,
170     //                      "x" : 20,
171     //                      "y" : 40
172     //                  }
173     //              ]
174     //          },
175     //      ]
176     //  }
177     void sendEventStream(DOMString eventsJSON, object callback);
178
179     void beginBackSwipe(object callback);
180     void completeBackSwipe(object callback);
181
182     void playBackEventStream(DOMString eventStream, object callback);
183
184     // Equivalent of pressing the Done button in the form accessory bar.
185     void dismissFormAccessoryView();
186
187     readonly attribute DOMString textContentType;
188
189     // Form control handling
190     attribute object didStartFormControlInteractionCallback;
191     attribute object didEndFormControlInteractionCallback;
192
193     // Force press preview handling
194     attribute object didShowForcePressPreviewCallback;
195     attribute object didDismissForcePressPreviewCallback;
196
197     // <select> picker
198     void selectFormAccessoryPickerRow(long rowIndex);
199     readonly attribute DOMString selectFormPopoverTitle;
200     readonly attribute DOMString formInputLabel;
201
202     void setTimePickerValue(long hour, long minute);
203
204     // Share sheet
205     void setShareSheetCompletesImmediatelyWithResolution(boolean resolved);
206
207     // <datalist>
208     readonly attribute boolean isShowingDataListSuggestions;
209
210     void keyboardAccessoryBarNext();
211     void keyboardAccessoryBarPrevious();
212
213     void applyAutocorrection(DOMString newString, DOMString oldString, object callback);
214
215     // Returned object is a dictionary with the passed in string as a key for returned object
216     object contentsOfUserInterfaceItem(DOMString interfaceItem);
217
218     // These callbacks also work for the form accessory views.
219     attribute object didShowKeyboardCallback;
220     attribute object didHideKeyboardCallback;
221     readonly attribute boolean isShowingKeyboard;
222
223     attribute object willBeginZoomingCallback;
224     attribute object didEndZoomingCallback;
225
226     void zoomToScale(double scale, object callback);
227
228     void setViewScale(double scale);
229
230     void resignFirstResponder();
231
232     void scrollToOffset(long x, long y); // Initiate an animated scroll in the UI process.
233     attribute object didEndScrollingCallback;
234
235     void immediateScrollToOffset(long x, long y); // Set the scroll position in the UI process without animation.
236     void immediateZoomToScale(double scale); // Set the zoom scale in the UI process without animation.
237
238     // View state
239     readonly attribute double zoomScale;
240     readonly attribute double minimumZoomScale;
241     readonly attribute double maximumZoomScale;
242
243     // Overides the "in stable state" behavior of WKWebView (only applies to iOS)
244     // When false, content rect updates to the web process have inStableState=false, as if a scroll or zoom were in progress.
245     attribute boolean? stableStateOverride;
246
247     readonly attribute object contentVisibleRect; // Returned object has 'left', 'top', 'width', 'height' properties.
248
249     readonly attribute object textSelectionRangeRects; // An array of objects with 'left', 'top', 'width', and 'height' properties.
250     readonly attribute object textSelectionCaretRect; // An object with 'left', 'top', 'width', 'height' properties.
251     readonly attribute object selectionStartGrabberViewRect;
252     readonly attribute object selectionEndGrabberViewRect;
253     readonly attribute object selectionCaretViewRect;
254     readonly attribute object selectionRangeViewRects;
255     readonly attribute object calendarType;
256     void setDefaultCalendarType(DOMString calendarIdentifier);
257     readonly attribute object inputViewBounds;
258
259     void replaceTextAtRange(DOMString text, long location, long length);
260     void removeAllDynamicDictionaries();
261
262     readonly attribute DOMString scrollingTreeAsText;
263
264     object propertiesOfLayerWithID(unsigned long long layerID);
265
266     void retrieveSpeakSelectionContent(object callback);
267     readonly attribute DOMString accessibilitySpeakSelectionContent;
268     
269     void simulateRotation(DeviceOrientation orientation, object callback);
270     void simulateRotationLikeSafari(DeviceOrientation orientation, object callback);
271
272     void findString(DOMString string, unsigned long options, unsigned long maxCount);
273
274     // Unparent and parent the web view, simulating, for example, tab switching.
275     void removeViewFromWindow(object callback);
276     void addViewToWindow(object callback);
277
278     void overridePreference(DOMString preference, DOMString value);
279
280     void setSafeAreaInsets(double top, double right, double bottom, double left);
281
282     void firstResponderSuppressionForWebView(boolean shouldSuppress);
283     void makeWindowContentViewFirstResponder();
284     readonly attribute boolean isWindowContentViewFirstResponder;
285
286     void drawSquareInEditableImage();
287     readonly attribute long numberOfStrokesInEditableImage;
288 };