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_PATTERN_SCROLLABLE_PAINT_PROPERTY_H 17 #define FOUNDATION_ACE_FRAMEWORKS_CORE_COMPONENTS_NG_PATTERN_SCROLLABLE_PAINT_PROPERTY_H 18 19 #include "core/animation/curve.h" 20 #include "core/animation/curves.h" 21 #include "core/components/common/layout/constants.h" 22 #include "core/components/common/properties/color.h" 23 #include "core/components_ng/pattern/scroll/inner/scroll_bar.h" 24 #include "core/components_ng/render/paint_property.h" 25 26 namespace OHOS::Ace::NG { 27 class InspectorFilter; 28 29 struct ScrollBarProperty { 30 ACE_DEFINE_PROPERTY_GROUP_ITEM(ScrollBarMode, DisplayMode); 31 ACE_DEFINE_PROPERTY_GROUP_ITEM(ScrollBarWidth, Dimension); 32 ACE_DEFINE_PROPERTY_GROUP_ITEM(ScrollBarColor, Color); 33 ACE_DEFINE_PROPERTY_GROUP_ITEM(ScrollBarMargin, ScrollBarMargin); 34 }; 35 struct FadingEdgeProperty { 36 ACE_DEFINE_PROPERTY_GROUP_ITEM(FadingEdge, bool); 37 ACE_DEFINE_PROPERTY_GROUP_ITEM(DefaultFadingEdge, bool); 38 ACE_DEFINE_PROPERTY_GROUP_ITEM(FadingEdgeLength, Dimension); 39 }; 40 41 enum class ContentClipMode { 42 CONTENT_ONLY, // area excluding margin & padding & SafeAreaPadding 43 BOUNDARY, // corresponding to FrameRect, area excluding margin 44 SAFE_AREA, // CONTENT_ONLY area + SafeAreaPadding (which can stack up with ancestor's SafeAreaPadding) 45 CUSTOM, // inner enum, not present in frontend. Custom shape's offset is relative to FrameOffset. 46 DEFAULT, // Different scrollable components have different default clip values. 47 }; 48 using ContentClip = std::pair<ContentClipMode, RefPtr<ShapeRect>>; 49 50 class ScrollablePaintProperty : public PaintProperty { 51 DECLARE_ACE_TYPE(ScrollablePaintProperty, PaintProperty); 52 53 public: 54 ScrollablePaintProperty() = default; 55 ~ScrollablePaintProperty() override = default; 56 57 RefPtr<PaintProperty> Clone() const override; 58 59 /** 60 * @brief copy paint props from @c src 61 */ 62 void CloneProps(const ScrollablePaintProperty* src); 63 Reset()64 void Reset() override 65 { 66 ResetScrollBarProperty(); 67 ResetFadingEdgeProperty(); 68 PaintProperty::Reset(); 69 ResetContentClip(); 70 } 71 72 void ToJsonValue(std::unique_ptr<JsonValue>& json, const InspectorFilter& filter) const override; 73 74 ACE_DEFINE_PROPERTY_GROUP(ScrollBarProperty, ScrollBarProperty); 75 ACE_DEFINE_PROPERTY_ITEM_WITH_GROUP(ScrollBarProperty, ScrollBarMode, DisplayMode, PROPERTY_UPDATE_RENDER); 76 ACE_DEFINE_PROPERTY_ITEM_WITH_GROUP(ScrollBarProperty, ScrollBarWidth, Dimension, PROPERTY_UPDATE_RENDER); 77 ACE_DEFINE_PROPERTY_ITEM_WITH_GROUP(ScrollBarProperty, ScrollBarColor, Color, PROPERTY_UPDATE_RENDER); 78 ACE_DEFINE_PROPERTY_ITEM_WITH_GROUP(ScrollBarProperty, ScrollBarMargin, ScrollBarMargin, PROPERTY_UPDATE_RENDER); 79 ACE_DEFINE_PROPERTY_GROUP(FadingEdgeProperty, FadingEdgeProperty); 80 ACE_DEFINE_PROPERTY_ITEM_WITH_GROUP(FadingEdgeProperty, FadingEdge, bool, PROPERTY_UPDATE_RENDER); 81 ACE_DEFINE_PROPERTY_ITEM_WITH_GROUP(FadingEdgeProperty, DefaultFadingEdge, bool, PROPERTY_UPDATE_RENDER); 82 ACE_DEFINE_PROPERTY_ITEM_WITH_GROUP(FadingEdgeProperty, FadingEdgeLength, Dimension, PROPERTY_UPDATE_RENDER); 83 ACE_DEFINE_PROPERTY_ITEM_WITHOUT_GROUP(ContentClip, ContentClip, PROPERTY_UPDATE_RENDER); 84 Dimension GetBarWidth() const; 85 Color GetBarColor() const; 86 87 /** 88 * @brief Return the default content clip mode. 89 */ GetDefaultContentClip()90 virtual ContentClipMode GetDefaultContentClip() const 91 { 92 return ContentClipMode::CONTENT_ONLY; 93 } 94 95 private: 96 std::string ContentClipToStr() const; 97 std::string GetBarStateString() const; 98 }; 99 100 class GridPaintProperty : public ScrollablePaintProperty { 101 DECLARE_ACE_TYPE(GridPaintProperty, ScrollablePaintProperty); 102 public: 103 RefPtr<PaintProperty> Clone() const override; 104 GetDefaultContentClip()105 ContentClipMode GetDefaultContentClip() const override 106 { 107 return ContentClipMode::BOUNDARY; 108 } 109 }; 110 111 class ScrollPaintProperty : public ScrollablePaintProperty { 112 DECLARE_ACE_TYPE(ScrollPaintProperty, ScrollablePaintProperty); 113 public: 114 RefPtr<PaintProperty> Clone() const override; 115 GetDefaultContentClip()116 ContentClipMode GetDefaultContentClip() const override 117 { 118 return ContentClipMode::BOUNDARY; 119 } 120 }; 121 } // namespace OHOS::Ace::NG 122 123 #endif 124