WK2: Support Accessibility
[WebKit-https.git] / WebCore / accessibility / AccessibilityRenderObject.h
1
2 /*
3  * Copyright (C) 2008 Apple Inc. All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *
9  * 1.  Redistributions of source code must retain the above copyright
10  *     notice, this list of conditions and the following disclaimer.
11  * 2.  Redistributions in binary form must reproduce the above copyright
12  *     notice, this list of conditions and the following disclaimer in the
13  *     documentation and/or other materials provided with the distribution.
14  * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
15  *     its contributors may be used to endorse or promote products derived
16  *     from this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
19  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
20  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
21  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
22  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
23  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
24  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
25  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28  */
29
30 #ifndef AccessibilityRenderObject_h
31 #define AccessibilityRenderObject_h
32
33 #include "AccessibilityObject.h"
34 #include <wtf/Forward.h>
35
36 namespace WebCore {
37     
38 class AXObjectCache;
39 class Element;
40 class Frame;
41 class FrameView;
42 class HitTestResult;
43 class HTMLAnchorElement;
44 class HTMLAreaElement;
45 class HTMLElement;
46 class HTMLLabelElement;
47 class HTMLMapElement;
48 class HTMLSelectElement;
49 class IntPoint;
50 class IntSize;
51 class Node;
52 class RenderListBox;
53 class RenderTextControl;
54 class RenderView;
55 class VisibleSelection;
56 class Widget;
57     
58 class AccessibilityRenderObject : public AccessibilityObject {
59 protected:
60     AccessibilityRenderObject(RenderObject*);
61 public:
62     static PassRefPtr<AccessibilityRenderObject> create(RenderObject*);
63     virtual ~AccessibilityRenderObject();
64     
65     bool isAccessibilityRenderObject() const { return true; }
66     
67     virtual bool isAnchor() const;
68     virtual bool isAttachment() const;
69     virtual bool isHeading() const;
70     virtual bool isLink() const;
71     virtual bool isImageButton() const;
72     virtual bool isImage() const;
73     virtual bool isNativeImage() const;
74     virtual bool isPasswordField() const;
75     virtual bool isNativeTextControl() const;
76     virtual bool isWebArea() const;
77     virtual bool isFileUploadButton() const;
78     virtual bool isInputImage() const;
79     virtual bool isProgressIndicator() const;
80     virtual bool isSlider() const;
81     virtual bool isMenuRelated() const;
82     virtual bool isMenu() const;
83     virtual bool isMenuBar() const;
84     virtual bool isMenuButton() const;
85     virtual bool isMenuItem() const;
86     virtual bool isControl() const;
87     virtual bool isFieldset() const;
88     virtual bool isGroup() const;
89
90     virtual bool isEnabled() const;
91     virtual bool isSelected() const;
92     virtual bool isFocused() const;
93     virtual bool isChecked() const;
94     virtual bool isHovered() const;
95     virtual bool isIndeterminate() const;
96     virtual bool isLoaded() const;
97     virtual bool isMultiSelectable() const;
98     virtual bool isOffScreen() const;
99     virtual bool isPressed() const;
100     virtual bool isReadOnly() const;
101     virtual bool isVisited() const;        
102     virtual bool isRequired() const;
103     virtual bool isLinked() const;
104     virtual bool isExpanded() const;
105     virtual void setIsExpanded(bool);
106
107     virtual bool canSetFocusAttribute() const;
108     virtual bool canSetTextRangeAttributes() const;
109     virtual bool canSetValueAttribute() const;
110     virtual bool canSetExpandedAttribute() const;
111
112     virtual void setAccessibleName(String&);
113     
114     // Provides common logic used by all elements when determining isIgnored.
115     AccessibilityObjectInclusion accessibilityIsIgnoredBase() const;
116     virtual bool accessibilityIsIgnored() const;
117     
118     virtual int headingLevel() const;
119     virtual AccessibilityButtonState checkboxOrRadioValue() const;
120     virtual String valueDescription() const;
121     virtual float valueForRange() const;
122     virtual float maxValueForRange() const;
123     virtual float minValueForRange() const;
124     virtual AccessibilityObject* selectedRadioButton();
125     virtual AccessibilityObject* selectedTabItem();
126     virtual int layoutCount() const;
127     virtual double estimatedLoadingProgress() const;
128     
129     virtual AccessibilityObject* firstChild() const;
130     virtual AccessibilityObject* lastChild() const;
131     virtual AccessibilityObject* previousSibling() const;
132     virtual AccessibilityObject* nextSibling() const;
133     virtual AccessibilityObject* parentObject() const;
134     virtual AccessibilityObject* parentObjectIfExists() const;
135     virtual AccessibilityObject* observableObject() const;
136     virtual void linkedUIElements(AccessibilityChildrenVector&) const;
137     virtual bool exposesTitleUIElement() const;
138     virtual AccessibilityObject* titleUIElement() const;
139     virtual AccessibilityObject* correspondingControlForLabelElement() const;
140     virtual AccessibilityObject* correspondingLabelForControlElement() const;
141
142     virtual void ariaOwnsElements(AccessibilityChildrenVector&) const;
143     virtual bool supportsARIAOwns() const;
144     virtual AccessibilityRole ariaRoleAttribute() const;
145     virtual bool isPresentationalChildOfAriaRole() const;
146     virtual bool ariaRoleHasPresentationalChildren() const;
147     void updateAccessibilityRole();
148     
149     // Should be called on the root accessibility object to kick off a hit test.
150     virtual AccessibilityObject* accessibilityHitTest(const IntPoint&) const;
151
152     virtual Element* actionElement() const;
153     Element* mouseButtonListener() const;
154     FrameView* frameViewIfRenderView() const;
155     virtual Element* anchorElement() const;
156     AccessibilityObject* menuForMenuButton() const;
157     AccessibilityObject* menuButtonForMenu() const;
158     
159     virtual IntRect boundingBoxRect() const;
160     virtual IntRect elementRect() const;
161     virtual IntSize size() const;
162     virtual IntPoint clickPoint() const;
163     
164     void setRenderer(RenderObject* renderer) { m_renderer = renderer; }
165     RenderObject* renderer() const { return m_renderer; }
166     RenderBoxModelObject* renderBoxModelObject() const;
167     virtual Node* node() const;
168
169     RenderView* topRenderer() const;
170     RenderTextControl* textControl() const;
171     Document* document() const;
172     FrameView* topDocumentFrameView() const;  
173     HTMLLabelElement* labelElementContainer() const;
174     
175     virtual KURL url() const;
176     virtual PlainTextRange selectedTextRange() const;
177     virtual VisibleSelection selection() const;
178     virtual String stringValue() const;
179     virtual String ariaLabeledByAttribute() const;
180     virtual String title() const;
181     virtual String ariaDescribedByAttribute() const;
182     virtual String accessibilityDescription() const;
183     virtual String helpText() const;
184     virtual String textUnderElement() const;
185     virtual String text() const;
186     virtual int textLength() const;
187     virtual String selectedText() const;
188     virtual const AtomicString& accessKey() const;
189     virtual const String& actionVerb() const;
190     virtual Widget* widget() const;
191     virtual Widget* widgetForAttachmentView() const;
192     virtual void getDocumentLinks(AccessibilityChildrenVector&);
193     virtual FrameView* documentFrameView() const;
194     virtual unsigned hierarchicalLevel() const;
195
196     virtual const AccessibilityChildrenVector& children();
197     virtual void clearChildren();
198     virtual void updateChildrenIfNecessary();
199     
200     virtual void setFocused(bool);
201     virtual void setSelectedTextRange(const PlainTextRange&);
202     virtual void setValue(const String&);
203     virtual void setSelected(bool);
204     virtual void setSelectedRows(AccessibilityChildrenVector&);
205     virtual void changeValueByPercent(float percentChange);
206     virtual AccessibilityOrientation orientation() const;
207     virtual void increment();
208     virtual void decrement();
209     
210     virtual void detach();
211     virtual void childrenChanged();
212     virtual void contentChanged();
213     virtual void addChildren();
214     virtual bool canHaveChildren() const;
215     virtual void selectedChildren(AccessibilityChildrenVector&);
216     virtual void visibleChildren(AccessibilityChildrenVector&);
217     virtual void tabChildren(AccessibilityChildrenVector&);
218     virtual bool shouldFocusActiveDescendant() const;
219     virtual AccessibilityObject* activeDescendant() const;
220     virtual void handleActiveDescendantChanged();
221     virtual void handleAriaExpandedChanged();
222     
223     virtual VisiblePositionRange visiblePositionRange() const;
224     virtual VisiblePositionRange visiblePositionRangeForLine(unsigned) const;
225     virtual IntRect boundsForVisiblePositionRange(const VisiblePositionRange&) const;
226     virtual void setSelectedVisiblePositionRange(const VisiblePositionRange&) const;
227     virtual bool supportsARIAFlowTo() const;
228     virtual void ariaFlowToElements(AccessibilityChildrenVector&) const;
229     virtual bool ariaHasPopup() const;
230
231     virtual bool supportsARIADropping() const;
232     virtual bool supportsARIADragging() const;
233     virtual bool isARIAGrabbed();
234     virtual void setARIAGrabbed(bool);
235     virtual void determineARIADropEffects(Vector<String>&);
236     
237     virtual VisiblePosition visiblePositionForPoint(const IntPoint&) const;
238     virtual VisiblePosition visiblePositionForIndex(unsigned indexValue, bool lastIndexOK) const;    
239     virtual int index(const VisiblePosition&) const;
240
241     virtual VisiblePosition visiblePositionForIndex(int) const;
242     virtual int indexForVisiblePosition(const VisiblePosition&) const;
243     
244     virtual PlainTextRange doAXRangeForLine(unsigned) const;
245     virtual PlainTextRange doAXRangeForIndex(unsigned) const;
246     
247     virtual String doAXStringForRange(const PlainTextRange&) const;
248     virtual IntRect doAXBoundsForRange(const PlainTextRange&) const;
249     
250     virtual void updateBackingStore();
251
252     virtual String stringValueForMSAA() const;
253     virtual String stringRoleForMSAA() const;
254     virtual String nameForMSAA() const;
255     virtual String descriptionForMSAA() const;
256     virtual AccessibilityRole roleValueForMSAA() const;
257
258 protected:
259     RenderObject* m_renderer;
260     AccessibilityRole m_ariaRole;
261     mutable bool m_childrenDirty;
262     
263     void setRenderObject(RenderObject* renderer) { m_renderer = renderer; }
264     void ariaLabeledByElements(Vector<Element*>& elements) const;
265     bool needsToUpdateChildren() const { return m_childrenDirty; }
266     
267     virtual bool isDetached() const { return !m_renderer; }
268
269 private:
270     void ariaListboxSelectedChildren(AccessibilityChildrenVector&);
271     void ariaListboxVisibleChildren(AccessibilityChildrenVector&);
272     bool ariaIsHidden() const;
273     bool isDescendantOfBarrenParent() const;
274     bool isAllowedChildOfTree() const;
275     bool hasTextAlternative() const;
276     String positionalDescriptionForMSAA() const;
277     PlainTextRange ariaSelectedTextRange() const;
278
279     Element* menuElementForMenuButton() const;
280     Element* menuItemElementForMenu() const;
281     AccessibilityRole determineAccessibilityRole();
282     AccessibilityRole determineAriaRoleAttribute() const;
283
284     bool isTabItemSelected() const;
285     bool isNativeCheckboxOrRadio() const;
286     IntRect checkboxOrRadioRect() const;
287     void addRadioButtonGroupMembers(AccessibilityChildrenVector& linkedUIElements) const;
288     AccessibilityObject* internalLinkElement() const;
289     AccessibilityObject* accessibilityImageMapHitTest(HTMLAreaElement*, const IntPoint&) const;
290     AccessibilityObject* accessibilityParentForImageMap(HTMLMapElement*) const;
291     bool renderObjectIsObservable(RenderObject*) const;
292     RenderObject* renderParentObject() const;
293     
294     void ariaSelectedRows(AccessibilityChildrenVector&);
295     
296     bool elementAttributeValue(const QualifiedName&) const;
297     void setElementAttributeValue(const QualifiedName&, bool);
298     
299     String accessibilityDescriptionForElements(Vector<Element*> &elements) const;
300     void elementsFromAttribute(Vector<Element*>& elements, const QualifiedName&) const;
301     String ariaAccessibilityDescription() const;
302     
303     virtual ESpeak speakProperty() const;
304     
305     virtual const AtomicString& ariaLiveRegionStatus() const;
306     virtual const AtomicString& ariaLiveRegionRelevant() const;
307     virtual bool ariaLiveRegionAtomic() const;
308     virtual bool ariaLiveRegionBusy() const;    
309     
310     bool inheritsPresentationalRole() const;
311     void setNeedsToUpdateChildren() const { m_childrenDirty = true; }
312     
313     mutable AccessibilityRole m_roleForMSAA;
314 };
315
316 inline AccessibilityRenderObject* toAccessibilityRenderObject(AccessibilityObject* object)
317 {
318     ASSERT(!object || object->isAccessibilityRenderObject());
319     return static_cast<AccessibilityRenderObject*>(object);
320 }
321
322 inline const AccessibilityRenderObject* toAccessibilityRenderObject(const AccessibilityObject* object)
323 {
324     ASSERT(!object || object->isAccessibilityRenderObject());
325     return static_cast<const AccessibilityRenderObject*>(object);
326 }
327
328 // This will catch anyone doing an unnecessary cast.
329 void toAccessibilityRenderObject(const AccessibilityRenderObject*);
330
331 } // namespace WebCore
332
333 #endif // AccessibilityRenderObject_h