OLD | NEW |
1 // Copyright 2014 The Chromium Authors. All rights reserved. | 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 | 2 // Use of this source code is governed by a BSD-style license that can be |
3 // found in the LICENSE file. | 3 // found in the LICENSE file. |
4 | 4 |
5 #ifndef UI_ANDROID_OVERSCROLL_REFRESH_H_ | 5 #ifndef UI_ANDROID_OVERSCROLL_REFRESH_H_ |
6 #define UI_ANDROID_OVERSCROLL_REFRESH_H_ | 6 #define UI_ANDROID_OVERSCROLL_REFRESH_H_ |
7 | 7 |
8 #include "base/macros.h" | 8 #include "base/macros.h" |
9 #include "ui/android/ui_android_export.h" | 9 #include "ui/android/ui_android_export.h" |
10 #include "ui/gfx/geometry/size_f.h" | 10 #include "ui/gfx/geometry/size_f.h" |
(...skipping 19 matching lines...) Expand all Loading... |
30 enum { kMinPullsToActivate = 3 }; | 30 enum { kMinPullsToActivate = 3 }; |
31 | 31 |
32 explicit OverscrollRefresh(OverscrollRefreshHandler* handler); | 32 explicit OverscrollRefresh(OverscrollRefreshHandler* handler); |
33 ~OverscrollRefresh(); | 33 ~OverscrollRefresh(); |
34 | 34 |
35 // Scroll event stream listening methods. | 35 // Scroll event stream listening methods. |
36 void OnScrollBegin(); | 36 void OnScrollBegin(); |
37 // Returns whether the refresh was activated. | 37 // Returns whether the refresh was activated. |
38 void OnScrollEnd(const gfx::Vector2dF& velocity); | 38 void OnScrollEnd(const gfx::Vector2dF& velocity); |
39 | 39 |
40 // Scroll ack listener. The effect will only be activated if the initial | 40 // Scroll ack listener. The effect will only be activated if the controller |
41 // updates go unconsumed. | 41 // decides it can navigate if the scroll_update is not consumed and the |
42 void OnScrollUpdateAck(bool was_consumed); | 42 // scroll_boundary_behavior on y axis is 'auto'. See how it's called in |
| 43 // OverscrollControllerAndroid. |
| 44 virtual void OnOverscrolled(bool can_navigate); |
43 | 45 |
44 // Returns true if the effect has consumed the |scroll_delta|. | 46 // Returns true if the effect has consumed the |scroll_delta|. |
45 bool WillHandleScrollUpdate(const gfx::Vector2dF& scroll_delta); | 47 bool WillHandleScrollUpdate(const gfx::Vector2dF& scroll_delta); |
46 | 48 |
47 // Release the effect (if active), preventing any associated refresh action. | 49 // Release the effect (if active), preventing any associated refresh action. |
48 void ReleaseWithoutActivation(); | 50 void ReleaseWithoutActivation(); |
49 | 51 |
50 // Notify the effect of the latest scroll offset and overflow properties. | 52 // Notify the effect of the latest scroll offset and overflow properties. |
51 // The effect will be disabled when the offset is non-zero or overflow is | 53 // The effect will be disabled when the offset is non-zero or overflow is |
52 // hidden. Note: All dimensions are in device pixels. | 54 // hidden. Note: All dimensions are in device pixels. |
53 void OnFrameUpdated(const gfx::Vector2dF& content_scroll_offset, | 55 void OnFrameUpdated(const gfx::Vector2dF& content_scroll_offset, |
54 bool root_overflow_y_hidden); | 56 bool root_overflow_y_hidden); |
55 | 57 |
56 // Reset the effect to its inactive state, immediately detaching and | 58 // Reset the effect to its inactive state, immediately detaching and |
57 // disabling any active effects. | 59 // disabling any active effects. |
58 void Reset(); | 60 void Reset(); |
59 | 61 |
60 // Returns true if the refresh effect is either being manipulated or animated. | 62 // Returns true if the refresh effect is either being manipulated or animated. |
61 bool IsActive() const; | 63 virtual bool IsActive() const; |
62 | 64 |
63 // Returns true if the effect is waiting for an unconsumed scroll to start. | 65 // Returns true if the effect is waiting for an unconsumed scroll to start. |
64 bool IsAwaitingScrollUpdateAck() const; | 66 virtual bool IsAwaitingScrollUpdateAck() const; |
65 | 67 |
66 private: | 68 private: |
67 void Release(bool allow_refresh); | 69 void Release(bool allow_refresh); |
68 | 70 |
69 bool scrolled_to_top_; | 71 bool scrolled_to_top_; |
70 bool overflow_y_hidden_; | 72 bool overflow_y_hidden_; |
71 | 73 |
72 enum ScrollConsumptionState { | 74 enum ScrollConsumptionState { |
73 DISABLED, | 75 DISABLED, |
74 AWAITING_SCROLL_UPDATE_ACK, | 76 AWAITING_SCROLL_UPDATE_ACK, |
75 ENABLED, | 77 ENABLED, |
76 } scroll_consumption_state_; | 78 } scroll_consumption_state_; |
77 | 79 |
78 OverscrollRefreshHandler* const handler_; | 80 OverscrollRefreshHandler* const handler_; |
79 | 81 |
80 DISALLOW_COPY_AND_ASSIGN(OverscrollRefresh); | 82 DISALLOW_COPY_AND_ASSIGN(OverscrollRefresh); |
81 }; | 83 }; |
82 | 84 |
83 } // namespace ui | 85 } // namespace ui |
84 | 86 |
85 #endif // UI_ANDROID_OVERSCROLL_REFRESH_H_ | 87 #endif // UI_ANDROID_OVERSCROLL_REFRESH_H_ |
OLD | NEW |