1 /* 2 * Copyright (c) 2022-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_PATTERNS_SCROLL_SCROLL_MODEL_NG_H 17 #define FOUNDATION_ACE_FRAMEWORKS_CORE_COMPONENTS_NG_PATTERNS_SCROLL_SCROLL_MODEL_NG_H 18 19 #include "core/components/scroll/scroll_controller_base.h" 20 #include "core/components_ng/pattern/scroll/scroll_model.h" 21 22 namespace OHOS::Ace::NG { 23 24 class ACE_EXPORT ScrollModelNG : public ScrollModel { 25 public: 26 ScrollModelNG() = default; 27 ~ScrollModelNG() override = default; 28 29 void Create() override; 30 RefPtr<ScrollControllerBase> GetOrCreateController() override; 31 RefPtr<ScrollProxy> CreateScrollBarProxy() override; 32 void SetAxis(Axis axis) override; 33 void SetOnScrollBegin(OnScrollBeginEvent&& event) override; 34 void SetOnScrollFrameBegin(OnScrollFrameBeginEvent&& event) override; 35 void SetOnScroll(NG::ScrollEvent&& event) override; 36 void SetOnWillScroll(NG::ScrollEventWithReturn&& event) override; 37 void SetOnDidScroll(NG::ScrollEventWithState&& event) override; 38 void SetOnScrollEdge(NG::ScrollEdgeEvent&& event) override; 39 void SetOnScrollEnd(NG::ScrollEndEvent&& event) override; 40 void SetOnScrollStart(OnScrollStartEvent&& event) override; 41 void SetOnScrollStop(OnScrollStopEvent&& event) override; 42 void SetOnReachStart(OnReachEvent&& onReachStart) override; 43 void SetOnReachEnd(OnReachEvent&& onReachEnd) override; 44 void SetScrollBarProxy(const RefPtr<ScrollProxy>& proxy) override; 45 void InitScrollBar(const RefPtr<ScrollBarTheme>& theme, const std::pair<bool, Color>& color, 46 const std::pair<bool, Dimension>& width, EdgeEffect effect) override; 47 void SetDisplayMode(int displayMode) override; 48 void SetScrollBarWidth(const Dimension& dimension) override; 49 void SetScrollBarColor(const Color& color) override; 50 void SetEdgeEffect(EdgeEffect edgeEffect, bool alwaysEnabled) override; SetHasWidth(bool hasWidth)51 void SetHasWidth(bool hasWidth) override {} SetHasHeight(bool hasHeight)52 void SetHasHeight(bool hasHeight) override {} 53 void SetNestedScroll(const NestedScrollOptions& nestedOpt) override; 54 void SetScrollEnabled(bool scrollEnabled) override; 55 void SetFriction(double friction) override; 56 void SetScrollSnap(ScrollSnapAlign scrollSnapAlign, const Dimension& intervalSize, 57 const std::vector<Dimension>& snapPaginations, const std::pair<bool, bool>& enableSnapToSide) override; 58 void SetEnablePaging(bool enablePaging) override; 59 void SetInitialOffset(const OffsetT<CalcDimension>& offset) override; 60 61 static RefPtr<FrameNode> CreateFrameNode(int32_t nodeId); 62 static void SetScrollController( 63 FrameNode* frameNode, const RefPtr<ScrollControllerBase>& scroller, const RefPtr<ScrollProxy>& proxy); 64 static void SetNestedScroll(FrameNode* frameNode, const NestedScrollOptions& nestedOpt); 65 static int32_t GetScrollEnabled(FrameNode* frameNode); 66 static void SetScrollEnabled(FrameNode* frameNode, bool scrollEnabled); 67 static float GetFriction(FrameNode* frameNode); 68 static void SetFriction(FrameNode* frameNode, double friction); 69 static ScrollSnapOptions GetScrollSnap(FrameNode* frameNode); 70 static void SetScrollSnap(FrameNode* frameNode, ScrollSnapAlign scrollSnapAlign, const Dimension& intervalSize, 71 const std::vector<Dimension>& snapPaginations, const std::pair<bool, bool>& enableSnapToSide); 72 static int32_t GetScrollBar(FrameNode* frameNode); 73 static void SetScrollBar(FrameNode* frameNode, DisplayMode barState); 74 static int32_t GetAxis(FrameNode* frameNode); 75 static void SetAxis(FrameNode* frameNode, Axis axis); 76 static uint32_t GetScrollBarColor(FrameNode* frameNode); 77 static void SetScrollBarColor(FrameNode* frameNode, const Color& color); 78 static float GetScrollBarWidth(FrameNode* frameNode); 79 static void SetScrollBarWidth(FrameNode* frameNode, const Dimension& dimension); 80 static int32_t GetEdgeEffect(FrameNode* frameNode); 81 static int32_t GetEdgeEffectAlways(FrameNode* frameNode); 82 static void SetEdgeEffect(FrameNode* frameNode, const EdgeEffect& edgeEffect, bool alwaysEnabled); 83 static int32_t GetEnablePaging(FrameNode* frameNode); 84 static void SetEnablePaging(FrameNode* frameNode, bool enablePaging); 85 static void SetOnScroll(FrameNode* frameNode, NG::ScrollEvent&& event); 86 static void SetOnScrollFrameBegin(FrameNode* frameNode, OnScrollFrameBeginEvent&& event); 87 static void SetOnScrollStart(FrameNode* frameNode, OnScrollStartEvent&& event); 88 static void SetOnScrollStop(FrameNode* frameNode, OnScrollStopEvent&& event); 89 90 static RefPtr<ScrollControllerBase> GetOrCreateController(FrameNode* frameNode); 91 static void SetOnScrollEdge(FrameNode* frameNode, NG::ScrollEdgeEvent&& event); 92 static NestedScrollOptions GetNestedScroll(FrameNode* frameNode); 93 static ScrollEdgeType GetOnScrollEdge(FrameNode* frameNode); 94 static void SetOnWillScroll(FrameNode* frameNode, NG::ScrollEventWithReturn&& event); 95 static void SetOnDidScroll(FrameNode* frameNode, NG::ScrollEventWithState&& event); 96 static void SetOnReachStart(FrameNode* frameNode, OnReachEvent&& onReachStart); 97 static void SetOnReachEnd(FrameNode* frameNode, OnReachEvent&& onReachEnd); 98 static void SetInitialOffset(FrameNode* frameNode, const OffsetT<CalcDimension>& offset); 99 static void SetScrollBarProxy(FrameNode* frameNode, const RefPtr<ScrollProxy>& proxy); 100 }; 101 102 } // namespace OHOS::Ace::NG 103 104 #endif // FOUNDATION_ACE_FRAMEWORKS_CORE_COMPONENTS_NG_PATTERNS_SCROLL_SCROLL_MODEL_NG_H 105