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.get(); }
  42
  43 protected:
  44     virtual ScrollableArea* getScrollableAreaIfScrollable() const;
  45     virtual void scrollTo(const IntPoint&) const;
  46
  47 private:
  48     AccessibilityScrollView(ScrollView*);
  49
  50     virtual bool accessibilityIsIgnored() const;
  51     virtual bool isAccessibilityScrollView() const { return true; }
  52     virtual bool isEnabled() const { return true; }
  53
  54     virtual bool isAttachment() const;
  55     virtual Widget* widgetForAttachmentView() const;
  56
  57     virtual AccessibilityObject* scrollBar(AccessibilityOrientation);
  58     virtual void addChildren();
  59     virtual void clearChildren();
  60     virtual AccessibilityObject* accessibilityHitTest(const IntPoint&) const;
  61     virtual void updateChildrenIfNecessary();
  62     virtual void setNeedsToUpdateChildren() { m_childrenDirty = true; }
  63     void updateScrollbars();
  64
  65     virtual FrameView* documentFrameView() const;
  66     virtual LayoutRect elementRect() const;
  67     virtual AccessibilityObject* parentObject() const;
  68     virtual AccessibilityObject* parentObjectIfExists() const;
  69
  70     AccessibilityObject* webAreaObject() const;
  71     virtual AccessibilityObject* firstChild() const { return webAreaObject(); }
  72     AccessibilityScrollbar* addChildScrollbar(Scrollbar*);
  73     void removeChildScrollbar(AccessibilityObject*);
  74
  75     RefPtr<ScrollView> m_scrollView;
  76     RefPtr<AccessibilityObject> m_horizontalScrollbar;
  77     RefPtr<AccessibilityObject> m_verticalScrollbar;
  78     bool m_childrenDirty;
  79 };
  80
  81 inline AccessibilityScrollView* toAccessibilityScrollView(AccessibilityObject* object)
  82 {
  83     ASSERT(!object || object->isAccessibilityScrollView());
  84     if (!object->isAccessibilityScrollView())
  85         return 0;
  86
  87     return static_cast<AccessibilityScrollView*>(object);
  88 }
  89
  90 } // namespace WebCore
  91
  92 #endif // AccessibilityScrollView_h