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