1 /* 2 * Copyright (c) 2023-2024 Huawei Device Co., Ltd. 3 * Licensed under the Apache License, Version 2.0 (the "License"); 4 * you may not use this file except in compliance with the License. 5 * You may obtain a copy of the License at 6 * 7 * http://www.apache.org/licenses/LICENSE-2.0 8 * 9 * Unless required by applicable law or agreed to in writing, software 10 * distributed under the License is distributed on an "AS IS" BASIS, 11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12 * See the License for the specific language governing permissions and 13 * limitations under the License. 14 */ 15 16 #ifndef FOUNDATION_ACE_FRAMEWORKS_CORE_COMPONENTS_NG_PATTERN_SCROLLABLE_SCROLL_CONTROLLER_H 17 #define FOUNDATION_ACE_FRAMEWORKS_CORE_COMPONENTS_NG_PATTERN_SCROLLABLE_SCROLL_CONTROLLER_H 18 19 #include "core/components/scroll/scroll_controller_base.h" 20 21 namespace OHOS::Ace::NG { 22 class ScrollablePattern; 23 class ACE_EXPORT ScrollableController : public ScrollControllerBase { 24 DECLARE_ACE_TYPE(ScrollableController, ScrollControllerBase); 25 26 public: 27 ScrollableController() = default; 28 29 ~ScrollableController() override = default; 30 SetScrollPattern(const WeakPtr<ScrollablePattern> & scroll)31 void SetScrollPattern(const WeakPtr<ScrollablePattern>& scroll) 32 { 33 scroll_ = scroll; 34 } 35 GetScrollPattern()36 const WeakPtr<ScrollablePattern>& GetScrollPattern() 37 { 38 return scroll_; 39 } 40 void ScrollToIndex(int32_t index, bool smooth, ScrollAlign align, std::optional<float> extraOffset) override; 41 bool AnimateTo(const Dimension& position, float duration, const RefPtr<Curve>& curve, bool smooth, 42 bool canOverScroll = false) override; 43 Offset GetCurrentOffset() const override; 44 Axis GetScrollDirection() const override; 45 void ScrollBy(double pixelX, double pixelY, bool smooth) override; 46 void ScrollToEdge(ScrollEdgeType scrollEdgeType, float velocity) override; 47 void ScrollToEdge(ScrollEdgeType scrollEdgeType, bool smooth) override; 48 void ScrollPage(bool reverse, bool smooth) override; 49 void Fling(double flingVelocity) override; 50 bool IsAtEnd() const override; 51 Rect GetItemRect(int32_t index) const override; 52 int32_t GetItemIndex(double x, double y) const override; 53 SetObserver(const ScrollerObserver & observer)54 void SetObserver(const ScrollerObserver& observer) override 55 { 56 observer_ = observer; 57 } 58 GetObserver()59 ScrollerObserver GetObserver() 60 { 61 return observer_; 62 } 63 64 protected: 65 WeakPtr<ScrollablePattern> scroll_; 66 ScrollerObserver observer_; 67 }; 68 } // namespace OHOS::Ace::NG 69 70 #endif // FOUNDATION_ACE_FRAMEWORKS_CORE_COMPONENTS_NG_PATTERN_SCROLLABLE_SCROLL_CONTROLLER_H 71