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_BASE_SUBWINDOW_SUBWINDOW_H
17 #define FOUNDATION_ACE_FRAMEWORKS_BASE_SUBWINDOW_SUBWINDOW_H
18 
19 #include <set>
20 
21 #include "base/geometry/ng/rect_t.h"
22 #include "base/memory/ace_type.h"
23 #include "base/memory/referenced.h"
24 #include "core/components/dialog/dialog_properties.h"
25 #include "core/components_ng/base/frame_node.h"
26 #include "core/components_ng/pattern/overlay/overlay_manager.h"
27 #include "core/components_ng/property/menu_property.h"
28 #include "core/pipeline/base/component.h"
29 
30 namespace OHOS::Ace {
31 
32 enum class ToastWindowType {
33     TOAST_IN_TYPE_APP_SUB_WINDOW = 0,
34     TOAST_IN_TYPE_SYSTEM_SUB_WINDOW,
35     TOAST_IN_TYPE_TOAST,
36     TOAST_IN_TYPE_SYSTEM_FLOAT,
37     TOAST_WINDOW_COUNT
38 };
39 
40 class ACE_EXPORT Subwindow : public AceType {
41     DECLARE_ACE_TYPE(Subwindow, AceType)
42 
43 public:
44     static RefPtr<Subwindow> CreateSubwindow(int32_t instanceId);
45 
46     virtual bool InitContainer() = 0;
47     virtual void ResizeWindow() = 0;
48     virtual NG::RectF GetRect() = 0;
49     virtual void SetRect(const NG::RectF& rect) = 0;
50     virtual void ShowMenu(const RefPtr<Component>& newComponent) = 0;
51     virtual void ShowMenuNG(const RefPtr<NG::FrameNode> menuNode, const NG::MenuParam& menuParam,
52         const RefPtr<NG::FrameNode>& targetNode, const NG::OffsetF& offset) = 0;
53     virtual void ShowMenuNG(std::function<void()>&& buildFunc, std::function<void()>&& previewBuildFunc,
54         const NG::MenuParam& menuParam, const RefPtr<NG::FrameNode>& targetNode, const NG::OffsetF& offset) = 0;
55     virtual bool ShowPreviewNG(bool isStartDraggingFromSubWindow) = 0;
56     virtual void HidePreviewNG() = 0;
57     virtual void HideMenuNG(const RefPtr<NG::FrameNode>& menu, int32_t targetId) = 0;
58     virtual void HideMenuNG(bool showPreviewAnimation = true, bool startDrag = false) = 0;
59     virtual void UpdateHideMenuOffsetNG(const NG::OffsetF& offset = NG::OffsetF(0.0f, 0.0f),
60         float meunuScale = 1.0f, bool isRedragStart = false, int32_t menuWrapperId = -1) = 0;
61     virtual void ContextMenuSwitchDragPreviewAnimationtNG(const RefPtr<NG::FrameNode>& dragPreviewNode,
62         const NG::OffsetF& offset = NG::OffsetF(0.0f, 0.0f)) = 0;
63     virtual void UpdatePreviewPosition() = 0;
64     virtual bool GetMenuPreviewCenter(NG::OffsetF& offset) = 0;
65     virtual void ShowPopup(const RefPtr<Component>& newComponent, bool disableTouchEvent = true) = 0;
66     virtual void ShowPopupNG(int32_t targetId, const NG::PopupInfo& popupInfo,
67         const std::function<void(int32_t)>&& onWillDismiss = nullptr, bool interactiveDismiss = true) = 0;
68     virtual void HidePopupNG(int32_t targetId) = 0;
69     virtual void GetPopupInfoNG(int32_t targetId, NG::PopupInfo& popupInfo) = 0;
70     virtual bool CancelPopup(const std::string& id) = 0;
71     virtual void CloseMenu() = 0;
ClearMenu()72     virtual void ClearMenu() {};
73     virtual void ClearMenuNG(int32_t targetId = -1, bool inWindow = true, bool showAnimation = false) = 0;
74     virtual void ClearPopupNG() = 0;
75     virtual RefPtr<NG::FrameNode> ShowDialogNG(
76         const DialogProperties& dialogProps, std::function<void()>&& buildFunc) = 0;
77     virtual RefPtr<NG::FrameNode> ShowDialogNGWithNode(
78         const DialogProperties& dialogProps, const RefPtr<NG::UINode>& customNode) = 0;
79     virtual void CloseDialogNG(const RefPtr<NG::FrameNode>& dialogNode) = 0;
80     virtual void OpenCustomDialogNG(const DialogProperties& dialogProps, std::function<void(int32_t)>&& callback) = 0;
81     virtual void CloseCustomDialogNG(int32_t dialogId) = 0;
82     virtual void CloseCustomDialogNG(const WeakPtr<NG::UINode>& node, std::function<void(int32_t)>&& callback) = 0;
83     virtual void UpdateCustomDialogNG(const WeakPtr<NG::UINode>& node, const DialogProperties& dialogProps,
84         std::function<void(int32_t)>&& callback) = 0;
85     virtual void HideSubWindowNG() = 0;
86     virtual int32_t GetChildContainerId() const = 0;
87     virtual bool GetShown() = 0;
88     virtual void MarkDirtyDialogSafeArea() = 0;
89 
90     // Add interface for hot regions
SetHotAreas(const std::vector<Rect>& rects, int32_t nodeId)91     virtual void SetHotAreas(const std::vector<Rect>& rects, int32_t nodeId) {};
DeleteHotAreas(int32_t nodeId)92     virtual void DeleteHotAreas(int32_t nodeId) {};
93 
94     // Add interface to provide the size and offset of the parent window
95     virtual Rect GetParentWindowRect() const = 0;
96     virtual Rect GetUIExtensionHostWindowRect() const = 0;
GetWindowRect() const97     virtual NG::RectF GetWindowRect() const
98     {
99         return NG::RectF();
100     }
101     virtual bool IsFreeMultiWindow() const = 0;
102     virtual void OnFreeMultiWindowSwitch(bool enable) = 0;
103     virtual int32_t RegisterFreeMultiWindowSwitchCallback(std::function<void(bool)>&& callback) = 0;
104     virtual void UnRegisterFreeMultiWindowSwitchCallback(int32_t callbackId) = 0;
105 
GetSubwindowId() const106     int32_t GetSubwindowId() const
107     {
108         return subwindowId_;
109     }
110 
SetSubwindowId(int32_t id)111     void SetSubwindowId(int32_t id)
112     {
113         subwindowId_ = id;
114     }
115 
GetUIExtensionHostWindowId() const116     int32_t GetUIExtensionHostWindowId() const
117     {
118         return uiExtensionHostWindowId_;
119     }
120 
SetUIExtensionHostWindowId(int32_t id)121     void SetUIExtensionHostWindowId(int32_t id)
122     {
123         uiExtensionHostWindowId_ = id;
124     }
125 
SetAboveApps(bool isAboveApps)126     void SetAboveApps(bool isAboveApps)
127     {
128         isAboveApps_ = isAboveApps;
129     }
130 
GetAboveApps() const131     bool GetAboveApps() const
132     {
133         return isAboveApps_;
134     }
135 
SetToastWindowType(const ToastWindowType& type)136     void SetToastWindowType(const ToastWindowType& type)
137     {
138         toastWindowType_ = type;
139         SetAboveApps(true);
140     }
141 
SetMainWindowId(uint32_t mainWindowId)142     void SetMainWindowId(uint32_t mainWindowId)
143     {
144         mainWindowId_ = mainWindowId;
145     }
146 
GetMainWindowId() const147     uint32_t GetMainWindowId() const
148     {
149         return mainWindowId_;
150     }
151 
GetToastWindowType() const152     ToastWindowType GetToastWindowType() const
153     {
154         return toastWindowType_;
155     }
156 
SetIsSystemTopMost(bool isSystemTopMost)157     void SetIsSystemTopMost(bool isSystemTopMost)
158     {
159         isSystemTopMost_ = isSystemTopMost;
160     }
161 
IsSystemTopMost() const162     bool IsSystemTopMost() const
163     {
164         return isSystemTopMost_;
165     }
166 
167     virtual void ClearToast() = 0;
168     virtual void ShowToast(const NG::ToastInfo& toastInfo, std::function<void(int32_t)>&& callback) = 0;
169     virtual void CloseToast(const int32_t toastId, std::function<void(int32_t)>&& callback) = 0;
170     virtual void ShowDialog(const std::string& title, const std::string& message,
171         const std::vector<ButtonInfo>& buttons, bool autoCancel, std::function<void(int32_t, int32_t)>&& callback,
172         const std::set<std::string>& callbacks) = 0;
173     virtual void ShowDialog(const PromptDialogAttr& dialogAttr, const std::vector<ButtonInfo>& buttons,
174         std::function<void(int32_t, int32_t)>&& callback, const std::set<std::string>& callbacks) = 0;
175     virtual void ShowActionMenu(const std::string& title, const std::vector<ButtonInfo>& button,
176         std::function<void(int32_t, int32_t)>&& callback) = 0;
177     virtual void CloseDialog(int32_t instanceId) = 0;
178     virtual void OpenCustomDialog(const PromptDialogAttr& dialogAttr, std::function<void(int32_t)>&& callback) = 0;
179     virtual void CloseCustomDialog(const int32_t dialogId) = 0;
180     virtual void CloseCustomDialog(const WeakPtr<NG::UINode>& node, std::function<void(int32_t)> &&callback) = 0;
181     virtual const RefPtr<NG::OverlayManager> GetOverlayManager() = 0;
182     virtual bool IsFocused() = 0;
183     virtual void RequestFocus() = 0;
184     virtual void ResizeWindowForFoldStatus() = 0;
185     virtual void ResizeWindowForFoldStatus(int32_t parentContainerId) = 0;
186     virtual bool Close() = 0;
187     virtual bool IsToastSubWindow() = 0;
188     virtual void DestroyWindow() = 0;
189 private:
190     int32_t subwindowId_ = 0;
191     int32_t uiExtensionHostWindowId_ = 0;
192     bool isAboveApps_ = false;
193     bool isSystemTopMost_ = false;
194     ToastWindowType toastWindowType_ = ToastWindowType::TOAST_IN_TYPE_TOAST;
195     // toast main window ID
196     uint32_t mainWindowId_ = 0;
197 };
198 
199 } // namespace OHOS::Ace
200 
201 #endif // FOUNDATION_ACE_FRAMEWORKS_BASE_SUBWINDOW_SUBWINDOW_H
202