d90efa6fbc96bff187ca9973137eff99feeb7791
[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     void ensurePositionInformationIsUpToDateAt(long x, long y, object callback);
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. Points are in "global" (WKWebView) coordinates.
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 singleTapAtPointWithModifiers(long x, long y, object modifierArray, object callback);
60     void doubleTapAtPoint(long x, long y, object callback);
61     void dragFromPointToPoint(long startX, long startY, long endX, long endY, double durationSeconds, object callback);
62
63     void longPressAtPoint(long x, long y, object callback);
64
65     void stylusDownAtPoint(long x, long y, float azimuthAngle, float altitudeAngle, float pressure, object callback);
66     void stylusMoveToPoint(long x, long y, float azimuthAngle, float altitudeAngle, float pressure, object callback);
67     void stylusUpAtPoint(long x, long y, object callback);
68     void stylusTapAtPoint(long x, long y, float azimuthAngle, float altitudeAngle, float pressure, object callback);
69     void stylusTapAtPointWithModifiers(long x, long y, float azimuthAngle, float altitudeAngle, float pressure, object modifierArray, object callback);
70
71     void enterText(DOMString text);
72     void typeCharacterUsingHardwareKeyboard(DOMString character, object callback);
73
74     void keyDown(DOMString character, object modifierArray);
75     void toggleCapsLock(object callback);
76
77     // eventsJSON describes a series of user events in JSON form. For the keys, see HIDEventGenerator.mm.
78     // For example, this JSON describes a touch down followed by a touch up (i.e. a single tap).
79     //  {
80     //      "events" : [
81     //          {
82     //              "inputType" : "hand",
83     //              "timeOffset" : 0,
84     //              "coordinateSpace" : "content",
85     //              "touches" : [
86     //                  {
87     //                      "inputType" : "finger",
88     //                      "phase" : "began",
89     //                      "id" : 1,
90     //                      "x" : 100,
91     //                      "y" : 120
92     //                  }
93     //              ]
94     //          },
95     //          // This is a basic force press
96     //          {
97     //              "interpolate" : "linear",
98     //              "timestep" : 0.025,
99     //              "coordinateSpace" : "global",
100     //              "startEvent" : {
101     //                  "inputType" : "hand",
102     //                  "timeOffset" : 0.025,
103     //                  "touches" : [
104     //                      {
105     //                          "inputType" : "finger",
106     //                          "phase" : "began",
107     //                          "id" : 1,
108     //                          "x" : 100,
109     //                          "y" : 120,
110     //                          "pressure" : 0
111     //                      }
112     //                  ]
113     //              },
114     //              "endEvent" : {
115     //                  "inputType" : "hand",
116     //                  "timeOffset" : 3.0,
117     //                  "touches" : [
118     //                      {
119     //                          "inputType" : "finger",
120     //                          "phase" : "stationary",
121     //                          "id" : 1,
122     //                          "x" : 100,
123     //                          "y" : 120,
124     //                          "pressure" : 500
125     //                      }
126     //                  ]
127     //              }
128     //          },
129     //          //This is a basic drag
130     //          {
131     //              "interpolate" : "linear",
132     //              "timestep" : 0.025,
133     //              "coordinateSpace" : "content",
134     //              "startEvent" : {
135     //                  "inputType" : "hand",
136     //                  "timeOffset" : 3.025,
137     //                  "touches" : [
138     //                      {
139     //                          "inputType" : "finger",
140     //                          "phase" : "moved",
141     //                          "id" : 1,
142     //                          "x" : 100,
143     //                          "y" : 120,
144     //                          "pressure" : 0
145     //                      }
146     //                  ]
147     //              },
148     //              "endEvent" : {
149     //                  "inputType" : "hand",
150     //                  "timeOffset" : 4.0,
151     //                  "touches" : [
152     //                      {
153     //                          "inputType" : "finger",
154     //                          "phase" : "moved",
155     //                          "id" : 1,
156     //                          "x" : 20,
157     //                          "y" : 40,
158     //                          "pressure" : 0
159     //                      }
160     //                  ]
161     //              }
162     //          },
163     //          //ending lift
164     //          {
165     //              "inputType" : "hand",
166     //              "timeOffset" : 4.025, // seconds relative to the first event
167     //              "coordinateSpace" : "content",
168     //              "touches" : [
169     //                  {
170     //                      "inputType" : "finger",
171     //                      "phase" : "ended",
172     //                      "id" : 1,
173     //                      "x" : 20,
174     //                      "y" : 40
175     //                  }
176     //              ]
177     //          },
178     //      ]
179     //  }
180     void sendEventStream(DOMString eventsJSON, object callback);
181
182     void beginBackSwipe(object callback);
183     void completeBackSwipe(object callback);
184
185     void playBackEventStream(DOMString eventStream, object callback);
186
187     // Equivalent of pressing the Done button in the form accessory bar.
188     void dismissFormAccessoryView();
189
190     void dismissFilePicker(object callback);
191
192     readonly attribute DOMString textContentType;
193
194     // Form control handling
195     attribute object didStartFormControlInteractionCallback;
196     attribute object didEndFormControlInteractionCallback;
197
198     // Force press preview handling
199     attribute object didShowForcePressPreviewCallback;
200     attribute object didDismissForcePressPreviewCallback;
201
202     // <select> picker
203     void selectFormAccessoryPickerRow(long rowIndex);
204     readonly attribute DOMString selectFormPopoverTitle;
205     readonly attribute DOMString formInputLabel;
206
207     void setTimePickerValue(long hour, long minute);
208
209     // Share sheet
210     void setShareSheetCompletesImmediatelyWithResolution(boolean resolved);
211
212     // <datalist>
213     readonly attribute boolean isShowingDataListSuggestions;
214
215     void keyboardAccessoryBarNext();
216     void keyboardAccessoryBarPrevious();
217
218     void applyAutocorrection(DOMString newString, DOMString oldString, object callback);
219
220     // Returned object is a dictionary with the passed in string as a key for returned object
221     object contentsOfUserInterfaceItem(DOMString interfaceItem);
222
223     // These callbacks also work for the form accessory views.
224     attribute object didShowKeyboardCallback;
225     attribute object didHideKeyboardCallback;
226     readonly attribute boolean isShowingKeyboard;
227     readonly attribute boolean hasInputSession;
228
229     attribute object didShowMenuCallback;
230     attribute object didHideMenuCallback;
231     readonly attribute boolean isDismissingMenu;
232     readonly attribute boolean isShowingMenu;
233     readonly attribute object menuRect;
234     object rectForMenuAction(DOMString action);
235
236     readonly attribute boolean isShowingPopover;
237     attribute object willPresentPopoverCallback;
238     attribute object didDismissPopoverCallback;
239
240     attribute object willBeginZoomingCallback;
241     attribute object didEndZoomingCallback;
242
243     attribute object willCreateNewPageCallback;
244
245     void zoomToScale(double scale, object callback);
246
247     void setViewScale(double scale);
248     void setMinimumEffectiveWidth(double effectiveWidth);
249     void setAllowsViewportShrinkToFit(boolean allows);
250
251     void becomeFirstResponder();
252     void resignFirstResponder();
253     readonly attribute boolean isPresentingModally;
254
255     readonly attribute double contentOffsetX;
256     readonly attribute double contentOffsetY;
257
258     attribute boolean scrollUpdatesDisabled; // Turns off notifications back to the web process after scrolls (used for testing scrolling tree).
259
260     void scrollToOffset(long x, long y); // Initiate an animated scroll in the UI process.
261     attribute object didEndScrollingCallback;
262
263     void immediateScrollToOffset(long x, long y); // Set the scroll position in the UI process without animation.
264     void immediateZoomToScale(double scale); // Set the zoom scale in the UI process without animation.
265
266     // Find the scroller for the given point in content ("absolute") coordinates, and do an immediate scroll.
267     void immediateScrollElementAtContentPointToOffset(long x, long y, long xOffset, long yOffset);
268
269     // View state
270     readonly attribute double zoomScale;
271     readonly attribute double minimumZoomScale;
272     readonly attribute double maximumZoomScale;
273
274     // Overides the "in stable state" behavior of WKWebView (only applies to iOS)
275     // When false, content rect updates to the web process have inStableState=false, as if a scroll or zoom were in progress.
276     attribute boolean? stableStateOverride;
277
278     readonly attribute object contentVisibleRect; // Returned object has 'left', 'top', 'width', 'height' properties.
279
280     readonly attribute object textSelectionRangeRects; // An array of objects with 'left', 'top', 'width', and 'height' properties.
281     readonly attribute object textSelectionCaretRect; // An object with 'left', 'top', 'width', 'height' properties.
282     readonly attribute object selectionStartGrabberViewRect;
283     readonly attribute object selectionEndGrabberViewRect;
284     readonly attribute object selectionCaretViewRect;
285     readonly attribute object selectionRangeViewRects;
286     readonly attribute object calendarType;
287     void setDefaultCalendarType(DOMString calendarIdentifier);
288     readonly attribute object inputViewBounds;
289
290     void setKeyboardInputModeIdentifier(DOMString identifier);
291
292     void replaceTextAtRange(DOMString text, long location, long length);
293     void removeAllDynamicDictionaries();
294
295     readonly attribute DOMString scrollingTreeAsText;
296
297     object propertiesOfLayerWithID(unsigned long long layerID);
298
299     void retrieveSpeakSelectionContent(object callback);
300     readonly attribute DOMString accessibilitySpeakSelectionContent;
301     
302     void simulateRotation(DeviceOrientation orientation, object callback);
303     void simulateRotationLikeSafari(DeviceOrientation orientation, object callback);
304
305     void findString(DOMString string, unsigned long options, unsigned long maxCount);
306
307     // Unparent and parent the web view, simulating, for example, tab switching.
308     void removeViewFromWindow(object callback);
309     void addViewToWindow(object callback);
310
311     void overridePreference(DOMString preference, DOMString value);
312
313     void setSafeAreaInsets(double top, double right, double bottom, double left);
314
315     void firstResponderSuppressionForWebView(boolean shouldSuppress);
316     void makeWindowContentViewFirstResponder();
317     readonly attribute boolean isWindowContentViewFirstResponder;
318
319     void setHardwareKeyboardAttached(boolean attached);
320
321     object attachmentInfo(DOMString attachmentIdentifier);
322
323     // Editing
324     void drawSquareInEditableImage();
325     readonly attribute long numberOfStrokesInEditableImage;
326     readonly attribute DOMString lastUndoLabel;
327     readonly attribute DOMString firstRedoLabel;
328 };