src/third_party/WebKit/Source/core/accessibility/AXScrollView.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 AXScrollView_h
  27 #define AXScrollView_h
  28
  29 #include "core/accessibility/AXObject.h"
  30
  31 namespace blink {
  32
  33 class AXScrollbar;
  34 class Scrollbar;
  35 class FrameView;
  36
  37 class AXScrollView final : public AXObject {
  38 public:
  39     static PassRefPtr<AXScrollView> create(FrameView*);
  40     virtual AccessibilityRole roleValue() const override { return ScrollAreaRole; }
  41     FrameView* scrollView() const { return m_scrollView; }
  42
  43     virtual ~AXScrollView();
  44     virtual void detach() override;
  45
  46 protected:
  47     virtual ScrollableArea* getScrollableAreaIfScrollable() const override;
  48     virtual void scrollTo(const IntPoint&) const override;
  49
  50 private:
  51     explicit AXScrollView(FrameView*);
  52
  53     virtual bool computeAccessibilityIsIgnored() const override;
  54     virtual bool isAXScrollView() const override { return true; }
  55     virtual bool isEnabled() const override { return true; }
  56
  57     virtual bool isAttachment() const override;
  58     virtual Widget* widgetForAttachmentView() const override;
  59
  60     virtual AXObject* scrollBar(AccessibilityOrientation) override;
  61     virtual void addChildren() override;
  62     virtual void clearChildren() override;
  63     virtual AXObject* accessibilityHitTest(const IntPoint&) const override;
  64     virtual void updateChildrenIfNecessary() override;
  65     virtual void setNeedsToUpdateChildren() override { m_childrenDirty = true; }
  66     void updateScrollbars();
  67
  68     virtual FrameView* documentFrameView() const override;
  69     virtual LayoutRect elementRect() const override;
  70     virtual AXObject* computeParent() const override;
  71     virtual AXObject* computeParentIfExists() const override;
  72
  73     AXObject* webAreaObject() const;
  74     virtual AXObject* firstChild() const override { return webAreaObject(); }
  75     AXScrollbar* addChildScrollbar(Scrollbar*);
  76     void removeChildScrollbar(AXObject*);
  77
  78     // FIXME: Oilpan: Frame/ScrollView is on the heap and its
  79     // AXScrollView is detached&removed from the AX cache when the
  80     // FrameView is disposed. Which clears m_scrollView, hence this
  81     // bare pointer will not be stale, so the bare pointer use is safe
  82     // & acceptable.
  83     //
  84     // However, it would be preferable to have it be normally traced
  85     // as part of moving the AX objects to the heap. Temporarily using
  86     // a Persistent risks creating a FrameView leak, and brings no
  87     // real benefits overall.
  88     FrameView* m_scrollView;
  89     RefPtr<AXObject> m_horizontalScrollbar;
  90     RefPtr<AXObject> m_verticalScrollbar;
  91     bool m_childrenDirty;
  92 };
  93
  94 DEFINE_AX_OBJECT_TYPE_CASTS(AXScrollView, isAXScrollView());
  95
  96 } // namespace blink
  97
  98 #endif // AXScrollView_h