5cc7a171e1425bb2500355e3f2399297b6596c19
[WebKit-https.git] / Tools / DumpRenderTree / AccessibilityUIElement.h
1 /*
2  * Copyright (C) 2008 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. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
24  */
25
26 #ifndef AccessibilityUIElement_h
27 #define AccessibilityUIElement_h
28
29 #include "AccessibilityTextMarker.h"
30 #include <JavaScriptCore/JSObjectRef.h>
31 #include <wtf/Platform.h>
32 #include <wtf/Vector.h>
33
34 #if PLATFORM(MAC)
35 #ifdef __OBJC__
36 typedef id PlatformUIElement;
37 #else
38 typedef struct objc_object* PlatformUIElement;
39 #endif
40 #elif PLATFORM(WIN)
41 #undef _WINSOCKAPI_
42 #define _WINSOCKAPI_ // Prevent inclusion of winsock.h in windows.h
43
44 #include <WebCore/COMPtr.h>
45 #include <oleacc.h>
46
47 typedef COMPtr<IAccessible> PlatformUIElement;
48 #elif PLATFORM(GTK)
49 #include <atk/atk.h>
50 typedef AtkObject* PlatformUIElement;
51 #else
52 typedef void* PlatformUIElement;
53 #endif
54
55 #if PLATFORM(MAC)
56 #ifdef __OBJC__
57 typedef id NotificationHandler;
58 #else
59 typedef struct objc_object* NotificationHandler;
60 #endif
61 #endif
62
63 class AccessibilityUIElement {
64 public:
65     AccessibilityUIElement(PlatformUIElement);
66     AccessibilityUIElement(const AccessibilityUIElement&);
67     ~AccessibilityUIElement();
68
69     PlatformUIElement platformUIElement() { return m_element; }
70
71     static JSObjectRef makeJSAccessibilityUIElement(JSContextRef, const AccessibilityUIElement&);
72
73     bool isEqual(AccessibilityUIElement* otherElement);
74
75     void getLinkedUIElements(Vector<AccessibilityUIElement>&);
76     void getDocumentLinks(Vector<AccessibilityUIElement>&);
77     void getChildren(Vector<AccessibilityUIElement>&);
78     void getChildrenWithRange(Vector<AccessibilityUIElement>&, unsigned location, unsigned length);
79     
80     AccessibilityUIElement elementAtPoint(int x, int y);
81     AccessibilityUIElement getChildAtIndex(unsigned);
82     unsigned indexOfChild(AccessibilityUIElement*);
83     int childrenCount();
84     AccessibilityUIElement titleUIElement();
85     AccessibilityUIElement parentElement();
86
87     void takeFocus();
88     void takeSelection();
89     void addSelection();
90     void removeSelection();
91
92     // Methods - platform-independent implementations
93     JSStringRef allAttributes();
94     JSStringRef attributesOfLinkedUIElements();
95     AccessibilityUIElement linkedUIElementAtIndex(unsigned);
96     
97     JSStringRef attributesOfDocumentLinks();
98     JSStringRef attributesOfChildren();
99     JSStringRef parameterizedAttributeNames();
100     void increment();
101     void decrement();
102     void showMenu();
103     void press();
104
105     // Attributes - platform-independent implementations
106     JSStringRef stringAttributeValue(JSStringRef attribute);
107     double numberAttributeValue(JSStringRef attribute);
108     bool boolAttributeValue(JSStringRef attribute);
109     bool isAttributeSupported(JSStringRef attribute);
110     bool isAttributeSettable(JSStringRef attribute);
111     bool isActionSupported(JSStringRef action);
112     JSStringRef role();
113     JSStringRef subrole();
114     JSStringRef roleDescription();
115     JSStringRef title();
116     JSStringRef description();
117     JSStringRef language();
118     JSStringRef stringValue();
119     JSStringRef accessibilityValue() const;
120     JSStringRef helpText() const;
121     JSStringRef orientation() const;
122     double x();
123     double y();
124     double width();
125     double height();
126     double intValue() const;
127     double minValue();
128     double maxValue();
129     JSStringRef valueDescription();
130     int insertionPointLineNumber();
131     JSStringRef selectedTextRange();
132     bool isEnabled();
133     bool isRequired() const;
134     
135     bool isFocused() const;
136     bool isFocusable() const;
137     bool isSelected() const;
138     bool isSelectable() const;
139     bool isMultiSelectable() const;
140     void setSelectedChild(AccessibilityUIElement*) const;
141     unsigned selectedChildrenCount() const;
142     AccessibilityUIElement selectedChildAtIndex(unsigned) const;
143     
144     bool isExpanded() const;
145     bool isChecked() const;
146     bool isVisible() const;
147     bool isOffScreen() const;
148     bool isCollapsed() const;
149     bool isIgnored() const;
150     bool hasPopup() const;
151     int hierarchicalLevel() const;
152     double clickPointX();
153     double clickPointY();
154     JSStringRef documentEncoding();
155     JSStringRef documentURI();
156     JSStringRef url();
157
158     // CSS3-speech properties.
159     JSStringRef speak();
160     
161     // Table-specific attributes
162     JSStringRef attributesOfColumnHeaders();
163     JSStringRef attributesOfRowHeaders();
164     JSStringRef attributesOfColumns();
165     JSStringRef attributesOfRows();
166     JSStringRef attributesOfVisibleCells();
167     JSStringRef attributesOfHeader();
168     int indexInTable();
169     JSStringRef rowIndexRange();
170     JSStringRef columnIndexRange();
171     int rowCount();
172     int columnCount();
173     
174     // Tree/Outline specific attributes
175     AccessibilityUIElement selectedRowAtIndex(unsigned);
176     AccessibilityUIElement disclosedByRow();
177     AccessibilityUIElement disclosedRowAtIndex(unsigned);
178
179     // ARIA specific
180     AccessibilityUIElement ariaOwnsElementAtIndex(unsigned);
181     AccessibilityUIElement ariaFlowToElementAtIndex(unsigned);
182
183     // ARIA Drag and Drop
184     bool ariaIsGrabbed() const;
185     // A space concatentated string of all the drop effects.
186     JSStringRef ariaDropEffects() const;
187     
188     // Parameterized attributes
189     int lineForIndex(int);
190     JSStringRef rangeForLine(int);
191     JSStringRef boundsForRange(unsigned location, unsigned length);
192     void setSelectedTextRange(unsigned location, unsigned length);
193     JSStringRef stringForRange(unsigned location, unsigned length);
194     JSStringRef attributedStringForRange(unsigned location, unsigned length);
195     bool attributedStringRangeIsMisspelled(unsigned location, unsigned length);
196     AccessibilityUIElement uiElementForSearchPredicate(AccessibilityUIElement* startElement, bool isDirectionNext, JSStringRef searchKey, JSStringRef searchText);
197     
198     // Table-specific
199     AccessibilityUIElement cellForColumnAndRow(unsigned column, unsigned row);
200
201     // Text markers.
202     AccessibilityTextMarkerRange textMarkerRangeForElement(AccessibilityUIElement*);    
203     AccessibilityTextMarkerRange textMarkerRangeForMarkers(AccessibilityTextMarker* startMarker, AccessibilityTextMarker* endMarker);
204     AccessibilityTextMarker startTextMarkerForTextMarkerRange(AccessibilityTextMarkerRange*);
205     AccessibilityTextMarker endTextMarkerForTextMarkerRange(AccessibilityTextMarkerRange*);
206     AccessibilityTextMarker textMarkerForPoint(int x, int y);
207     AccessibilityTextMarker previousTextMarker(AccessibilityTextMarker*);
208     AccessibilityTextMarker nextTextMarker(AccessibilityTextMarker*);
209     AccessibilityUIElement accessibilityElementForTextMarker(AccessibilityTextMarker*);
210     JSStringRef stringForTextMarkerRange(AccessibilityTextMarkerRange*);
211     int textMarkerRangeLength(AccessibilityTextMarkerRange*);
212     
213     // Notifications
214     // Function callback should take one argument, the name of the notification.
215     bool addNotificationListener(JSObjectRef functionCallback);
216     // Make sure you call remove, because you can't rely on objects being deallocated in a timely fashion.
217     void removeNotificationListener();
218     
219 private:
220     static JSClassRef getJSClass();
221     PlatformUIElement m_element;
222     
223     // A retained, platform specific object used to help manage notifications for this object.
224 #if PLATFORM(MAC)
225     NotificationHandler m_notificationHandler;
226 #endif
227 };
228
229 #endif // AccessibilityUIElement_h