content/browser/android/overscroll_controller_android.h

   1 // Copyright 2014 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef CONTENT_BROWSER_ANDROID_OVERSCROLL_CONTROLLER_ANDROID_H_
   6 #define CONTENT_BROWSER_ANDROID_OVERSCROLL_CONTROLLER_ANDROID_H_
   7
   8 #include "base/time/time.h"
   9 #include "content/browser/android/overscroll_glow.h"
  10 #include "content/browser/android/overscroll_refresh.h"
  11 #include "content/common/input/input_event_ack_state.h"
  12 #include "content/public/browser/web_contents_observer.h"
  13 #include "ui/gfx/geometry/vector2d_f.h"
  14
  15 namespace blink {
  16 class WebGestureEvent;
  17 }
  18
  19 namespace cc {
  20 class CompositorFrameMetadata;
  21 class Layer;
  22 }
  23
  24 namespace ui {
  25 class WindowAndroidCompositor;
  26 }
  27
  28 namespace content {
  29
  30 struct DidOverscrollParams;
  31
  32 // Glue class for handling all inputs into Android-specific overscroll effects,
  33 // both the passive overscroll glow and the active overscroll pull-to-refresh.
  34 // Note that all input coordinates (both for events and overscroll) are in DIPs.
  35 class OverscrollControllerAndroid : public OverscrollGlowClient,
  36                                     public OverscrollRefreshClient,
  37                                     public WebContentsObserver {
  38  public:
  39   OverscrollControllerAndroid(WebContents* web_contents,
  40                               ui::WindowAndroidCompositor* compositor,
  41                               float dpi_scale);
  42   virtual ~OverscrollControllerAndroid();
  43
  44   // Returns true if |event| is consumed by an overscroll effect, in which
  45   // case it should cease propagation.
  46   bool WillHandleGestureEvent(const blink::WebGestureEvent& event);
  47
  48   // To be called upon receipt of a gesture event ack.
  49   void OnGestureEventAck(const blink::WebGestureEvent& event,
  50                          InputEventAckState ack_result);
  51
  52   // To be called upon receipt of an overscroll event.
  53   void OnOverscrolled(const DidOverscrollParams& overscroll_params);
  54
  55   // Returns true if the effect still needs animation ticks.
  56   // Note: The effect will detach itself when no further animation is required.
  57   bool Animate(base::TimeTicks current_time, cc::Layer* parent_layer);
  58
  59   // To be called whenever the content frame has been updated.
  60   void OnFrameMetadataUpdated(const cc::CompositorFrameMetadata& metadata);
  61
  62   // Toggle activity of any overscroll effects. When disabled, events will be
  63   // ignored until the controller is re-enabled.
  64   void Enable();
  65   void Disable();
  66
  67  private:
  68   // WebContentsObserver implementation.
  69   void DidNavigateMainFrame(const LoadCommittedDetails& details,
  70                             const FrameNavigateParams& params) override;
  71   void DidToggleFullscreenModeForTab(bool entered_fullscreen) override;
  72
  73   // OverscrollRefreshClient implementation.
  74   void TriggerRefresh() override;
  75   bool IsStillRefreshing() const override;
  76
  77   // OverscrollGlowClient implementation.
  78   scoped_ptr<EdgeEffectBase> CreateEdgeEffect() override;
  79
  80   void SetNeedsAnimate();
  81
  82   ui::WindowAndroidCompositor* compositor_;
  83   const float dpi_scale_;
  84
  85   bool enabled_;
  86
  87   // TODO(jdduke): Factor out a common API from the two overscroll effects.
  88   scoped_ptr<OverscrollGlow> glow_effect_;
  89   scoped_ptr<OverscrollRefresh> refresh_effect_;
  90   bool triggered_refresh_active_;
  91   bool is_fullscreen_;
  92
  93   DISALLOW_COPY_AND_ASSIGN(OverscrollControllerAndroid);
  94 };
  95
  96 }  // namespace content
  97
  98 #endif  // CONTENT_BROWSER_ANDROID_OVERSCROLL_CONTROLLER_ANDROID_H_