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