1 /*
2  * Copyright (c) 2022 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_GRID_GRID_MODEL_H
17 #define FOUNDATION_ACE_FRAMEWORKS_CORE_COMPONENTS_NG_PATTERN_GRID_GRID_MODEL_H
18 
19 #include <mutex>
20 
21 #include "base/geometry/axis.h"
22 #include "base/geometry/dimension.h"
23 #include "base/memory/referenced.h"
24 #include "core/components/common/layout/constants.h"
25 #include "core/components/common/properties/color.h"
26 #include "core/components/scroll_bar/scroll_bar_proxy.h"
27 #include "core/components_ng/pattern/grid/grid_layout_options.h"
28 #include "core/components_ng/pattern/grid/grid_constants.h"
29 #include "core/components_ng/pattern/scrollable/scrollable_properties.h"
30 #include "core/components_v2/grid/grid_position_controller.h"
31 #include "core/event/ace_events.h"
32 
33 namespace OHOS::Ace {
34 
35 class ACE_FORCE_EXPORT GridModel {
36 public:
37     static GridModel* GetInstance();
38     virtual ~GridModel() = default;
39 
40     virtual void Create(
41         const RefPtr<ScrollControllerBase>& positionController, const RefPtr<ScrollProxy>& scrollBarProxy) = 0;
42     virtual void Pop() = 0;
43     virtual void SetLayoutOptions(GridLayoutOptions options) = 0;
44     virtual void SetColumnsTemplate(const std::string& value) = 0;
45     virtual void SetRowsTemplate(const std::string& value) = 0;
46     virtual void SetColumnsGap(const Dimension& value) = 0;
47     virtual void SetRowsGap(const Dimension& value) = 0;
48     virtual void SetGridHeight(const Dimension& value) = 0;
49     virtual void SetScrollBarMode(DisplayMode value) = 0;
50     virtual void SetScrollBarColor(const std::string& value) = 0;
51     virtual void SetScrollBarWidth(const std::string& value) = 0;
52     virtual void SetCachedCount(int32_t value, bool show = false) = 0;
53     virtual void SetIsRTL(TextDirection direction) = 0;
54     virtual void SetLayoutDirection(FlexDirection value) = 0;
55     virtual void SetMaxCount(int32_t value) = 0;
56     virtual void SetMinCount(int32_t value) = 0;
57     virtual void SetCellLength(int32_t value) = 0;
58     virtual void SetEditable(bool value) = 0;
59     virtual void SetMultiSelectable(bool value) = 0;
60     virtual void SetSupportAnimation(bool value) = 0;
61     virtual void SetSupportDragAnimation(bool value) = 0;
62     virtual void SetEdgeEffect(EdgeEffect edgeEffect, bool alwaysEnabled) = 0;
63     virtual void SetNestedScroll(const NestedScrollOptions& nestedOpt) = 0;
64     virtual void SetScrollEnabled(bool scrollEnabled) = 0;
65     virtual void SetFriction(double friction) = 0;
66     virtual void SetAlignItems(GridItemAlignment itemAlign) = 0;
67     virtual void SetOnScrollToIndex(std::function<void(const BaseEventInfo*)>&& value) = 0;
68     virtual void SetOnScrollBarUpdate(
69         std::function<std::pair<std::optional<float>, std::optional<float>>(int32_t, Dimension)>&& value) = 0;
70     virtual void SetOnItemDragStart(std::function<void(const ItemDragInfo&, int32_t)>&& value) = 0;
71     virtual void SetOnItemDragEnter(std::function<void(const ItemDragInfo&)>&& value) = 0;
72     virtual void SetOnItemDragMove(std::function<void(const ItemDragInfo&, int32_t, int32_t)>&& value) = 0;
73     virtual void SetOnItemDragLeave(std::function<void(const ItemDragInfo&, int32_t)>&& value) = 0;
74     virtual void SetOnItemDrop(std::function<void(const ItemDragInfo&, int32_t, int32_t, bool)>&& value) = 0;
75     virtual RefPtr<ScrollControllerBase> CreatePositionController();
76     virtual RefPtr<ScrollProxy> CreateScrollBarProxy();
77     virtual void SetOnScroll(std::function<void(Dimension, ScrollState)>&& onScroll) = 0;
78     virtual void SetOnScrollFrameBegin(
79         std::function<ScrollFrameResult(Dimension, ScrollState)>&& onScrollFrameBegin) = 0;
80     virtual void SetOnScrollStart(std::function<void()>&& onScrollStart) = 0;
81     virtual void SetOnScrollStop(std::function<void()>&& onScrollStop) = 0;
82     virtual void SetOnScrollIndex(std::function<void(int32_t, int32_t)>&& onScrollIndex) = 0;
83     virtual void SetOnReachStart(std::function<void()>&& onReachStart) = 0;
84     virtual void SetOnReachEnd(std::function<void()>&& onReachEnd) = 0;
85 
86     virtual DisplayMode GetDisplayMode() const = 0;
87 
88 private:
89     static std::unique_ptr<GridModel> instance_;
90     static std::mutex mutex_;
91 };
92 
93 } // namespace OHOS::Ace
94 #endif // FOUNDATION_ACE_FRAMEWORKS_CORE_COMPONENTS_NG_PATTERN_GRID_GRID_MODEL_H
95