AX: Notification should be sent when accessibilityIsIgnored changes
[WebKit-https.git] / Source / WebCore / accessibility / AccessibilityScrollView.h
1 /*
2  * Copyright (C) 2011 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  *
14  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
15  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
16  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
17  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
18  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
19  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
20  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
21  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
23  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #ifndef AccessibilityScrollView_h
27 #define AccessibilityScrollView_h
28
29 #include "AccessibilityObject.h"
30
31 namespace WebCore {
32     
33 class AccessibilityScrollbar;
34 class Scrollbar;
35 class ScrollView;
36     
37 class AccessibilityScrollView : public AccessibilityObject {
38 public:
39     static PassRefPtr<AccessibilityScrollView> create(ScrollView*);    
40     virtual AccessibilityRole roleValue() const { return ScrollAreaRole; }
41     ScrollView* scrollView() const { return m_scrollView; }
42
43     virtual ~AccessibilityScrollView();
44     virtual void detach();
45
46 protected:
47     virtual ScrollableArea* getScrollableAreaIfScrollable() const;
48     virtual void scrollTo(const IntPoint&) const;
49     
50 private:
51     explicit AccessibilityScrollView(ScrollView*);
52     
53     virtual bool accessibilityIsIgnored() const;
54     virtual bool isAccessibilityScrollView() const { return true; }
55     virtual bool isEnabled() const { return true; }
56     
57     virtual bool isAttachment() const;
58     virtual Widget* widgetForAttachmentView() const;
59     
60     virtual AccessibilityObject* scrollBar(AccessibilityOrientation);
61     virtual void addChildren();
62     virtual void clearChildren();
63     virtual AccessibilityObject* accessibilityHitTest(const IntPoint&) const;
64     virtual void updateChildrenIfNecessary();
65     virtual void setNeedsToUpdateChildren() { m_childrenDirty = true; }
66     void updateScrollbars();
67     
68     virtual FrameView* documentFrameView() const;
69     virtual LayoutRect elementRect() const;
70     virtual AccessibilityObject* parentObject() const;
71     virtual AccessibilityObject* parentObjectIfExists() const;
72     
73     AccessibilityObject* webAreaObject() const;
74     virtual AccessibilityObject* firstChild() const { return webAreaObject(); }
75     AccessibilityScrollbar* addChildScrollbar(Scrollbar*);
76     void removeChildScrollbar(AccessibilityObject*);
77     
78     ScrollView* m_scrollView;
79     RefPtr<AccessibilityObject> m_horizontalScrollbar;
80     RefPtr<AccessibilityObject> m_verticalScrollbar;
81     bool m_childrenDirty;
82 };
83
84 inline AccessibilityScrollView* toAccessibilityScrollView(AccessibilityObject* object)
85 {
86     ASSERT(!object || object->isAccessibilityScrollView());
87     if (!object->isAccessibilityScrollView())
88         return 0;
89     
90     return static_cast<AccessibilityScrollView*>(object);
91 }
92     
93 } // namespace WebCore
94
95 #endif // AccessibilityScrollView_h