1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
|
/*
* Copyright (C) 2011 Apple Inc. All Rights Reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
* OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef AccessibilityUIElement_h
#define AccessibilityUIElement_h
#include "AccessibilityTextMarker.h"
#include "AccessibilityTextMarkerRange.h"
#include "JSWrappable.h"
#include <JavaScriptCore/JSObjectRef.h>
#include <JavaScriptCore/JSRetainPtr.h>
#include <wtf/Platform.h>
#include <wtf/Vector.h>
#if PLATFORM(MAC)
#ifdef __OBJC__
typedef id PlatformUIElement;
#else
typedef struct objc_object* PlatformUIElement;
#endif
#elif HAVE(ACCESSIBILITY) && (PLATFORM(GTK) || PLATFORM(EFL))
#include "AccessibilityNotificationHandlerAtk.h"
#include <atk/atk.h>
#include <wtf/gobject/GRefPtr.h>
typedef GRefPtr<AtkObject> PlatformUIElement;
#else
typedef void* PlatformUIElement;
#endif
#if PLATFORM(MAC)
#ifdef __OBJC__
typedef id NotificationHandler;
#else
typedef struct objc_object* NotificationHandler;
#endif
#endif
namespace WTR {
class AccessibilityUIElement : public JSWrappable {
public:
static PassRefPtr<AccessibilityUIElement> create(PlatformUIElement);
static PassRefPtr<AccessibilityUIElement> create(const AccessibilityUIElement&);
~AccessibilityUIElement();
PlatformUIElement platformUIElement() { return m_element; }
virtual JSClassRef wrapperClass();
static JSObjectRef makeJSAccessibilityUIElement(JSContextRef, const AccessibilityUIElement&);
bool isEqual(AccessibilityUIElement* otherElement);
PassRefPtr<AccessibilityUIElement> elementAtPoint(int x, int y);
PassRefPtr<AccessibilityUIElement> childAtIndex(unsigned);
unsigned indexOfChild(AccessibilityUIElement*);
int childrenCount();
PassRefPtr<AccessibilityUIElement> titleUIElement();
PassRefPtr<AccessibilityUIElement> parentElement();
void takeFocus();
void takeSelection();
void addSelection();
void removeSelection();
// Methods - platform-independent implementations
JSRetainPtr<JSStringRef> allAttributes();
JSRetainPtr<JSStringRef> attributesOfLinkedUIElements();
PassRefPtr<AccessibilityUIElement> linkedUIElementAtIndex(unsigned);
JSRetainPtr<JSStringRef> attributesOfDocumentLinks();
JSRetainPtr<JSStringRef> attributesOfChildren();
JSRetainPtr<JSStringRef> parameterizedAttributeNames();
void increment();
void decrement();
void showMenu();
void press();
// Attributes - platform-independent implementations
JSRetainPtr<JSStringRef> stringAttributeValue(JSStringRef attribute);
double numberAttributeValue(JSStringRef attribute);
JSValueRef uiElementArrayAttributeValue(JSStringRef attribute) const;
PassRefPtr<AccessibilityUIElement> uiElementAttributeValue(JSStringRef attribute) const;
bool boolAttributeValue(JSStringRef attribute);
bool isAttributeSupported(JSStringRef attribute);
bool isAttributeSettable(JSStringRef attribute);
bool isPressActionSupported();
bool isIncrementActionSupported();
bool isDecrementActionSupported();
JSRetainPtr<JSStringRef> role();
JSRetainPtr<JSStringRef> subrole();
JSRetainPtr<JSStringRef> roleDescription();
JSRetainPtr<JSStringRef> title();
JSRetainPtr<JSStringRef> description();
JSRetainPtr<JSStringRef> language();
JSRetainPtr<JSStringRef> stringValue();
JSRetainPtr<JSStringRef> accessibilityValue() const;
JSRetainPtr<JSStringRef> helpText() const;
JSRetainPtr<JSStringRef> orientation() const;
double x();
double y();
double width();
double height();
double intValue() const;
double minValue();
double maxValue();
JSRetainPtr<JSStringRef> valueDescription();
int insertionPointLineNumber();
JSRetainPtr<JSStringRef> selectedTextRange();
bool isEnabled();
bool isRequired() const;
bool isFocused() const;
bool isFocusable() const;
bool isSelected() const;
bool isSelectedOptionActive() const;
bool isSelectable() const;
bool isMultiSelectable() const;
void setSelectedChild(AccessibilityUIElement*) const;
unsigned selectedChildrenCount() const;
PassRefPtr<AccessibilityUIElement> selectedChildAtIndex(unsigned) const;
bool isValid() const;
bool isExpanded() const;
bool isChecked() const;
bool isIndeterminate() const;
bool isVisible() const;
bool isOffScreen() const;
bool isCollapsed() const;
bool isIgnored() const;
bool hasPopup() const;
int hierarchicalLevel() const;
double clickPointX();
double clickPointY();
JSRetainPtr<JSStringRef> documentEncoding();
JSRetainPtr<JSStringRef> documentURI();
JSRetainPtr<JSStringRef> url();
JSRetainPtr<JSStringRef> classList() const;
// CSS3-speech properties.
JSRetainPtr<JSStringRef> speak();
// Table-specific attributes
JSRetainPtr<JSStringRef> attributesOfColumnHeaders();
JSRetainPtr<JSStringRef> attributesOfRowHeaders();
JSRetainPtr<JSStringRef> attributesOfColumns();
JSRetainPtr<JSStringRef> attributesOfRows();
JSRetainPtr<JSStringRef> attributesOfVisibleCells();
JSRetainPtr<JSStringRef> attributesOfHeader();
int indexInTable();
JSRetainPtr<JSStringRef> rowIndexRange();
JSRetainPtr<JSStringRef> columnIndexRange();
int rowCount();
int columnCount();
JSValueRef rowHeaders() const;
JSValueRef columnHeaders() const;
// Tree/Outline specific attributes
PassRefPtr<AccessibilityUIElement> selectedRowAtIndex(unsigned);
PassRefPtr<AccessibilityUIElement> disclosedByRow();
PassRefPtr<AccessibilityUIElement> disclosedRowAtIndex(unsigned);
PassRefPtr<AccessibilityUIElement> rowAtIndex(unsigned);
// ARIA specific
PassRefPtr<AccessibilityUIElement> ariaOwnsElementAtIndex(unsigned);
PassRefPtr<AccessibilityUIElement> ariaFlowToElementAtIndex(unsigned);
// ARIA Drag and Drop
bool ariaIsGrabbed() const;
// A space concatentated string of all the drop effects.
JSRetainPtr<JSStringRef> ariaDropEffects() const;
// Parameterized attributes
int lineForIndex(int);
JSRetainPtr<JSStringRef> rangeForLine(int);
JSRetainPtr<JSStringRef> rangeForPosition(int x, int y);
JSRetainPtr<JSStringRef> boundsForRange(unsigned location, unsigned length);
bool setSelectedTextRange(unsigned location, unsigned length);
JSRetainPtr<JSStringRef> stringForRange(unsigned location, unsigned length);
JSRetainPtr<JSStringRef> attributedStringForRange(unsigned location, unsigned length);
bool attributedStringRangeIsMisspelled(unsigned location, unsigned length);
unsigned uiElementCountForSearchPredicate(JSContextRef, AccessibilityUIElement* startElement, bool isDirectionNext, JSValueRef searchKey, JSStringRef searchText, bool visibleOnly);
PassRefPtr<AccessibilityUIElement> uiElementForSearchPredicate(JSContextRef, AccessibilityUIElement* startElement, bool isDirectionNext, JSValueRef searchKey, JSStringRef searchText, bool visibleOnly);
// Text-specific
JSRetainPtr<JSStringRef> characterAtOffset(int offset);
JSRetainPtr<JSStringRef> wordAtOffset(int offset);
JSRetainPtr<JSStringRef> lineAtOffset(int offset);
JSRetainPtr<JSStringRef> sentenceAtOffset(int offset);
// Table-specific
PassRefPtr<AccessibilityUIElement> cellForColumnAndRow(unsigned column, unsigned row);
// Scrollarea-specific
PassRefPtr<AccessibilityUIElement> horizontalScrollbar() const;
PassRefPtr<AccessibilityUIElement> verticalScrollbar() const;
void scrollToMakeVisible();
// Text markers.
PassRefPtr<AccessibilityTextMarkerRange> textMarkerRangeForElement(AccessibilityUIElement*);
PassRefPtr<AccessibilityTextMarkerRange> textMarkerRangeForMarkers(AccessibilityTextMarker* startMarker, AccessibilityTextMarker* endMarker);
PassRefPtr<AccessibilityTextMarker> startTextMarkerForTextMarkerRange(AccessibilityTextMarkerRange*);
PassRefPtr<AccessibilityTextMarker> endTextMarkerForTextMarkerRange(AccessibilityTextMarkerRange*);
PassRefPtr<AccessibilityTextMarker> endTextMarkerForBounds(int x, int y, int width, int height);
PassRefPtr<AccessibilityTextMarker> startTextMarkerForBounds(int x, int y, int width, int height);
PassRefPtr<AccessibilityTextMarker> textMarkerForPoint(int x, int y);
PassRefPtr<AccessibilityTextMarker> previousTextMarker(AccessibilityTextMarker*);
PassRefPtr<AccessibilityTextMarker> nextTextMarker(AccessibilityTextMarker*);
PassRefPtr<AccessibilityUIElement> accessibilityElementForTextMarker(AccessibilityTextMarker*);
JSRetainPtr<JSStringRef> stringForTextMarkerRange(AccessibilityTextMarkerRange*);
int textMarkerRangeLength(AccessibilityTextMarkerRange*);
bool attributedStringForTextMarkerRangeContainsAttribute(JSStringRef, AccessibilityTextMarkerRange*);
int indexForTextMarker(AccessibilityTextMarker*);
bool isTextMarkerValid(AccessibilityTextMarker*);
PassRefPtr<AccessibilityTextMarker> textMarkerForIndex(int);
PassRefPtr<AccessibilityTextMarker> startTextMarker();
PassRefPtr<AccessibilityTextMarker> endTextMarker();
// Returns an ordered list of supported actions for an element.
JSRetainPtr<JSStringRef> supportedActions() const;
JSRetainPtr<JSStringRef> mathPostscriptsDescription() const;
JSRetainPtr<JSStringRef> mathPrescriptsDescription() const;
JSRetainPtr<JSStringRef> pathDescription() const;
// Notifications
// Function callback should take one argument, the name of the notification.
bool addNotificationListener(JSValueRef functionCallback);
// Make sure you call remove, because you can't rely on objects being deallocated in a timely fashion.
bool removeNotificationListener();
private:
AccessibilityUIElement(PlatformUIElement);
AccessibilityUIElement(const AccessibilityUIElement&);
PlatformUIElement m_element;
// A retained, platform specific object used to help manage notifications for this object.
#if HAVE(ACCESSIBILITY)
#if PLATFORM(MAC)
NotificationHandler m_notificationHandler;
void getLinkedUIElements(Vector<RefPtr<AccessibilityUIElement> >&);
void getDocumentLinks(Vector<RefPtr<AccessibilityUIElement> >&);
void getUIElementsWithAttribute(JSStringRef, Vector<RefPtr<AccessibilityUIElement> >&) const;
#endif
#if PLATFORM(MAC) || PLATFORM(GTK) || PLATFORM(EFL)
void getChildren(Vector<RefPtr<AccessibilityUIElement> >&);
void getChildrenWithRange(Vector<RefPtr<AccessibilityUIElement> >&, unsigned location, unsigned length);
#endif
#if PLATFORM(GTK) || PLATFORM(EFL)
RefPtr<AccessibilityNotificationHandler> m_notificationHandler;
#endif
#endif
};
} // namespace WTR
#endif // AccessibilityUIElement_h
|
