summaryrefslogtreecommitdiff
path: root/Source/WebCore/accessibility/AccessibilityRenderObject.h
blob: 709245d488ff15859554834f2b3f24b61f9d5d0d (plain)
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
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
/*
 * Copyright (C) 2008 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.
 * 3.  Neither the name of Apple Inc. ("Apple") nor the names of
 *     its contributors may be used to endorse or promote products derived
 *     from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "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 OR ITS 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 AccessibilityRenderObject_h
#define AccessibilityRenderObject_h

#include "AccessibilityNodeObject.h"
#include "LayoutRect.h"
#include <wtf/Forward.h>

namespace WebCore {
    
class AccessibilitySVGRoot;
class AXObjectCache;
class Element;
class Frame;
class FrameView;
class HitTestResult;
class HTMLAnchorElement;
class HTMLAreaElement;
class HTMLElement;
class HTMLLabelElement;
class HTMLMapElement;
class HTMLSelectElement;
class IntPoint;
class IntSize;
class Node;
class RenderListBox;
class RenderTextControl;
class RenderView;
class VisibleSelection;
class Widget;
    
class AccessibilityRenderObject : public AccessibilityNodeObject {
public:
    static Ref<AccessibilityRenderObject> create(RenderObject*);
    virtual ~AccessibilityRenderObject();

    virtual void init() override;
    
    virtual bool isAttachment() const override;
    virtual bool isFileUploadButton() const override;

    virtual bool isSelected() const override;
    virtual bool isFocused() const override;
    virtual bool isLoaded() const override;
    virtual bool isOffScreen() const override;
    virtual bool isUnvisited() const override;
    virtual bool isVisited() const override;
    virtual bool isLinked() const override;
    virtual bool hasBoldFont() const override;
    virtual bool hasItalicFont() const override;
    virtual bool hasPlainText() const override;
    virtual bool hasSameFont(RenderObject*) const override;
    virtual bool hasSameFontColor(RenderObject*) const override;
    virtual bool hasSameStyle(RenderObject*) const override;
    virtual bool hasUnderline() const override;

    virtual bool canSetTextRangeAttributes() const override;
    virtual bool canSetExpandedAttribute() const override;

    virtual void setAccessibleName(const AtomicString&) override;
    
    // Provides common logic used by all elements when determining isIgnored.
    virtual AccessibilityObjectInclusion defaultObjectInclusion() const override;
    
    virtual int layoutCount() const override;
    virtual double estimatedLoadingProgress() const override;
    
    virtual AccessibilityObject* firstChild() const override;
    virtual AccessibilityObject* lastChild() const override;
    virtual AccessibilityObject* previousSibling() const override;
    virtual AccessibilityObject* nextSibling() const override;
    virtual AccessibilityObject* parentObject() const override;
    virtual AccessibilityObject* parentObjectIfExists() const override;
    virtual AccessibilityObject* observableObject() const override;
    virtual void linkedUIElements(AccessibilityChildrenVector&) const override;
    virtual bool exposesTitleUIElement() const override;
    virtual AccessibilityObject* titleUIElement() const override;
    virtual AccessibilityObject* correspondingControlForLabelElement() const override;
    virtual AccessibilityObject* correspondingLabelForControlElement() const override;

    virtual void ariaOwnsElements(AccessibilityChildrenVector&) const override;
    virtual bool supportsARIAOwns() const override;
    virtual bool isPresentationalChildOfAriaRole() const override;
    virtual bool ariaRoleHasPresentationalChildren() const override;
    
    // Should be called on the root accessibility object to kick off a hit test.
    virtual AccessibilityObject* accessibilityHitTest(const IntPoint&) const override;

    virtual Element* anchorElement() const override;
    
    virtual LayoutRect boundingBoxRect() const override;
    virtual LayoutRect elementRect() const override;
    virtual IntPoint clickPoint() override;
    
    void setRenderer(RenderObject*);
    virtual RenderObject* renderer() const override { return m_renderer; }
    RenderBoxModelObject* renderBoxModelObject() const;
    virtual Node* node() const override;

    virtual Document* document() const override;

    RenderView* topRenderer() const;
    RenderTextControl* textControl() const;
    HTMLLabelElement* labelElementContainer() const;
    
    virtual URL url() const override;
    virtual PlainTextRange selectedTextRange() const override;
    virtual VisibleSelection selection() const override;
    virtual String stringValue() const override;
    virtual String helpText() const override;
    virtual String textUnderElement(AccessibilityTextUnderElementMode = AccessibilityTextUnderElementMode()) const override;
    virtual String text() const override;
    virtual int textLength() const override;
    virtual String selectedText() const override;
    virtual const AtomicString& accessKey() const override;
    virtual const String& actionVerb() const;
    virtual Widget* widget() const override;
    virtual Widget* widgetForAttachmentView() const override;
    virtual void getDocumentLinks(AccessibilityChildrenVector&);
    virtual FrameView* documentFrameView() const override;

    virtual void clearChildren() override;
    virtual void updateChildrenIfNecessary() override;
    
    virtual void setFocused(bool) override;
    virtual void setSelectedTextRange(const PlainTextRange&) override;
    virtual void setValue(const String&) override;
    virtual void setSelectedRows(AccessibilityChildrenVector&) override;
    virtual AccessibilityOrientation orientation() const override;
    
    virtual void detach(AccessibilityDetachmentType, AXObjectCache*) override;
    virtual void textChanged() override;
    virtual void addChildren() override;
    virtual bool canHaveChildren() const override;
    virtual void selectedChildren(AccessibilityChildrenVector&) override;
    virtual void visibleChildren(AccessibilityChildrenVector&) override;
    virtual void tabChildren(AccessibilityChildrenVector&) override;
    virtual bool shouldFocusActiveDescendant() const override;
    bool shouldNotifyActiveDescendant() const;
    virtual AccessibilityObject* activeDescendant() const override;
    virtual void handleActiveDescendantChanged() override;
    virtual void handleAriaExpandedChanged() override;
    
    virtual VisiblePositionRange visiblePositionRange() const override;
    virtual VisiblePositionRange visiblePositionRangeForLine(unsigned) const override;
    virtual IntRect boundsForVisiblePositionRange(const VisiblePositionRange&) const override;
    virtual void setSelectedVisiblePositionRange(const VisiblePositionRange&) const override;
    virtual bool supportsARIAFlowTo() const override;
    virtual void ariaFlowToElements(AccessibilityChildrenVector&) const override;
    virtual bool supportsARIADescribedBy() const override;
    virtual void ariaDescribedByElements(AccessibilityChildrenVector&) const override;
    virtual bool supportsARIAControls() const override;
    virtual void ariaControlsElements(AccessibilityChildrenVector&) const override;
    virtual bool ariaHasPopup() const override;

    virtual bool supportsARIADropping() const override;
    virtual bool supportsARIADragging() const override;
    virtual bool isARIAGrabbed() override;
    virtual void determineARIADropEffects(Vector<String>&) override;
    
    virtual VisiblePosition visiblePositionForPoint(const IntPoint&) const override;
    virtual VisiblePosition visiblePositionForIndex(unsigned indexValue, bool lastIndexOK) const override;
    virtual int index(const VisiblePosition&) const override;

    virtual VisiblePosition visiblePositionForIndex(int) const override;
    virtual int indexForVisiblePosition(const VisiblePosition&) const override;

    virtual void lineBreaks(Vector<int>&) const override;
    virtual PlainTextRange doAXRangeForLine(unsigned) const override;
    virtual PlainTextRange doAXRangeForIndex(unsigned) const override;
    
    virtual String doAXStringForRange(const PlainTextRange&) const override;
    virtual IntRect doAXBoundsForRange(const PlainTextRange&) const override;
    
    virtual String stringValueForMSAA() const override;
    virtual String stringRoleForMSAA() const override;
    virtual String nameForMSAA() const override;
    virtual String descriptionForMSAA() const override;
    virtual AccessibilityRole roleValueForMSAA() const override;

    virtual String passwordFieldValue() const override;

protected:
    explicit AccessibilityRenderObject(RenderObject*);
    void setRenderObject(RenderObject* renderer) { m_renderer = renderer; }
    void ariaElementsFromAttribute(AccessibilityChildrenVector&, const QualifiedName&) const;
    bool needsToUpdateChildren() const { return m_childrenDirty; }
    virtual ScrollableArea* getScrollableAreaIfScrollable() const override;
    virtual void scrollTo(const IntPoint&) const override;
    
    virtual bool isDetached() const override { return !m_renderer; }

    virtual AccessibilityRole determineAccessibilityRole() override;
    virtual bool computeAccessibilityIsIgnored() const override;

    RenderObject* m_renderer;

private:
    virtual bool isAccessibilityRenderObject() const override final { return true; }
    void ariaListboxSelectedChildren(AccessibilityChildrenVector&);
    void ariaListboxVisibleChildren(AccessibilityChildrenVector&);
    bool isAllowedChildOfTree() const;
    bool hasTextAlternative() const;
    String positionalDescriptionForMSAA() const;
    PlainTextRange documentBasedSelectedTextRange() const;
    Element* rootEditableElementForPosition(const Position&) const;
    bool nodeIsTextControl(const Node*) const;
    virtual void setNeedsToUpdateChildren() override { m_childrenDirty = true; }
    virtual Path elementPath() const override;
    
    bool isTabItemSelected() const;
    LayoutRect checkboxOrRadioRect() const;
    void addRadioButtonGroupMembers(AccessibilityChildrenVector& linkedUIElements) const;
    AccessibilityObject* internalLinkElement() const;
    AccessibilityObject* accessibilityImageMapHitTest(HTMLAreaElement*, const IntPoint&) const;
    AccessibilityObject* accessibilityParentForImageMap(HTMLMapElement*) const;
    virtual AccessibilityObject* elementAccessibilityHitTest(const IntPoint&) const override;

    bool renderObjectIsObservable(RenderObject&) const;
    RenderObject* renderParentObject() const;
    bool isDescendantOfElementType(const QualifiedName& tagName) const;
    
    bool isSVGImage() const;
    void detachRemoteSVGRoot();
    AccessibilitySVGRoot* remoteSVGRootElement() const;
    AccessibilityObject* remoteSVGElementHitTest(const IntPoint&) const;
    void offsetBoundingBoxForRemoteSVGElement(LayoutRect&) const;
    virtual bool supportsPath() const override;

    void addHiddenChildren();
    void addTextFieldChildren();
    void addImageMapChildren();
    void addCanvasChildren();
    void addAttachmentChildren();
    void addRemoteSVGChildren();
#if PLATFORM(COCOA)
    void updateAttachmentViewParents();
#endif
    virtual String expandedTextValue() const override;
    virtual bool supportsExpandedTextValue() const override;
    void updateRoleAfterChildrenCreation();
    
    void ariaSelectedRows(AccessibilityChildrenVector&);
    
    bool elementAttributeValue(const QualifiedName&) const;
    void setElementAttributeValue(const QualifiedName&, bool);
    
    virtual ESpeak speakProperty() const override;
    
    virtual const String ariaLiveRegionStatus() const override;
    virtual const AtomicString& ariaLiveRegionRelevant() const override;
    virtual bool ariaLiveRegionAtomic() const override;
    virtual bool ariaLiveRegionBusy() const override;

    virtual bool inheritsPresentationalRole() const override;

    bool shouldGetTextFromNode(AccessibilityTextUnderElementMode) const;

#if ENABLE(MATHML)
    // All math elements return true for isMathElement().
    virtual bool isMathElement() const override;
    virtual bool isMathFraction() const override;
    virtual bool isMathFenced() const override;
    virtual bool isMathSubscriptSuperscript() const override;
    virtual bool isMathRow() const override;
    virtual bool isMathUnderOver() const override;
    virtual bool isMathRoot() const override;
    virtual bool isMathSquareRoot() const override;
    virtual bool isMathText() const override;
    virtual bool isMathNumber() const override;
    virtual bool isMathOperator() const override;
    virtual bool isMathFenceOperator() const override;
    virtual bool isMathSeparatorOperator() const override;
    virtual bool isMathIdentifier() const override;
    virtual bool isMathTable() const override;
    virtual bool isMathTableRow() const override;
    virtual bool isMathTableCell() const override;
    virtual bool isMathMultiscript() const override;
    virtual bool isMathToken() const override;
    virtual bool isMathScriptObject(AccessibilityMathScriptObjectType) const override;
    virtual bool isMathMultiscriptObject(AccessibilityMathMultiscriptObjectType) const override;
    
    // Generic components.
    virtual AccessibilityObject* mathBaseObject() override;
    
    // Root components.
    virtual AccessibilityObject* mathRadicandObject() override;
    virtual AccessibilityObject* mathRootIndexObject() override;
    
    // Fraction components.
    virtual AccessibilityObject* mathNumeratorObject() override;
    virtual AccessibilityObject* mathDenominatorObject() override;

    // Under over components.
    virtual AccessibilityObject* mathUnderObject() override;
    virtual AccessibilityObject* mathOverObject() override;
    
    // Subscript/superscript components.
    virtual AccessibilityObject* mathSubscriptObject() override;
    virtual AccessibilityObject* mathSuperscriptObject() override;
    
    // Fenced components.
    virtual String mathFencedOpenString() const override;
    virtual String mathFencedCloseString() const override;
    virtual int mathLineThickness() const override;

    // Multiscripts components.
    virtual void mathPrescripts(AccessibilityMathMultiscriptPairs&) override;
    virtual void mathPostscripts(AccessibilityMathMultiscriptPairs&) override;
    
    bool isIgnoredElementWithinMathTree() const;
#endif
};

} // namespace WebCore

SPECIALIZE_TYPE_TRAITS_ACCESSIBILITY(AccessibilityRenderObject, isAccessibilityRenderObject())

#endif // AccessibilityRenderObject_h