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 HTMLSelectElement;
45 class IntPoint;
46 class IntSize;
47 class Node;
48 class RenderObject;
49 class RenderListBox;
50 class RenderTextControl;
51 class Selection;
52 class String;
53 class Widget;
54     
55 class AccessibilityRenderObject : public AccessibilityObject {
56 protected:
57     AccessibilityRenderObject(RenderObject*);
58 public:
59     static PassRefPtr<AccessibilityRenderObject> create(RenderObject*);
60     virtual ~AccessibilityRenderObject();
61     
62     bool isAccessibilityRenderObject() const { return true; };
63     
64     virtual bool isAnchor() const;
65     virtual bool isAttachment() const;
66     virtual bool isHeading() const;
67     virtual bool isLink() const;
68     virtual bool isImageButton() const;
69     virtual bool isImage() const;
70     virtual bool isNativeImage() const;
71     virtual bool isPasswordField() const;
72     virtual bool isTextControl() const;
73     virtual bool isNativeTextControl() const;
74     virtual bool isWebArea() const;
75     virtual bool isCheckboxOrRadio() const;
76     
77     virtual bool isEnabled() const;
78     virtual bool isSelected() const;
79     virtual bool isFocused() const;
80     virtual bool isChecked() const;
81     virtual bool isHovered() const;
82     virtual bool isIndeterminate() const;
83     virtual bool isLoaded() const;
84     virtual bool isMultiSelect() const;
85     virtual bool isOffScreen() const;
86     virtual bool isPressed() const;
87     virtual bool isReadOnly() const;
88     virtual bool isVisited() const;        
89     
90     virtual bool canSetFocusAttribute() const;
91     virtual bool canSetTextRangeAttributes() const;
92     virtual bool canSetValueAttribute() const;
93     
94     virtual bool hasIntValue() const;
95     
96     virtual bool accessibilityShouldUseUniqueId() const;
97     virtual bool accessibilityIsIgnored() const;
98     
99     static int headingLevel(Node*);
100     virtual int intValue() const;
101     virtual int layoutCount() const;
102     
103     virtual AccessibilityObject* doAccessibilityHitTest(const IntPoint&) const;
104     virtual AccessibilityObject* focusedUIElement() const;
105     virtual AccessibilityObject* firstChild() const;
106     virtual AccessibilityObject* lastChild() const;
107     virtual AccessibilityObject* previousSibling() const;
108     virtual AccessibilityObject* nextSibling() const;
109     virtual AccessibilityObject* parentObject() const;
110     virtual AccessibilityObject* observableObject() const;
111     virtual AccessibilityObject* linkedUIElement() const;
112     virtual AccessibilityRole ariaRoleAttribute() const;
113     virtual AccessibilityRole roleValue() const;
114     virtual AXObjectCache* axObjectCache() const;
115     
116     virtual Element* actionElement() const;
117     Element* mouseButtonListener() const;
118     FrameView* frameViewIfRenderView() const;
119     virtual HTMLAnchorElement* anchorElement() const;
120     HTMLAreaElement* areaElement() const { return m_areaElement.get(); }
121     
122     virtual IntRect boundingBoxRect() const;
123     virtual IntRect elementRect() const;
124     virtual IntSize size() const;
125     
126     void setRenderer(RenderObject* renderer) { m_renderer = renderer; }
127     RenderObject* renderer() const { return m_renderer; }
128     RenderObject* topRenderer() const;
129     RenderTextControl* textControl() const;
130     Document* document() const;
131     FrameView* topDocumentFrameView() const;  
132     
133     virtual KURL url() const;
134     virtual PlainTextRange selectedTextRange() const;
135     virtual Selection selection() const;
136     virtual String stringValue() const;
137     virtual String ariaAccessiblityName(const String&) const;
138     virtual String ariaLabeledByAttribute() const;
139     virtual String title() const;
140     virtual String ariaDescribedByAttribute() const;
141     virtual String accessibilityDescription() const;
142     virtual String helpText() const;
143     virtual String textUnderElement() const;
144     virtual String text() const;
145     virtual int textLength() const;
146     virtual PassRefPtr<Range> ariaSelectedTextDOMRange() const;
147     virtual String selectedText() const;
148     virtual const AtomicString& accessKey() const;
149     virtual const String& actionVerb() const;
150     virtual Widget* widget() const;
151     virtual Widget* widgetForAttachmentView() const;
152     virtual void getDocumentLinks(Vector< RefPtr<AccessibilityObject> >&) const;
153     virtual FrameView* documentFrameView() const;
154     
155     virtual const Vector<RefPtr<AccessibilityObject> >& children();
156     
157     virtual void setFocused(bool);
158     virtual void setSelectedTextRange(const PlainTextRange&);
159     virtual void setValue(const String&);
160     
161     virtual void detach();
162     virtual void childrenChanged();
163     virtual void addChildren();
164     
165     virtual VisiblePositionRange visiblePositionRange() const;
166     virtual VisiblePositionRange doAXTextMarkerRangeForLine(unsigned) const;
167     virtual IntRect doAXBoundsForTextMarkerRange(const VisiblePositionRange&) const;
168     virtual void doSetAXSelectedTextMarkerRange(const VisiblePositionRange&) const;
169     
170     virtual VisiblePosition doAXTextMarkerForPosition(const IntPoint&) const;
171     virtual VisiblePosition textMarkerForIndex(unsigned indexValue, bool lastIndexOK) const;    
172     virtual int indexForTextMarker(const VisiblePosition&) const;
173
174     virtual VisiblePosition visiblePositionForIndex(int) const;
175     virtual int indexForVisiblePosition(const VisiblePosition&) const;
176     
177     virtual PlainTextRange doAXRangeForLine(unsigned) const;
178     virtual PlainTextRange doAXRangeForIndex(unsigned) const;
179     
180     virtual String doAXStringForRange(const PlainTextRange&) const;
181     virtual IntRect doAXBoundsForRange(const PlainTextRange&) const;
182     
183     
184 protected:
185     RenderObject* m_renderer;
186     RefPtr<HTMLAreaElement> m_areaElement;
187     
188     void setRenderObject(RenderObject* renderer) { m_renderer = renderer; }
189     virtual void removeAXObjectID();
190     
191     virtual bool isDetached() const { return !m_renderer; }    
192 };
193     
194 } // namespace WebCore
195
196 #endif // AccessibilityRenderObject_h