AX: move isIgnored caching to AXObject
[WebKit-https.git] / Source / WebCore / accessibility / AccessibilityNodeObject.h
1 /*
2  * Copyright (C) 2012, Google 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 AccessibilityNodeObject_h
30 #define AccessibilityNodeObject_h
31
32 #include "AccessibilityObject.h"
33 #include "LayoutRect.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 AccessibilityNodeObject : public AccessibilityObject {
59 protected:
60     explicit AccessibilityNodeObject(Node*);
61 public:
62     static PassRefPtr<AccessibilityNodeObject> create(Node*);
63     virtual ~AccessibilityNodeObject();
64
65     virtual void init();
66     
67     virtual bool isAccessibilityNodeObject() const { return true; }
68
69     virtual bool canvasHasFallbackContent() const;
70
71     virtual bool isAnchor() const;
72     virtual bool isControl() const;
73     virtual bool isFieldset() const;
74     virtual bool isGroup() const;
75     virtual bool isHeading() const;
76     virtual bool isHovered() const;
77     virtual bool isImage() const;
78     virtual bool isImageButton() const;
79     virtual bool isInputImage() const;
80     virtual bool isLink() const;
81     virtual bool isMenu() const;
82     virtual bool isMenuBar() const;
83     virtual bool isMenuButton() const;
84     virtual bool isMenuItem() const;
85     virtual bool isMenuRelated() const;
86     virtual bool isMultiSelectable() const;
87     virtual bool isNativeCheckboxOrRadio() const;
88     virtual bool isNativeImage() const;
89     virtual bool isNativeTextControl() const;
90     virtual bool isPasswordField() const;
91     virtual bool isProgressIndicator() const;
92     virtual bool isSearchField() const;
93     virtual bool isSlider() const;
94
95     virtual bool isChecked() const;
96     virtual bool isEnabled() const;
97     virtual bool isIndeterminate() const;
98     virtual bool isPressed() const;
99     virtual bool isReadOnly() const;
100     virtual bool isRequired() const;
101
102     void setNode(Node*);
103     virtual Node* node() const { return m_node; }
104     virtual Document* document() const;
105
106     virtual bool canSetFocusAttribute() const;
107     virtual int headingLevel() const;
108
109     virtual String valueDescription() const;
110     virtual float valueForRange() const;
111     virtual float maxValueForRange() const;
112     virtual float minValueForRange() const;
113     virtual float stepValueForRange() const;
114
115     virtual AccessibilityObject* selectedRadioButton();
116     virtual AccessibilityObject* selectedTabItem();
117     virtual AccessibilityButtonState checkboxOrRadioValue() const;
118
119     virtual unsigned hierarchicalLevel() const;
120     virtual String textUnderElement() const;
121     virtual String accessibilityDescription() const;
122     virtual String helpText() const;
123     virtual String title() const;
124     virtual String text() const;
125     virtual String stringValue() const;
126     virtual void colorValue(int& r, int& g, int& b) const;
127     virtual String ariaLabeledByAttribute() const;
128
129     virtual Element* actionElement() const;
130     Element* mouseButtonListener() const;
131     virtual Element* anchorElement() const;
132     AccessibilityObject* menuForMenuButton() const;
133    
134     virtual void changeValueByPercent(float percentChange);
135  
136     virtual AccessibilityObject* firstChild() const;
137     virtual AccessibilityObject* lastChild() const;
138     virtual AccessibilityObject* previousSibling() const;
139     virtual AccessibilityObject* nextSibling() const;
140     virtual AccessibilityObject* parentObject() const;
141     virtual AccessibilityObject* parentObjectIfExists() const;
142
143     virtual void detach();
144     virtual void childrenChanged();
145     virtual void updateAccessibilityRole();
146
147     virtual void increment();
148     virtual void decrement();
149
150     virtual LayoutRect elementRect() const;
151
152 protected:
153     AccessibilityRole m_ariaRole;
154     bool m_childrenDirty;
155     mutable AccessibilityRole m_roleForMSAA;
156 #ifndef NDEBUG
157     bool m_initialized;
158 #endif
159
160     virtual bool isDetached() const { return !m_node; }
161
162     virtual AccessibilityRole determineAccessibilityRole();
163     virtual void addChildren();
164     virtual void addChild(AccessibilityObject*);
165     virtual void insertChild(AccessibilityObject*, unsigned index);
166
167     virtual bool canHaveChildren() const;
168     AccessibilityRole ariaRoleAttribute() const;
169     AccessibilityRole determineAriaRoleAttribute() const;
170     AccessibilityRole remapAriaRoleDueToParent(AccessibilityRole) const;
171     bool hasContentEditableAttributeSet() const;
172     bool isDescendantOfBarrenParent() const;
173     void alterSliderValue(bool increase);
174     void changeValueByStep(bool increase);
175     bool isARIARange() const;
176     // This returns true if it's focusable but it's not content editable and it's not a control or ARIA control.
177     bool isGenericFocusableElement() const;
178     HTMLLabelElement* labelForElement(Element*) const;
179     String ariaAccessibilityDescription() const;
180     void ariaLabeledByElements(Vector<Element*>& elements) const;
181     String accessibilityDescriptionForElements(Vector<Element*> &elements) const;
182     void elementsFromAttribute(Vector<Element*>& elements, const QualifiedName&) const;
183     virtual LayoutRect boundingBoxRect() const;
184     String ariaDescribedByAttribute() const;
185     
186     Element* menuElementForMenuButton() const;
187     Element* menuItemElementForMenu() const;
188     AccessibilityObject* menuButtonForMenu() const;
189
190 private:
191     Node* m_node;
192
193     virtual void accessibilityText(Vector<AccessibilityText>&);
194     void titleElementText(Vector<AccessibilityText>&);
195     void alternativeText(Vector<AccessibilityText>&) const;
196     void visibleText(Vector<AccessibilityText>&) const;
197     void helpText(Vector<AccessibilityText>&) const;
198     String alternativeTextForWebArea() const;
199     void ariaLabeledByText(Vector<AccessibilityText>&) const;
200     virtual bool computeAccessibilityIsIgnored() const;
201 };
202
203 inline AccessibilityNodeObject* toAccessibilityNodeObject(AccessibilityObject* object)
204 {
205     ASSERT(!object || object->isAccessibilityNodeObject());
206     return static_cast<AccessibilityNodeObject*>(object);
207 }
208
209 inline const AccessibilityNodeObject* toAccessibilityNodeObject(const AccessibilityObject* object)
210 {
211     ASSERT(!object || object->isAccessibilityNodeObject());
212     return static_cast<const AccessibilityNodeObject*>(object);
213 }
214
215 // This will catch anyone doing an unnecessary cast.
216 void toAccessibilityNodeObject(const AccessibilityNodeObject*);
217
218 } // namespace WebCore
219
220 #endif // AccessibilityNodeObject_h