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, EffectEdge edge = EffectEdge::ALL) 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 void CreateWithResourceObjFriction(const RefPtr<ResourceObject>& resObj) override; 61 void CreateWithResourceObjIntervalSize(const RefPtr<ResourceObject>& resObj) override; 62 void CreateWithResourceObjSnapPaginations( 63 const std::vector<Dimension>& snapPaginations, std::vector<RefPtr<ResourceObject>>& resObjs) override; 64 void CreateWithResourceObjScrollBarColor(const RefPtr<ResourceObject>& resObj) override; 65 void SetMaxZoomScale(float scale) override; 66 void SetMinZoomScale(float scale) override; 67 void SetZoomScale(float scale) override; 68 void ResetZoomScale() override; 69 void SetZoomScaleChangeEvent(std::function<void(float)>&& event) override; 70 void SetEnableBouncesZoom(bool enable) override; 71 void SetOnDidZoom(std::function<void(float)>&& event) override; 72 void SetOnZoomStart(std::function<void()>&& event) override; 73 void SetOnZoomStop(std::function<void()>&& event) override; 74 75 static RefPtr<FrameNode> CreateFrameNode(int32_t nodeId); 76 static RefPtr<FrameNode> CreateFrameNodeMultiThread(int32_t nodeId); 77 static void SetScrollController( 78 FrameNode* frameNode, const RefPtr<ScrollControllerBase>& scroller, const RefPtr<ScrollProxy>& proxy); 79 static void SetNestedScroll(FrameNode* frameNode, const NestedScrollOptions& nestedOpt); 80 static int32_t GetScrollEnabled(FrameNode* frameNode); 81 static void SetScrollEnabled(FrameNode* frameNode, bool scrollEnabled); 82 static float GetFriction(FrameNode* frameNode); 83 static void SetFriction(FrameNode* frameNode, double friction); 84 static ScrollSnapOptions GetScrollSnap(FrameNode* frameNode); 85 static void SetScrollSnap(FrameNode* frameNode, ScrollSnapAlign scrollSnapAlign, const Dimension& intervalSize, 86 const std::vector<Dimension>& snapPaginations, const std::pair<bool, bool>& enableSnapToSide); 87 static int32_t GetScrollBar(FrameNode* frameNode); 88 static void SetScrollBar(FrameNode* frameNode, DisplayMode barState); 89 static int32_t GetAxis(FrameNode* frameNode); 90 static void SetAxis(FrameNode* frameNode, Axis axis); 91 static uint32_t GetScrollBarColor(FrameNode* frameNode); 92 static void SetScrollBarColor(FrameNode* frameNode, const Color& color); 93 static float GetScrollBarWidth(FrameNode* frameNode); 94 static void SetScrollBarWidth(FrameNode* frameNode, const Dimension& dimension); 95 static int32_t GetEdgeEffect(FrameNode* frameNode); 96 static int32_t GetEdgeEffectAlways(FrameNode* frameNode); 97 static void SetEdgeEffect( 98 FrameNode* frameNode, const EdgeEffect& edgeEffect, bool alwaysEnabled, EffectEdge edge); 99 static int32_t GetEnablePaging(FrameNode* frameNode); 100 static void SetEnablePaging(FrameNode* frameNode, bool enablePaging); 101 static void SetOnScroll(FrameNode* frameNode, NG::ScrollEvent&& event); 102 static void SetOnScrollFrameBegin(FrameNode* frameNode, OnScrollFrameBeginEvent&& event); 103 static void SetOnScrollStart(FrameNode* frameNode, OnScrollStartEvent&& event); 104 static void SetOnScrollStop(FrameNode* frameNode, OnScrollStopEvent&& event); 105 106 static RefPtr<ScrollControllerBase> GetOrCreateController(FrameNode* frameNode); 107 static void SetOnScrollEdge(FrameNode* frameNode, NG::ScrollEdgeEvent&& event); 108 static NestedScrollOptions GetNestedScroll(FrameNode* frameNode); 109 static ScrollEdgeType GetOnScrollEdge(FrameNode* frameNode); 110 static void CreateWithResourceObjFriction(FrameNode* frameNode, const RefPtr<ResourceObject>& resObj); 111 static void SetOnWillScroll(FrameNode* frameNode, NG::ScrollEventWithReturn&& event); 112 static void SetOnDidScroll(FrameNode* frameNode, NG::ScrollEventWithState&& event); 113 static void SetOnReachStart(FrameNode* frameNode, OnReachEvent&& onReachStart); 114 static void SetOnReachEnd(FrameNode* frameNode, OnReachEvent&& onReachEnd); 115 static void SetInitialOffset(FrameNode* frameNode, const OffsetT<CalcDimension>& offset); 116 static void SetScrollBarProxy(FrameNode* frameNode, const RefPtr<ScrollProxy>& proxy); 117 static void CreateWithResourceObjIntervalSize(FrameNode* frameNode, std::vector<RefPtr<ResourceObject>>& resObjs); 118 static void CreateWithResourceObjSnapPaginations(FrameNode* frameNode, 119 const std::vector<Dimension>& snapPaginations, std::vector<RefPtr<ResourceObject>>& resObjs); 120 static void CreateWithResourceObjScrollBarColor(FrameNode* frameNode, const RefPtr<ResourceObject>& resObj); 121 static void SetMaxZoomScale(FrameNode* frameNode, float scale); 122 static float GetMaxZoomScale(FrameNode* frameNode); 123 static void SetMinZoomScale(FrameNode* frameNode, float scale); 124 static float GetMinZoomScale(FrameNode* frameNode); 125 static void SetZoomScale(FrameNode* frameNode, float scale); 126 static void ResetZoomScale(FrameNode* frameNode); 127 static float GetZoomScale(FrameNode* frameNode); 128 static void SetEnableBouncesZoom(FrameNode* frameNode, bool enable); 129 static bool GetEnableBouncesZoom(FrameNode* frameNode); 130 static void SetOnDidZoom(FrameNode* frameNode, std::function<void(float)>&& event); 131 static void SetOnZoomStart(FrameNode* frameNode, std::function<void()>&& event); 132 static void SetOnZoomStop(FrameNode* frameNode, std::function<void()>&& event); 133 private: 134 static bool CheckSnapPaginations(const std::vector<Dimension>& snapPaginations); 135 static bool HasResObj(const std::vector<RefPtr<ResourceObject>>& resObjs); 136 }; 137 138 } // namespace OHOS::Ace::NG 139 140 #endif // FOUNDATION_ACE_FRAMEWORKS_CORE_COMPONENTS_NG_PATTERNS_SCROLL_SCROLL_MODEL_NG_H 141