Add coordinate space to event streams and streamline tests
[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 interface UIScriptController {
27
28     void doAsyncTask(object callback); // Used to test the harness.
29     void doAfterPresentationUpdate(object callback); // Call the callback after sending a message to the WebProcess and receiving a subsequent update.
30
31     void simulateAccessibilitySettingsChangeNotification(object callback);
32
33     // Interaction.
34     // These functions post events asynchronously. The callback is fired when the events have been dispatched, but any
35     // resulting behavior may also be asynchronous.
36     void touchDownAtPoint(long x, long y, long touchCount, object callback);
37     void liftUpAtPoint(long x, long y, long touchCount, object callback);
38     void singleTapAtPoint(long x, long y, object callback);
39     void doubleTapAtPoint(long x, long y, object callback);
40     void dragFromPointToPoint(long startX, long startY, long endX, long endY, double durationSeconds, object callback);
41
42     void longPressAtPoint(long x, long y, object callback);
43
44     void stylusDownAtPoint(long x, long y, float azimuthAngle, float altitudeAngle, float pressure, object callback);
45     void stylusMoveToPoint(long x, long y, float azimuthAngle, float altitudeAngle, float pressure, object callback);
46     void stylusUpAtPoint(long x, long y, object callback);
47     void stylusTapAtPoint(long x, long y, float azimuthAngle, float altitudeAngle, float pressure, object callback);
48
49     void typeCharacterUsingHardwareKeyboard(DOMString character, object callback);
50     void keyDownUsingHardwareKeyboard(DOMString character, object callback);
51     void keyUpUsingHardwareKeyboard(DOMString character, object callback);
52
53     void selectTextCandidateAtIndex(long index, object callback);
54
55     // eventsJSON describes a series of user events in JSON form. For the keys, see HIDEventGenerator.mm.
56     // For example, this JSON describes a touch down followed by a touch up (i.e. a single tap).
57     //  {
58     //      "events" : [
59     //          {
60     //              "inputType" : "hand",
61     //              "timeOffset" : 0,
62     //              "coordinateSpace" : "content",
63     //              "touches" : [
64     //                  {
65     //                      "inputType" : "finger",
66     //                      "phase" : "began",
67     //                      "id" : 1,
68     //                      "x" : 100,
69     //                      "y" : 120
70     //                  }
71     //              ]
72     //          },
73     //          // This is a basic force press
74     //          {
75     //              "interpolate" : "linear",
76     //              "timestep" : 0.025,
77     //              "coordinateSpace" : "global",
78     //              "startEvent" : {
79     //                  "inputType" : "hand",
80     //                  "timeOffset" : 0.025,
81     //                  "touches" : [
82     //                      {
83     //                          "inputType" : "finger",
84     //                          "phase" : "began",
85     //                          "id" : 1,
86     //                          "x" : 100,
87     //                          "y" : 120,
88     //                          "pressure" : 0
89     //                      }
90     //                  ]
91     //              },
92     //              "endEvent" : {
93     //                  "inputType" : "hand",
94     //                  "timeOffset" : 3.0,
95     //                  "touches" : [
96     //                      {
97     //                          "inputType" : "finger",
98     //                          "phase" : "stationary",
99     //                          "id" : 1,
100     //                          "x" : 100,
101     //                          "y" : 120,
102     //                          "pressure" : 500
103     //                      }
104     //                  ]
105     //              }
106     //          },
107     //          //This is a basic drag
108     //          {
109     //              "interpolate" : "linear",
110     //              "timestep" : 0.025,
111     //              "coordinateSpace" : "content",
112     //              "startEvent" : {
113     //                  "inputType" : "hand",
114     //                  "timeOffset" : 3.025,
115     //                  "touches" : [
116     //                      {
117     //                          "inputType" : "finger",
118     //                          "phase" : "moved",
119     //                          "id" : 1,
120     //                          "x" : 100,
121     //                          "y" : 120,
122     //                          "pressure" : 0
123     //                      }
124     //                  ]
125     //              },
126     //              "endEvent" : {
127     //                  "inputType" : "hand",
128     //                  "timeOffset" : 4.0,
129     //                  "touches" : [
130     //                      {
131     //                          "inputType" : "finger",
132     //                          "phase" : "moved",
133     //                          "id" : 1,
134     //                          "x" : 20,
135     //                          "y" : 40,
136     //                          "pressure" : 0
137     //                      }
138     //                  ]
139     //              }
140     //          },
141     //          //ending lift
142     //          {
143     //              "inputType" : "hand",
144     //              "timeOffset" : 4.025, // seconds relative to the first event
145     //              "coordinateSpace" : "content",
146     //              "touches" : [
147     //                  {
148     //                      "inputType" : "finger",
149     //                      "phase" : "ended",
150     //                      "id" : 1,
151     //                      "x" : 20,
152     //                      "y" : 40
153     //                  }
154     //              ]
155     //          },
156     //      ]
157     //  }
158     void sendEventStream(DOMString eventsJSON, object callback);
159
160     // Equivalent of pressing the Done button in the form accessory bar.
161     void dismissFormAccessoryView();
162
163     // Form control handling
164     attribute object didStartFormControlInteractionCallback;
165     attribute object didEndFormControlInteractionCallback;
166
167     // Force press preview handling
168     attribute object didShowForcePressPreviewCallback;
169     attribute object didDismissForcePressPreviewCallback;
170
171     // <select> picker
172     void selectFormAccessoryPickerRow(long rowIndex);
173
174     void keyboardAccessoryBarNext();
175     void keyboardAccessoryBarPrevious();
176
177     // Returned object is a dictionary with the passed in string as a key for returned object
178     object contentsOfUserInterfaceItem(DOMString interfaceItem);
179
180     // These callbacks also work for the form accessory views.
181     attribute object didShowKeyboardCallback;
182     attribute object didHideKeyboardCallback;
183
184     attribute object willBeginZoomingCallback;
185     attribute object didEndZoomingCallback;
186
187     void zoomToScale(double scale, object callback);
188
189     void scrollToOffset(long x, long y); // Initiate an animated scroll in the UI process.
190     attribute object didEndScrollingCallback;
191
192     void immediateScrollToOffset(long x, long y); // Set the scroll position in the UI process without animation.
193     void immediateZoomToScale(double scale); // Set the zoom scale in the UI process without animation.
194
195     // View state
196     readonly attribute double zoomScale;
197     readonly attribute double minimumZoomScale;
198     readonly attribute double maximumZoomScale;
199
200     // Overides the "in stable state" behavior of WKWebView (only applies to iOS)
201     // When false, content rect updates to the web process have inStableState=false, as if a scroll or zoom were in progress.
202     attribute boolean? stableStateOverride;
203
204     readonly attribute object contentVisibleRect; // Returned object has 'left', 'top', 'width', 'height' properties.
205
206     readonly attribute object selectionRangeViewRects; // An array of objects with 'left', 'top', 'width', and 'height' properties.
207
208     void insertText(DOMString text, long location, long length);
209     void removeAllDynamicDictionaries();
210
211     readonly attribute DOMString scrollingTreeAsText;
212
213     void uiScriptComplete(DOMString result);
214 };