WebCore:
[WebKit-https.git] / WebCore / page / 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 HTMLSelectElement;
46 class IntPoint;
47 class IntSize;
48 class Node;
49 class RenderObject;
50 class RenderListBox;
51 class RenderTextControl;
52 class Selection;
53 class String;
54 class Widget;
55     
56 class AccessibilityRenderObject : public AccessibilityObject {
57 protected:
58     AccessibilityRenderObject(RenderObject*);
59 public:
60     static PassRefPtr<AccessibilityRenderObject> create(RenderObject*);
61     virtual ~AccessibilityRenderObject();
62     
63     bool isAccessibilityRenderObject() const { return true; };
64     
65     virtual bool isAnchor() const;
66     virtual bool isAttachment() const;
67     virtual bool isHeading() const;
68     virtual bool isLink() const;
69     virtual bool isImageButton() const;
70     virtual bool isImage() const;
71     virtual bool isNativeImage() const;
72     virtual bool isPasswordField() const;
73     virtual bool isTextControl() const;
74     virtual bool isNativeTextControl() const;
75     virtual bool isWebArea() const;
76     virtual bool isCheckboxOrRadio() const;
77     virtual bool isFileUploadButton() const;
78     virtual bool isProgressIndicator() const;
79     virtual bool isSlider() const;
80     virtual bool isMenuRelated() const;
81     virtual bool isMenu() const;
82     virtual bool isMenuBar() const;
83     virtual bool isMenuButton() const;
84     virtual bool isMenuItem() const;
85     virtual bool isControl() const;
86
87     virtual bool isEnabled() const;
88     virtual bool isSelected() const;
89     virtual bool isFocused() const;
90     virtual bool isChecked() const;
91     virtual bool isHovered() const;
92     virtual bool isIndeterminate() const;
93     virtual bool isLoaded() const;
94     virtual bool isMultiSelect() const;
95     virtual bool isOffScreen() const;
96     virtual bool isPressed() const;
97     virtual bool isReadOnly() const;
98     virtual bool isVisited() const;        
99
100     const AtomicString& getAttribute(const QualifiedName&) const;
101     virtual bool canSetFocusAttribute() const;
102     virtual bool canSetTextRangeAttributes() const;
103     virtual bool canSetValueAttribute() const;
104     
105     virtual bool hasIntValue() const;
106     
107     virtual bool accessibilityIsIgnored() const;
108     
109     static int headingLevel(Node*);
110     virtual int intValue() const;
111     virtual float valueForRange() const;
112     virtual float maxValueForRange() const;
113     virtual float minValueForRange() const;
114     virtual int layoutCount() const;
115     
116     virtual AccessibilityObject* doAccessibilityHitTest(const IntPoint&) const;
117     virtual AccessibilityObject* focusedUIElement() const;
118     virtual AccessibilityObject* firstChild() const;
119     virtual AccessibilityObject* lastChild() const;
120     virtual AccessibilityObject* previousSibling() const;
121     virtual AccessibilityObject* nextSibling() const;
122     virtual AccessibilityObject* parentObject() const;
123     virtual AccessibilityObject* observableObject() const;
124     virtual void linkedUIElements(AccessibilityChildrenVector&) const;
125     virtual AccessibilityObject* titleUIElement() const;
126     virtual AccessibilityRole ariaRoleAttribute() const;
127     virtual bool isPresentationalChildOfAriaRole() const;
128     virtual bool ariaRoleHasPresentationalChildren() const;
129     void setAriaRole();
130     virtual AccessibilityRole roleValue() const;
131     virtual AXObjectCache* axObjectCache() const;
132     
133     virtual Element* actionElement() const;
134     Element* mouseButtonListener() const;
135     FrameView* frameViewIfRenderView() const;
136     virtual HTMLAnchorElement* anchorElement() const;
137     HTMLAreaElement* areaElement() const { return m_areaElement.get(); }
138     AccessibilityObject* menuForMenuButton() const;
139     AccessibilityObject* menuButtonForMenu() const;
140     
141     virtual IntRect boundingBoxRect() const;
142     virtual IntRect elementRect() const;
143     virtual IntSize size() const;
144     
145     void setRenderer(RenderObject* renderer) { m_renderer = renderer; }
146     RenderObject* renderer() const { return m_renderer; }
147     RenderObject* topRenderer() const;
148     RenderTextControl* textControl() const;
149     Document* document() const;
150     FrameView* topDocumentFrameView() const;  
151     HTMLLabelElement* labelElementContainer() const;
152     
153     virtual KURL url() const;
154     virtual PlainTextRange selectedTextRange() const;
155     virtual Selection selection() const;
156     virtual String stringValue() const;
157     virtual String ariaAccessiblityName(const String&) const;
158     virtual String ariaLabeledByAttribute() const;
159     virtual String title() const;
160     virtual String ariaDescribedByAttribute() const;
161     virtual String accessibilityDescription() const;
162     virtual String helpText() const;
163     virtual String textUnderElement() const;
164     virtual String text() const;
165     virtual int textLength() const;
166     virtual PassRefPtr<Range> ariaSelectedTextDOMRange() const;
167     virtual String selectedText() const;
168     virtual const AtomicString& accessKey() const;
169     virtual const String& actionVerb() const;
170     virtual Widget* widget() const;
171     virtual Widget* widgetForAttachmentView() const;
172     virtual void getDocumentLinks(AccessibilityChildrenVector&) const;
173     virtual FrameView* documentFrameView() const;
174     
175     virtual const AccessibilityChildrenVector& children();
176     
177     virtual void setFocused(bool);
178     virtual void setSelectedTextRange(const PlainTextRange&);
179     virtual void setValue(const String&);
180     
181     virtual void detach();
182     virtual void childrenChanged();
183     virtual void addChildren();
184     virtual void selectedChildren(AccessibilityChildrenVector&);
185     virtual void visibleChildren(AccessibilityChildrenVector&);
186     virtual bool shouldFocusActiveDescendant() const;
187     virtual AccessibilityObject* activeDescendant() const;
188     virtual void handleActiveDescendantChanged();
189
190     virtual VisiblePositionRange visiblePositionRange() const;
191     virtual VisiblePositionRange visiblePositionRangeForLine(unsigned) const;
192     virtual IntRect boundsForVisiblePositionRange(const VisiblePositionRange&) const;
193     virtual void setSelectedVisiblePositionRange(const VisiblePositionRange&) const;
194     
195     virtual VisiblePosition visiblePositionForPoint(const IntPoint&) const;
196     virtual VisiblePosition visiblePositionForIndex(unsigned indexValue, bool lastIndexOK) const;    
197     virtual int index(const VisiblePosition&) const;
198
199     virtual VisiblePosition visiblePositionForIndex(int) const;
200     virtual int indexForVisiblePosition(const VisiblePosition&) const;
201     
202     virtual PlainTextRange doAXRangeForLine(unsigned) const;
203     virtual PlainTextRange doAXRangeForIndex(unsigned) const;
204     
205     virtual String doAXStringForRange(const PlainTextRange&) const;
206     virtual IntRect doAXBoundsForRange(const PlainTextRange&) const;
207     
208 protected:
209     RenderObject* m_renderer;
210     RefPtr<HTMLAreaElement> m_areaElement;
211     AccessibilityRole m_ariaRole;
212     
213     void setRenderObject(RenderObject* renderer) { m_renderer = renderer; }
214     virtual void removeAXObjectID();
215     
216     virtual bool isDetached() const { return !m_renderer; }
217
218 private:
219     void ariaListboxSelectedChildren(AccessibilityChildrenVector&);
220     void ariaListboxVisibleChildren(AccessibilityChildrenVector&);
221
222     Element* menuElementForMenuButton() const;
223     Element* menuItemElementForMenu() const; 
224     AccessibilityRole determineAriaRoleAttribute() const;
225
226     IntRect checkboxOrRadioRect() const;
227     void addRadioButtonGroupMembers(AccessibilityChildrenVector& linkedUIElements) const;
228     AccessibilityObject* internalLinkElement() const;
229 };
230     
231 } // namespace WebCore
232
233 #endif // AccessibilityRenderObject_h