Support ARIA "tab" roles
[WebKit-https.git] / WebCore / accessibility / AccessibilityRenderObject.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  *
8  * 1.  Redistributions of source code must retain the above copyright
9  *     notice, this list of conditions and the following disclaimer.
10  * 2.  Redistributions in binary form must reproduce the above copyright
11  *     notice, this list of conditions and the following disclaimer in the
12  *     documentation and/or other materials provided with the distribution.
13  * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
14  *     its contributors may be used to endorse or promote products derived
15  *     from this software without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  */
28
29 #ifndef AccessibilityRenderObject_h
30 #define AccessibilityRenderObject_h
31
32 #include "AccessibilityObject.h"
33
34 namespace WebCore {
35     
36 class AXObjectCache;
37 class Element;
38 class Frame;
39 class FrameView;
40 class HitTestResult;
41 class HTMLAnchorElement;
42 class HTMLAreaElement;
43 class HTMLElement;
44 class HTMLLabelElement;
45 class HTMLMapElement;
46 class HTMLSelectElement;
47 class IntPoint;
48 class IntSize;
49 class Node;
50 class RenderObject;
51 class RenderListBox;
52 class RenderTextControl;
53 class RenderView;
54 class VisibleSelection;
55 class String;
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 isTextControl() const;
76     virtual bool isNativeTextControl() const;
77     virtual bool isWebArea() const;
78     virtual bool isCheckboxOrRadio() const;
79     virtual bool isFileUploadButton() const;
80     virtual bool isInputImage() const;
81     virtual bool isProgressIndicator() const;
82     virtual bool isSlider() const;
83     virtual bool isMenuRelated() const;
84     virtual bool isMenu() const;
85     virtual bool isMenuBar() const;
86     virtual bool isMenuButton() const;
87     virtual bool isMenuItem() const;
88     virtual bool isControl() const;
89     virtual bool isFieldset() const;
90     virtual bool isGroup() const;
91
92     virtual bool isEnabled() const;
93     virtual bool isSelected() const;
94     virtual bool isFocused() const;
95     virtual bool isChecked() const;
96     virtual bool isHovered() const;
97     virtual bool isIndeterminate() const;
98     virtual bool isLoaded() const;
99     virtual bool isMultiSelect() const;
100     virtual bool isOffScreen() const;
101     virtual bool isPressed() const;
102     virtual bool isReadOnly() const;
103     virtual bool isVisited() const;        
104     virtual bool isRequired() const;
105     virtual bool isLinked() const;
106
107     const AtomicString& getAttribute(const QualifiedName&) const;
108     virtual bool canSetFocusAttribute() const;
109     virtual bool canSetTextRangeAttributes() const;
110     virtual bool canSetValueAttribute() const;
111     
112     virtual bool hasIntValue() const;
113     
114     virtual bool accessibilityIsIgnored() const;
115     
116     virtual int headingLevel() const;
117     virtual int intValue() const;
118     virtual String valueDescription() const;
119     virtual float valueForRange() const;
120     virtual float maxValueForRange() const;
121     virtual float minValueForRange() const;
122     virtual AccessibilityObject* selectedRadioButton();
123     virtual AccessibilityObject* selectedTabItem();
124     virtual int layoutCount() const;
125     
126     virtual AccessibilityObject* doAccessibilityHitTest(const IntPoint&) const;
127     virtual AccessibilityObject* focusedUIElement() const;
128     virtual AccessibilityObject* firstChild() const;
129     virtual AccessibilityObject* lastChild() const;
130     virtual AccessibilityObject* previousSibling() const;
131     virtual AccessibilityObject* nextSibling() const;
132     virtual AccessibilityObject* parentObject() const;
133     virtual AccessibilityObject* parentObjectIfExists() const;
134     virtual AccessibilityObject* observableObject() const;
135     virtual void linkedUIElements(AccessibilityChildrenVector&) const;
136     virtual bool exposesTitleUIElement() const;
137     virtual AccessibilityObject* titleUIElement() const;
138     virtual AccessibilityObject* correspondingControlForLabelElement() const;
139     virtual AccessibilityObject* correspondingLabelForControlElement() const;
140
141     virtual AccessibilityRole ariaRoleAttribute() const;
142     virtual bool isPresentationalChildOfAriaRole() const;
143     virtual bool ariaRoleHasPresentationalChildren() const;
144     void updateAccessibilityRole();
145     
146     virtual AXObjectCache* axObjectCache() const;
147     
148     virtual Element* actionElement() const;
149     Element* mouseButtonListener() const;
150     FrameView* frameViewIfRenderView() const;
151     virtual Element* anchorElement() const;
152     AccessibilityObject* menuForMenuButton() const;
153     AccessibilityObject* menuButtonForMenu() const;
154     
155     virtual IntRect boundingBoxRect() const;
156     virtual IntRect elementRect() const;
157     virtual IntSize size() const;
158     virtual IntPoint clickPoint() const;
159     
160     void setRenderer(RenderObject* renderer) { m_renderer = renderer; }
161     RenderObject* renderer() const { return m_renderer; }
162     RenderView* topRenderer() const;
163     RenderTextControl* textControl() const;
164     Document* document() const;
165     FrameView* topDocumentFrameView() const;  
166     HTMLLabelElement* labelElementContainer() const;
167     
168     virtual KURL url() const;
169     virtual PlainTextRange selectedTextRange() const;
170     virtual VisibleSelection selection() const;
171     virtual String stringValue() const;
172     virtual String ariaLabeledByAttribute() const;
173     virtual String title() const;
174     virtual String ariaDescribedByAttribute() const;
175     virtual String accessibilityDescription() const;
176     virtual String helpText() const;
177     virtual String textUnderElement() const;
178     virtual String text() const;
179     virtual int textLength() const;
180     virtual PassRefPtr<Range> ariaSelectedTextDOMRange() const;
181     virtual String selectedText() const;
182     virtual const AtomicString& accessKey() const;
183     virtual const String& actionVerb() const;
184     virtual Widget* widget() const;
185     virtual Widget* widgetForAttachmentView() const;
186     virtual void getDocumentLinks(AccessibilityChildrenVector&);
187     virtual FrameView* documentFrameView() const;
188     virtual String language() const;
189     
190     virtual const AccessibilityChildrenVector& children();
191     
192     virtual void setFocused(bool);
193     virtual void setSelectedTextRange(const PlainTextRange&);
194     virtual void setValue(const String&);
195     virtual void changeValueByPercent(float percentChange);
196     virtual void increment();
197     virtual void decrement();
198     
199     virtual void detach();
200     virtual void childrenChanged();
201     virtual void addChildren();
202     virtual bool canHaveChildren() const;
203     virtual void selectedChildren(AccessibilityChildrenVector&);
204     virtual void visibleChildren(AccessibilityChildrenVector&);
205     virtual void tabChildren(AccessibilityChildrenVector&);
206     virtual bool shouldFocusActiveDescendant() const;
207     virtual AccessibilityObject* activeDescendant() const;
208     virtual void handleActiveDescendantChanged();
209
210     virtual VisiblePositionRange visiblePositionRange() const;
211     virtual VisiblePositionRange visiblePositionRangeForLine(unsigned) const;
212     virtual IntRect boundsForVisiblePositionRange(const VisiblePositionRange&) const;
213     virtual void setSelectedVisiblePositionRange(const VisiblePositionRange&) const;
214     
215     virtual VisiblePosition visiblePositionForPoint(const IntPoint&) const;
216     virtual VisiblePosition visiblePositionForIndex(unsigned indexValue, bool lastIndexOK) const;    
217     virtual int index(const VisiblePosition&) const;
218
219     virtual VisiblePosition visiblePositionForIndex(int) const;
220     virtual int indexForVisiblePosition(const VisiblePosition&) const;
221     
222     virtual PlainTextRange doAXRangeForLine(unsigned) const;
223     virtual PlainTextRange doAXRangeForIndex(unsigned) const;
224     
225     virtual String doAXStringForRange(const PlainTextRange&) const;
226     virtual IntRect doAXBoundsForRange(const PlainTextRange&) const;
227     
228     virtual void updateBackingStore();
229
230     virtual String stringValueForMSAA() const;
231     virtual String stringRoleForMSAA() const;
232     virtual String nameForMSAA() const;
233     virtual String descriptionForMSAA() const;
234
235 protected:
236     RenderObject* m_renderer;
237     AccessibilityRole m_ariaRole;
238     mutable bool m_childrenDirty;
239     
240     void setRenderObject(RenderObject* renderer) { m_renderer = renderer; }
241     void ariaLabeledByElements(Vector<Element*>& elements) const;
242     
243     virtual bool isDetached() const { return !m_renderer; }
244
245 private:
246     void ariaListboxSelectedChildren(AccessibilityChildrenVector&);
247     void ariaListboxVisibleChildren(AccessibilityChildrenVector&);
248     bool ariaIsHidden() const;
249     String positionalDescriptionForMSAA() const;
250
251     Element* menuElementForMenuButton() const;
252     Element* menuItemElementForMenu() const;
253     AccessibilityRole determineAccessibilityRole();
254     AccessibilityRole determineAriaRoleAttribute() const;
255
256     bool isTabItemSelected() const;
257     IntRect checkboxOrRadioRect() const;
258     void addRadioButtonGroupMembers(AccessibilityChildrenVector& linkedUIElements) const;
259     AccessibilityObject* internalLinkElement() const;
260     AccessibilityObject* accessibilityImageMapHitTest(HTMLAreaElement*, const IntPoint&) const;
261     AccessibilityObject* accessibilityParentForImageMap(HTMLMapElement* map) const;
262
263     String accessibilityDescriptionForElements(Vector<Element*> &elements) const;
264     void elementsFromAttribute(Vector<Element*>& elements, const QualifiedName& name) const;
265     
266     void markChildrenDirty() const { m_childrenDirty = true; }
267 };
268     
269 } // namespace WebCore
270
271 #endif // AccessibilityRenderObject_h