1 /* 2 * Copyright (c) 2023 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_SCROLLABLE_SCROLLABLE_UTILS_H 17 #define FOUNDATION_ACE_FRAMEWORKS_CORE_COMPONENTS_NG_PATTERNS_SCROLLABLE_SCROLLABLE_UTILS_H 18 19 #include "base/geometry/axis.h" 20 #include "core/components_ng/layout/layout_property.h" 21 22 namespace OHOS::Ace::NG { 23 class LayoutWrapper; 24 struct ScrollableUtils { 25 /** 26 * @brief Checks if contentHeight needs to expand based on safeArea property. 27 * 28 * @param layoutProps The layout properties to check. 29 * @param axis The scrollable axis. 30 * @return The height expansion amount. 31 */ 32 static float CheckHeightExpansion(const RefPtr<LayoutProperty>& layoutProps, Axis axis); 33 34 /** 35 * @brief Recycle items which are out of boundary. 36 * 37 * @param axis scroll direction 38 * @param offset scroll offset, positive means scroll down, negative means scroll up. 39 * @param start first item index 40 * @param end last item index 41 * @param wrapper layout wrapper 42 */ 43 static void RecycleItemsOutOfBoundary(Axis axis, float offset, int32_t start, int32_t end, LayoutWrapper* wrapper); 44 45 /** 46 * @brief get moveoffset from parentFrameNode when curFrameNode focused. 47 * 48 * @param parentFrameNode parent framenode with scroll function 49 * @param curFrameNode current focused framenode 50 * @param isVertical vertical or not 51 * @param contentStartOffset content start offset from parentFrameNode 52 * @param contentEndOffset content end offset from parentFrameNode 53 */ 54 static float GetMoveOffset( 55 const RefPtr<FrameNode>& parentFrameNode, 56 const RefPtr<FrameNode>& curFrameNode, 57 bool isVertical, 58 float contentStartOffset, 59 float contentEndOffset); 60 }; 61 } // namespace OHOS::Ace::NG 62 63 #endif // FOUNDATION_ACE_FRAMEWORKS_CORE_COMPONENTS_NG_PATTERNS_SCROLLABLE_SCROLLABLE_UTILS_H 64