Make it possible to test non-stable-state scrolling on iOS
[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     //              "touches" : [
63     //                  {
64     //                      "inputType" : "finger",
65     //                      "phase" : "began",
66     //                      "id" : 1,
67     //                      "x" : 100,
68     //                      "y" : 120
69     //                  }
70     //              ]
71     //          },
72     //          {
73     //              "interpolate" : "linear",
74     //              "timestep" : 0.025,
75     //              "startEvent" : {
76     //                  "inputType" : "hand",
77     //                  "timeOffset" : 0.025,
78     //                  "touches" : [
79     //                      {
80     //                          "inputType" : "finger",
81     //                          "phase" : "began",
82     //                          "id" : 1,
83     //                          "x" : 100,
84     //                          "y" : 120,
85     //                          "pressure" : 0
86     //                      }
87     //                  ]
88     //              },
89     //              "endEvent" : {
90     //                  "inputType" : "hand",
91     //                  "timeOffset" : 3.0,
92     //                  "touches" : [
93     //                      {
94     //                          "inputType" : "finger",
95     //                          "phase" : "stationary",
96     //                          "id" : 1,
97     //                          "x" : 20,
98     //                          "y" : 40,
99     //                          "pressure" : 500
100     //                      }
101     //                  ]
102     //              }
103     //          },
104     //          {
105     //              "inputType" : "hand",
106     //              "timeOffset" : 0.002, // seconds relative to the first event
107     //              "touches" : [
108     //                  {
109     //                      "inputType" : "finger",
110     //                      "phase" : "ended",
111     //                      "id" : 1,
112     //                      "x" : 100,
113     //                      "y" : 120
114     //                  }
115     //              ]
116     //          },
117     //      ]
118     //  }
119     void sendEventStream(DOMString eventsJSON, object callback);
120
121     // Equivalent of pressing the Done button in the form accessory bar.
122     void dismissFormAccessoryView();
123
124     // Form control handling
125     attribute object didStartFormControlInteractionCallback;
126     attribute object didEndFormControlInteractionCallback;
127
128     // Force press preview handling
129     attribute object didShowForcePressPreviewCallback;
130     attribute object didDismissForcePressPreviewCallback;
131
132     // <select> picker
133     void selectFormAccessoryPickerRow(long rowIndex);
134
135     void keyboardAccessoryBarNext();
136     void keyboardAccessoryBarPrevious();
137
138     // Returned object is a dictionary with the passed in string as a key for returned object
139     object contentsOfUserInterfaceItem(DOMString interfaceItem);
140
141     // These callbacks also work for the form accessory views.
142     attribute object didShowKeyboardCallback;
143     attribute object didHideKeyboardCallback;
144
145     attribute object willBeginZoomingCallback;
146     attribute object didEndZoomingCallback;
147
148     void zoomToScale(double scale, object callback);
149
150     void scrollToOffset(long x, long y); // Initiate an animated scroll in the UI process.
151     attribute object didEndScrollingCallback;
152
153     void immediateScrollToOffset(long x, long y); // Set the scroll position in the UI process without animation.
154     void immediateZoomToScale(double scale); // Set the zoom scale in the UI process without animation.
155
156     // View state
157     readonly attribute double zoomScale;
158     readonly attribute double minimumZoomScale;
159     readonly attribute double maximumZoomScale;
160
161     // Overides the "in stable state" behavior of WKWebView (only applies to iOS)
162     // When false, content rect updates to the web process have inStableState=false, as if a scroll or zoom were in progress.
163     attribute boolean? stableStateOverride;
164
165     readonly attribute object contentVisibleRect; // Returned object has 'left', 'top', 'width', 'height' properties.
166
167     readonly attribute object selectionRangeViewRects; // An array of objects with 'left', 'top', 'width', and 'height' properties.
168
169     void insertText(DOMString text, long location, long length);
170     void removeAllDynamicDictionaries();
171
172     readonly attribute DOMString scrollingTreeAsText;
173
174     void uiScriptComplete(DOMString result);
175 };