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_SCROLLABLE_MODEL_NG_H 17 #define FOUNDATION_ACE_FRAMEWORKS_CORE_COMPONENTS_NG_PATTERN_SCROLLABLE_SCROLLABLE_MODEL_NG_H 18 19 #include "base/utils/macros.h" 20 #include "core/components/common/layout/constants.h" 21 #include "core/components_ng/base/frame_node.h" 22 #include "core/components_ng/pattern/scrollable/scrollable_paint_property.h" 23 #include "core/components_ng/pattern/scrollable/scrollable_properties.h" 24 25 namespace OHOS::Ace::NG { 26 27 constexpr Dimension DEFAULT_FADING_EDGE_LENGTH_SCROLLABLE = Dimension(32.0f, DimensionUnit::VP); // default value 28 class ACE_EXPORT ScrollableModelNG { 29 public: 30 static void SetEdgeEffect(EdgeEffect edgeEffect, bool alwaysEnabled); 31 32 static void SetScrollBarMode(DisplayMode value); 33 static void SetScrollBarColor(const std::string& value); 34 static void SetScrollBarWidth(const std::string& value); 35 36 static void SetOnScroll(OnScrollEvent&& onScroll); 37 static void SetOnWillScroll(OnWillScrollEvent&& onScroll); 38 static void SetOnDidScroll(OnScrollEvent&& onScroll); 39 static void SetOnScrollStart(OnScrollStartEvent&& onScrollStart); 40 static void SetOnScrollStop(OnScrollStopEvent&& onScrollStop); 41 static void SetOnReachStart(OnReachEvent&& onReachStart); 42 static void SetOnReachEnd(OnReachEvent&& onReachEnd); 43 static void SetOnScrollFrameBegin(OnScrollFrameBeginEvent&& ScrollFrameBegin); 44 static void SetFadingEdge( 45 bool fadingEdge, const Dimension& fadingEdgeLength = DEFAULT_FADING_EDGE_LENGTH_SCROLLABLE); 46 static void SetFadingEdge(FrameNode* frameNode, bool fadingEdge, 47 const Dimension& fadingEdgeLength = DEFAULT_FADING_EDGE_LENGTH_SCROLLABLE); 48 static void SetContentClip(ContentClipMode mode, const RefPtr<ShapeRect>& rect); 49 50 static void SetEdgeEffect(FrameNode* frameNode, EdgeEffect edgeEffect, bool alwaysEnabled); 51 static void SetScrollBarMode(FrameNode* frameNode, int32_t displayNumber); 52 static void SetScrollBarWidth(FrameNode* frameNode, const std::string& value); 53 static void SetScrollBarColor(FrameNode* frameNode, const std::string& value); 54 static void SetMaxFlingSpeed(double max); 55 static void SetOnWillScroll(FrameNode* frameNode, OnWillScrollEvent&& onScroll); 56 static void SetOnDidScroll(FrameNode* frameNode, OnScrollEvent&& onScroll); 57 58 static int32_t GetEdgeEffect(FrameNode* frameNode); 59 static int32_t GetAlwaysEnabled(FrameNode* frameNode); 60 static void SetOnScroll(FrameNode* frameNode, OnScrollEvent&& onScroll); 61 static void SetOnScrollStart(FrameNode* frameNode, OnScrollStartEvent&& onScrollStart); 62 static void SetOnScrollStop(FrameNode* frameNode, OnScrollStopEvent&& onScrollStop); 63 static void SetOnReachStart(FrameNode* frameNode, OnReachEvent&& onReachStart); 64 static void SetOnReachEnd(FrameNode* frameNode, OnReachEvent&& onReachEnd); 65 static void SetOnScrollFrameBegin(FrameNode* frameNode, OnScrollFrameBeginEvent&& ScrollFrameBegin); 66 static void SetMaxFlingSpeed(FrameNode* frameNode, double max); 67 static bool GetFadingEdge(FrameNode* frameNode); 68 static float GetFadingEdgeLength(FrameNode* frameNode); 69 static void SetContentClip(FrameNode* frameNode, ContentClipMode mode, const RefPtr<ShapeRect>& shape); 70 }; 71 } // namespace OHOS::Ace::NG 72 #endif // FOUNDATION_ACE_FRAMEWORKS_CORE_COMPONENTS_NG_PATTERN_SCROLLABLE_SCROLLABLE_MODEL_H 73