0ed40c02e3339a40449db115d049779b8a2a2efb
[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
30     void zoomToScale(double scale, object callback);
31
32     void simulateAccessibilitySettingsChangeNotification(object callback);
33
34     // Interaction.
35     // These functions post events asynchronously. The callback is fired when the events have been dispatched, but any
36     // resulting behavior may also be asynchronous.
37     void touchDownAtPoint(long x, long y, long touchCount, object callback);
38     void liftUpAtPoint(long x, long y, long touchCount, object callback);
39     void singleTapAtPoint(long x, long y, object callback);
40     void doubleTapAtPoint(long x, long y, object callback);
41     void dragFromPointToPoint(long startX, long startY, long endX, long endY, double durationSeconds, object callback);
42
43     void longPressAtPoint(long x, long y, object callback);
44
45     void stylusDownAtPoint(long x, long y, float azimuthAngle, float altitudeAngle, float pressure, object callback);
46     void stylusMoveToPoint(long x, long y, float azimuthAngle, float altitudeAngle, float pressure, object callback);
47     void stylusUpAtPoint(long x, long y, object callback);
48     void stylusTapAtPoint(long x, long y, float azimuthAngle, float altitudeAngle, float pressure, object callback);
49
50     void typeCharacterUsingHardwareKeyboard(DOMString character, object callback);
51     void keyDownUsingHardwareKeyboard(DOMString character, object callback);
52     void keyUpUsingHardwareKeyboard(DOMString character, object callback);
53
54     void selectTextCandidateAtIndex(long index, object callback);
55
56     // eventsJSON describes a series of user events in JSON form. For the keys, see HIDEventGenerator.mm.
57     // For example, this JSON describes a touch down followed by a touch up (i.e. a single tap).
58     //  {
59     //      "events" : [
60     //          {
61     //              "inputType" : "hand",
62     //              "timeOffset" : 0,
63     //              "touches" : [
64     //                  {
65     //                      "inputType" : "finger",
66     //                      "phase" : "began",
67     //                      "id" : 1,
68     //                      "x" : 100,
69     //                      "y" : 120
70     //                  }
71     //              ]
72     //          },
73     //          {
74     //              "interpolate" : "linear",
75     //              "timestep" : 0.025,
76     //              "startEvent" : {
77     //                  "inputType" : "hand",
78     //                  "timeOffset" : 0.025,
79     //                  "touches" : [
80     //                      {
81     //                          "inputType" : "finger",
82     //                          "phase" : "began",
83     //                          "id" : 1,
84     //                          "x" : 100,
85     //                          "y" : 120,
86     //                          "pressure" : 0
87     //                      }
88     //                  ]
89     //              },
90     //              "endEvent" : {
91     //                  "inputType" : "hand",
92     //                  "timeOffset" : 3.0,
93     //                  "touches" : [
94     //                      {
95     //                          "inputType" : "finger",
96     //                          "phase" : "stationary",
97     //                          "id" : 1,
98     //                          "x" : 20,
99     //                          "y" : 40,
100     //                          "pressure" : 500
101     //                      }
102     //                  ]
103     //              }
104     //          },
105     //          {
106     //              "inputType" : "hand",
107     //              "timeOffset" : 0.002, // seconds relative to the first event
108     //              "touches" : [
109     //                  {
110     //                      "inputType" : "finger",
111     //                      "phase" : "ended",
112     //                      "id" : 1,
113     //                      "x" : 100,
114     //                      "y" : 120
115     //                  }
116     //              ]
117     //          },
118     //      ]
119     //  }
120     void sendEventStream(DOMString eventsJSON, object callback);
121
122     // Equivalent of pressing the Done button in the form accessory bar.
123     void dismissFormAccessoryView();
124
125     // Form control handling
126     attribute object didStartFormControlInteractionCallback;
127     attribute object didEndFormControlInteractionCallback;
128
129     // Force press preview handling
130     attribute object didShowForcePressPreviewCallback;
131     attribute object didDismissForcePressPreviewCallback;
132
133     // <select> picker
134     void selectFormAccessoryPickerRow(long rowIndex);
135
136     void keyboardAccessoryBarNext();
137     void keyboardAccessoryBarPrevious();
138
139     // Returned object is a dictionary with the passed in string as a key for returned object
140     object contentsOfUserInterfaceItem(DOMString interfaceItem);
141
142     // These callbacks also work for the form accessory views.
143     attribute object didShowKeyboardCallback;
144     attribute object didHideKeyboardCallback;
145
146     attribute object willBeginZoomingCallback;
147     attribute object didEndZoomingCallback;
148
149     void scrollToOffset(long x, long y); // Initiate an animated scroll in the UI process.
150     attribute object didEndScrollingCallback;
151
152     // View state
153     readonly attribute double zoomScale;
154     readonly attribute double minimumZoomScale;
155     readonly attribute double maximumZoomScale;
156
157     readonly attribute object contentVisibleRect; // Returned object has 'left', 'top', 'width', 'height' properties.
158
159     readonly attribute object selectionRangeViewRects; // An array of objects with 'left', 'top', 'width', and 'height' properties.
160
161     void insertText(DOMString text, long location, long length);
162     void removeAllDynamicDictionaries();
163
164     readonly attribute DOMString scrollingTreeAsText;
165
166     void uiScriptComplete(DOMString result);
167 };