WebKitTestRunner needs to support accessibility-related DRT APIs
[WebKit-https.git] / Tools / WebKitTestRunner / InjectedBundle / Bindings / AccessibilityUIElement.idl
1 /*
2  * Copyright (C) 2011 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 module WTR {
27
28     interface AccessibilityUIElement {
29         boolean isEqual(in AccessibilityUIElement otherElement);
30
31         // Element access.
32         AccessibilityUIElement elementAtPoint(in int x, in int y);
33         AccessibilityUIElement childAtIndex(in unsigned long index);
34         unsigned long indexOfChild(in AccessibilityUIElement child);
35         AccessibilityUIElement linkedUIElementAtIndex(in unsigned long index);
36         AccessibilityUIElement selectedChildAtIndex(in unsigned long index);
37         void setSelectedChild(in AccessibilityUIElement element);
38         AccessibilityUIElement titleUIElement();
39         AccessibilityUIElement parentElement();
40         
41         readonly attribute DOMString role;
42         readonly attribute DOMString subrole;
43         readonly attribute DOMString roleDescription;
44         readonly attribute DOMString title;
45         readonly attribute DOMString description;
46         readonly attribute DOMString language;
47         readonly attribute DOMString helpText;
48         readonly attribute DOMString valueDescription;
49         readonly attribute DOMString url;
50         readonly attribute DOMString speak;
51         readonly attribute DOMString orientation;
52         readonly attribute int insertionPointLineNumber;
53         readonly attribute DOMString selectedTextRange;
54     
55         DOMString stringAttributeValue(in DOMString attr);
56         double numberAttributeValue(in DOMString attr);
57         AccessibilityUIElement uiElementAttributeValue(in DOMString attr);  
58         boolean boolAttributeValue(in DOMString attr);
59         boolean isAttributeSupported(in DOMString attr);
60         boolean isAttributeSettable(in DOMString attr);
61         boolean isActionSupported(in DOMString attr);
62
63         readonly attribute DOMString stringValue;
64         readonly attribute int intValue;
65         readonly attribute int minValue;
66         readonly attribute int maxValue;
67         
68         readonly attribute boolean isEnabled;
69         readonly attribute boolean isRequired;
70         readonly attribute boolean isFocused;
71         readonly attribute boolean isSelected;
72         readonly attribute boolean isMultiSelectable;
73         readonly attribute boolean isExpanded;
74         readonly attribute boolean isChecked;
75         readonly attribute boolean isVisible;
76         readonly attribute boolean isCollapsed;
77         readonly attribute boolean hasPopup;
78         readonly attribute boolean isIgnored;
79         readonly attribute boolean isOffScreen;
80         readonly attribute boolean isValid;
81         readonly attribute int hierarchicalLevel;
82         readonly attribute boolean ariaIsGrabbed;
83         readonly attribute DOMString ariaDropEffects;
84         
85         readonly attribute int x;
86         readonly attribute int y;
87         readonly attribute int width;
88         readonly attribute int height;
89         readonly attribute int clickPointX;
90         readonly attribute int clickPointY;
91
92         readonly attribute int childrenCount;
93         readonly attribute int selectedChildrenCount;
94         readonly attribute int rowCount;
95         readonly attribute int columnCount;
96
97         // Actions.
98         void increment();
99         void decrement();
100         void press();
101         void showMenu();
102
103         // Attribute info.
104         DOMString allAttributes();
105         DOMString attributesOfChildren();
106         DOMString attributesOfLinkedUIElements();
107         DOMString attributesOfDocumentLinks();
108         
109         // Table info.
110         DOMString attributesOfColumnHeaders();
111         DOMString attributesOfRowHeaders();
112         DOMString attributesOfColumns();
113         DOMString attributesOfRows();
114         DOMString attributesOfVisibleCells();
115         DOMString attributesOfHeader();
116         AccessibilityUIElement cellForColumnAndRow(in unsigned long column, in unsigned long row);
117         AccessibilityUIElement selectedRowAtIndex(in unsigned long index);
118         AccessibilityUIElement disclosedByRow();
119         AccessibilityUIElement disclosedRowAtIndex(in unsigned long index);
120         int indexInTable();
121         DOMString rowIndexRange();
122         DOMString columnIndexRange();
123         int rowCount();
124         int columnCount();
125     
126         AccessibilityUIElement ariaOwnsElementAtIndex(in unsigned long index);
127         AccessibilityUIElement ariaFlowToElementAtIndex(in unsigned long index);
128
129         // Paramaterized attributes.
130         DOMString parameterizedAttributeNames();
131         int lineForIndex(in int index);
132         DOMString rangeForLine(in int index);
133         DOMString boundsForRange(in unsigned long location, in unsigned long length);
134         DOMString stringForRange(in unsigned long location, in unsigned long length);
135         DOMString attributedStringForRange(in unsigned long location, in unsigned long length);
136         boolean attributedStringRangeIsMisspelled(in unsigned long location, in unsigned long length);
137         AccessibilityUIElement uiElementForSearchPredicate(in AccessibilityUIElement startElement, in boolean isDirectionNext, in DOMString searchKey, in DOMString searchText);
138         void setSelectedTextRange(in unsigned long location, in unsigned long length);
139
140         // Scroll area attributes.
141         readonly attribute AccessibilityUIElement horizontalScrollbar;
142         readonly attribute AccessibilityUIElement verticalScrollbar;
143
144         // Text markers.
145         AccessibilityTextMarkerRange textMarkerRangeForElement(in AccessibilityUIElement element);    
146         AccessibilityTextMarkerRange textMarkerRangeForMarkers(in AccessibilityTextMarker startMarker, in AccessibilityTextMarker endMarker);
147         AccessibilityTextMarker startTextMarkerForTextMarkerRange(in AccessibilityTextMarkerRange range);
148         AccessibilityTextMarker endTextMarkerForTextMarkerRange(in AccessibilityTextMarkerRange range);
149         AccessibilityTextMarker textMarkerForPoint(in int x, in int y);
150         AccessibilityTextMarker previousTextMarker(in AccessibilityTextMarker marker);
151         AccessibilityTextMarker nextTextMarker(in AccessibilityTextMarker marker);
152         AccessibilityUIElement accessibilityElementForTextMarker(in AccessibilityTextMarker marker);
153         DOMString stringForTextMarkerRange(in AccessibilityTextMarkerRange range);
154         int textMarkerRangeLength(in AccessibilityTextMarkerRange range);
155
156         // Notification support.
157         boolean addNotificationListener(in object callbackFunction);
158         boolean removeNotificationListener();
159         
160     };
161
162 }