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