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