a43b71d553b03fa4f389c762002575d74b2047e9
[WebKit-https.git] / Source / 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 #include "LayoutTypes.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     virtual 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 isSearchField() const;
77     virtual bool isWebArea() const;
78     virtual bool isFileUploadButton() const;
79     virtual bool isInputImage() const;
80     virtual bool isProgressIndicator() const;
81     virtual bool isSlider() const;
82     virtual bool isMenuRelated() const;
83     virtual bool isMenu() const;
84     virtual bool isMenuBar() const;
85     virtual bool isMenuButton() const;
86     virtual bool isMenuItem() const;
87     virtual bool isControl() const;
88     virtual bool isFieldset() const;
89     virtual bool isGroup() const;
90
91     virtual bool isEnabled() const;
92     virtual bool isSelected() const;
93     virtual bool isFocused() const;
94     virtual bool isChecked() const;
95     virtual bool isHovered() const;
96     virtual bool isIndeterminate() const;
97     virtual bool isLoaded() const;
98     virtual bool isMultiSelectable() const;
99     virtual bool isOffScreen() const;
100     virtual bool isPressed() const;
101     virtual bool isReadOnly() const;
102     virtual bool isUnvisited() const;
103     virtual bool isVisited() const;        
104     virtual bool isRequired() const;
105     virtual bool isLinked() const;
106     virtual bool hasBoldFont() const;
107     virtual bool hasItalicFont() const;
108     virtual bool hasPlainText() const;
109     virtual bool hasSameFont(RenderObject*) const;
110     virtual bool hasSameFontColor(RenderObject*) const;
111     virtual bool hasSameStyle(RenderObject*) const;
112     virtual bool hasUnderline() const;
113
114     virtual bool canSetFocusAttribute() const;
115     virtual bool canSetTextRangeAttributes() const;
116     virtual bool canSetValueAttribute() const;
117     virtual bool canSetExpandedAttribute() const;
118
119     virtual void setAccessibleName(const AtomicString&);
120     
121     // Provides common logic used by all elements when determining isIgnored.
122     AccessibilityObjectInclusion accessibilityIsIgnoredBase() const;
123     virtual bool accessibilityIsIgnored() const;
124     
125     virtual int headingLevel() const;
126     virtual AccessibilityButtonState checkboxOrRadioValue() const;
127     virtual String valueDescription() const;
128     virtual float valueForRange() const;
129     virtual float maxValueForRange() const;
130     virtual float minValueForRange() const;
131     virtual float stepValueForRange() const;
132     virtual AccessibilityObject* selectedRadioButton();
133     virtual AccessibilityObject* selectedTabItem();
134     virtual int layoutCount() const;
135     virtual double estimatedLoadingProgress() const;
136     
137     virtual AccessibilityObject* firstChild() const;
138     virtual AccessibilityObject* lastChild() const;
139     virtual AccessibilityObject* previousSibling() const;
140     virtual AccessibilityObject* nextSibling() const;
141     virtual AccessibilityObject* parentObject() const;
142     virtual AccessibilityObject* parentObjectIfExists() const;
143     virtual AccessibilityObject* observableObject() const;
144     virtual void linkedUIElements(AccessibilityChildrenVector&) const;
145     virtual bool exposesTitleUIElement() const;
146     virtual AccessibilityObject* titleUIElement() const;
147     virtual AccessibilityObject* correspondingControlForLabelElement() const;
148     virtual AccessibilityObject* correspondingLabelForControlElement() const;
149
150     virtual void ariaOwnsElements(AccessibilityChildrenVector&) const;
151     virtual bool supportsARIAOwns() const;
152     virtual AccessibilityRole ariaRoleAttribute() const;
153     virtual bool isPresentationalChildOfAriaRole() const;
154     virtual bool ariaRoleHasPresentationalChildren() const;
155     void updateAccessibilityRole();
156     
157     // Should be called on the root accessibility object to kick off a hit test.
158     virtual AccessibilityObject* accessibilityHitTest(const IntPoint&) const;
159
160     virtual Element* actionElement() const;
161     Element* mouseButtonListener() const;
162     FrameView* frameViewIfRenderView() const;
163     virtual Element* anchorElement() const;
164     AccessibilityObject* menuForMenuButton() const;
165     AccessibilityObject* menuButtonForMenu() const;
166     
167     virtual LayoutRect boundingBoxRect() const;
168     virtual LayoutRect elementRect() const;
169     virtual IntPoint clickPoint();
170     
171     void setRenderer(RenderObject* renderer) { m_renderer = renderer; }
172     virtual RenderObject* renderer() const { return m_renderer; }
173     RenderBoxModelObject* renderBoxModelObject() const;
174     virtual Node* node() const;
175
176     RenderView* topRenderer() const;
177     RenderTextControl* textControl() const;
178     Document* document() const;
179     FrameView* topDocumentFrameView() const;  
180     Document* topDocument() const;
181     HTMLLabelElement* labelElementContainer() const;
182     
183     virtual KURL url() const;
184     virtual PlainTextRange selectedTextRange() const;
185     virtual VisibleSelection selection() const;
186     virtual String stringValue() const;
187     virtual String ariaLabeledByAttribute() const;
188     virtual String title() const;
189     virtual String ariaDescribedByAttribute() const;
190     virtual String accessibilityDescription() const;
191     virtual String helpText() const;
192     virtual String textUnderElement() const;
193     virtual String text() const;
194     virtual int textLength() const;
195     virtual String selectedText() const;
196     virtual const AtomicString& accessKey() const;
197     virtual const String& actionVerb() const;
198     virtual Widget* widget() const;
199     virtual Widget* widgetForAttachmentView() const;
200     virtual void getDocumentLinks(AccessibilityChildrenVector&);
201     virtual FrameView* documentFrameView() const;
202     virtual unsigned hierarchicalLevel() const;
203
204     virtual void clearChildren();
205     virtual void updateChildrenIfNecessary();
206     
207     virtual void setFocused(bool);
208     virtual void setSelectedTextRange(const PlainTextRange&);
209     virtual void setValue(const String&);
210     virtual void setSelectedRows(AccessibilityChildrenVector&);
211     virtual void changeValueByPercent(float percentChange);
212     virtual AccessibilityOrientation orientation() const;
213     virtual void increment();
214     virtual void decrement();
215     
216     virtual void detach();
217     virtual void childrenChanged();
218     virtual void contentChanged();
219     virtual void addChildren();
220     virtual bool canHaveChildren() const;
221     virtual void selectedChildren(AccessibilityChildrenVector&);
222     virtual void visibleChildren(AccessibilityChildrenVector&);
223     virtual void tabChildren(AccessibilityChildrenVector&);
224     virtual bool shouldFocusActiveDescendant() const;
225     virtual AccessibilityObject* activeDescendant() const;
226     virtual void handleActiveDescendantChanged();
227     virtual void handleAriaExpandedChanged();
228     
229     virtual VisiblePositionRange visiblePositionRange() const;
230     virtual VisiblePositionRange visiblePositionRangeForLine(unsigned) const;
231     virtual IntRect boundsForVisiblePositionRange(const VisiblePositionRange&) const;
232     virtual void setSelectedVisiblePositionRange(const VisiblePositionRange&) const;
233     virtual bool supportsARIAFlowTo() const;
234     virtual void ariaFlowToElements(AccessibilityChildrenVector&) const;
235     virtual bool ariaHasPopup() const;
236
237     virtual bool supportsARIADropping() const;
238     virtual bool supportsARIADragging() const;
239     virtual bool isARIAGrabbed();
240     virtual void determineARIADropEffects(Vector<String>&);
241     
242     virtual VisiblePosition visiblePositionForPoint(const IntPoint&) const;
243     virtual VisiblePosition visiblePositionForIndex(unsigned indexValue, bool lastIndexOK) const;    
244     virtual int index(const VisiblePosition&) const;
245
246     virtual VisiblePosition visiblePositionForIndex(int) const;
247     virtual int indexForVisiblePosition(const VisiblePosition&) const;
248
249     virtual PlainTextRange doAXRangeForLine(unsigned) const;
250     virtual PlainTextRange doAXRangeForIndex(unsigned) const;
251     
252     virtual String doAXStringForRange(const PlainTextRange&) const;
253     virtual IntRect doAXBoundsForRange(const PlainTextRange&) const;
254     
255     virtual String stringValueForMSAA() const;
256     virtual String stringRoleForMSAA() const;
257     virtual String nameForMSAA() const;
258     virtual String descriptionForMSAA() const;
259     virtual AccessibilityRole roleValueForMSAA() const;
260
261 protected:
262     RenderObject* m_renderer;
263     AccessibilityRole m_ariaRole;
264     bool m_childrenDirty;
265     
266     void setRenderObject(RenderObject* renderer) { m_renderer = renderer; }
267     void ariaLabeledByElements(Vector<Element*>& elements) const;
268     bool needsToUpdateChildren() const { return m_childrenDirty; }
269     ScrollableArea* getScrollableAreaIfScrollable() const;
270     void scrollTo(const IntPoint&) const;
271     
272     virtual bool isDetached() const { return !m_renderer; }
273
274 private:
275     void ariaListboxSelectedChildren(AccessibilityChildrenVector&);
276     void ariaListboxVisibleChildren(AccessibilityChildrenVector&);
277     bool ariaIsHidden() const;
278     bool isDescendantOfBarrenParent() const;
279     bool isAllowedChildOfTree() const;
280     bool hasTextAlternative() const;
281     String positionalDescriptionForMSAA() const;
282     PlainTextRange ariaSelectedTextRange() const;
283     Element* rootEditableElementForPosition(const Position&) const;
284     bool nodeIsTextControl(const Node*) const;
285     virtual void setNeedsToUpdateChildren() { m_childrenDirty = true; }
286
287     Element* menuElementForMenuButton() const;
288     Element* menuItemElementForMenu() const;
289     AccessibilityRole determineAccessibilityRole();
290     AccessibilityRole determineAriaRoleAttribute() const;
291     AccessibilityRole remapAriaRoleDueToParent(AccessibilityRole) const;
292
293     bool isTabItemSelected() const;
294     void alterSliderValue(bool increase);
295     void changeValueByStep(bool increase);
296     bool isNativeCheckboxOrRadio() const;
297     LayoutRect checkboxOrRadioRect() const;
298     void addRadioButtonGroupMembers(AccessibilityChildrenVector& linkedUIElements) const;
299     AccessibilityObject* internalLinkElement() const;
300     AccessibilityObject* accessibilityImageMapHitTest(HTMLAreaElement*, const IntPoint&) const;
301     AccessibilityObject* accessibilityParentForImageMap(HTMLMapElement*) const;
302     bool renderObjectIsObservable(RenderObject*) const;
303     RenderObject* renderParentObject() const;
304     bool isDescendantOfElementType(const QualifiedName& tagName) const;
305
306     void addTextFieldChildren();
307     void addImageMapChildren();
308     void addAttachmentChildren();
309 #if PLATFORM(MAC)
310     void updateAttachmentViewParents();
311 #endif
312
313     void ariaSelectedRows(AccessibilityChildrenVector&);
314     
315     bool elementAttributeValue(const QualifiedName&) const;
316     void setElementAttributeValue(const QualifiedName&, bool);
317     
318     String accessibilityDescriptionForElements(Vector<Element*> &elements) const;
319     void elementsFromAttribute(Vector<Element*>& elements, const QualifiedName&) const;
320     String ariaAccessibilityDescription() const;
321     String webAreaAccessibilityDescription() const;
322
323     virtual ESpeak speakProperty() const;
324     
325     virtual const AtomicString& ariaLiveRegionStatus() const;
326     virtual const AtomicString& ariaLiveRegionRelevant() const;
327     virtual bool ariaLiveRegionAtomic() const;
328     virtual bool ariaLiveRegionBusy() const;    
329     
330     bool inheritsPresentationalRole() const;
331     
332     mutable AccessibilityRole m_roleForMSAA;
333 };
334
335 inline AccessibilityRenderObject* toAccessibilityRenderObject(AccessibilityObject* object)
336 {
337     ASSERT(!object || object->isAccessibilityRenderObject());
338     return static_cast<AccessibilityRenderObject*>(object);
339 }
340
341 inline const AccessibilityRenderObject* toAccessibilityRenderObject(const AccessibilityObject* object)
342 {
343     ASSERT(!object || object->isAccessibilityRenderObject());
344     return static_cast<const AccessibilityRenderObject*>(object);
345 }
346
347 // This will catch anyone doing an unnecessary cast.
348 void toAccessibilityRenderObject(const AccessibilityRenderObject*);
349
350 } // namespace WebCore
351
352 #endif // AccessibilityRenderObject_h