Bug 26900: AX: Manual spell check with Command-; does not bring up suggestions
[WebKit-https.git] / WebKitTools / 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 <JavaScriptCore/JSObjectRef.h>
30 #include <wtf/Vector.h>
31
32 #if PLATFORM(MAC)
33 #ifdef __OBJC__
34 typedef id PlatformUIElement;
35 #else
36 typedef struct objc_object* PlatformUIElement;
37 #endif
38 #elif PLATFORM(WIN)
39 #undef _WINSOCKAPI_
40 #define _WINSOCKAPI_ // Prevent inclusion of winsock.h in windows.h
41
42 #include <oleacc.h>
43 #include <WebCore/COMPtr.h>
44
45 typedef COMPtr<IAccessible> PlatformUIElement;
46 #else
47 typedef void* PlatformUIElement;
48 #endif
49
50 class AccessibilityUIElement {
51 public:
52     AccessibilityUIElement(PlatformUIElement);
53     AccessibilityUIElement(const AccessibilityUIElement&);
54     ~AccessibilityUIElement();
55
56     PlatformUIElement platformUIElement() { return m_element; }
57
58     static JSObjectRef makeJSAccessibilityUIElement(JSContextRef, const AccessibilityUIElement&);
59
60     void getLinkedUIElements(Vector<AccessibilityUIElement>&);
61     void getDocumentLinks(Vector<AccessibilityUIElement>&);
62     void getChildren(Vector<AccessibilityUIElement>&);
63     void getChildrenWithRange(Vector<AccessibilityUIElement>&, unsigned location, unsigned length);
64     
65     AccessibilityUIElement elementAtPoint(int x, int y);
66     AccessibilityUIElement getChildAtIndex(unsigned);
67     int childrenCount();
68     AccessibilityUIElement titleUIElement();
69     AccessibilityUIElement parentElement();
70     
71     // Methods - platform-independent implementations
72     JSStringRef allAttributes();
73     JSStringRef attributesOfLinkedUIElements();
74     JSStringRef attributesOfDocumentLinks();
75     JSStringRef attributesOfChildren();
76     JSStringRef parameterizedAttributeNames();
77     
78     // Attributes - platform-independent implementations
79     JSStringRef attributeValue(JSStringRef attribute);
80     bool isAttributeSettable(JSStringRef attribute);
81     JSStringRef role();
82     JSStringRef title();
83     JSStringRef description();
84     JSStringRef language();
85     double x();
86     double y();
87     double width();
88     double height();
89     double intValue();
90     double minValue();
91     double maxValue();
92     int insertionPointLineNumber();
93     JSStringRef selectedTextRange();
94     bool supportsPressAction();
95     bool isEnabled();
96     double clickPointX();
97     double clickPointY();
98
99     // Table-specific attributes
100     JSStringRef attributesOfColumnHeaders();
101     JSStringRef attributesOfRowHeaders();
102     JSStringRef attributesOfColumns();
103     JSStringRef attributesOfRows();
104     JSStringRef attributesOfVisibleCells();
105     JSStringRef attributesOfHeader();
106     int indexInTable();
107     JSStringRef rowIndexRange();
108     JSStringRef columnIndexRange();
109     
110     // Parameterized attributes
111     int lineForIndex(int);
112     JSStringRef boundsForRange(unsigned location, unsigned length);
113     void setSelectedTextRange(unsigned location, unsigned length);
114     
115     // Table-specific
116     AccessibilityUIElement cellForColumnAndRow(unsigned column, unsigned row);
117     
118 private:
119     static JSClassRef getJSClass();
120
121     PlatformUIElement m_element;
122 };
123
124 #endif // AccessibilityUIElement_h