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 FRAMEWORKS_CORE_COMPONENTS_NG_PATTERNS_NAVDESTINATION_NAVDESTINATION_MODEL_H
17 #define FRAMEWORKS_CORE_COMPONENTS_NG_PATTERNS_NAVDESTINATION_NAVDESTINATION_MODEL_H
18 
19 #include <mutex>
20 
21 #include "base/system_bar/system_bar_style.h"
22 #include "core/components_ng/pattern/navigation/navigation_declaration.h"
23 #include "core/components_ng/pattern/navigation/navigation_options.h"
24 #include "core/components_ng/pattern/navrouter/navdestination_context.h"
25 #include "core/components_ng/pattern/navrouter/navdestination_scrollable_processor.h"
26 
27 namespace OHOS::Ace {
28 class NavDestinationModel {
29 public:
30     static NavDestinationModel* GetInstance();
31     virtual ~NavDestinationModel() = default;
32 
33     virtual void Create() = 0;
34     virtual void Create(
35         std::function<void()>&& deepRenderFunc, RefPtr<NG::NavDestinationContext> context = nullptr) = 0;
36     virtual void SetHideTitleBar(bool hideTitleBar, bool animated = false) = 0;
37     virtual void SetTitle(const std::string& title, bool hasSubTitle) = 0;
SetTitlebarOptions(NG::NavigationTitlebarOptions && opt)38     virtual void SetTitlebarOptions(NG::NavigationTitlebarOptions&& opt) {};
39     virtual void SetBackButtonIcon(const std::function<void(WeakPtr<NG::FrameNode>)>& iconSymbol,
40         const std::string& src, const NG::ImageOption& imageOption, RefPtr<PixelMap>& pixMap,
41         const std::vector<std::string>& nameList) = 0;
42     virtual void SetSubtitle(const std::string& subtitle) = 0;
43     virtual void SetCustomTitle(const RefPtr<AceType>& customNode) = 0;
44     virtual void SetTitleHeight(const Dimension& titleHeight, bool isValid = true) = 0;
45     virtual void SetOnShown(std::function<void()>&& onShow) = 0;
46     virtual void SetOnHidden(std::function<void()>&& onHidden) = 0;
47     virtual void SetOnWillAppear(std::function<void()>&& willAppear) = 0;
48     virtual void SetOnWillShow(std::function<void()>&& willShow) = 0;
49     virtual void SetOnWillHide(std::function<void()>&& willHide) = 0;
50     virtual void SetOnWillDisAppear(std::function<void()>&& willDisAppear) = 0;
51     virtual void SetOnBackPressed(std::function<bool()>&& onBackPressed) = 0;
52     virtual void SetOnReady(std::function<void(RefPtr<NG::NavDestinationContext>)>&& onReady) = 0;
53     virtual void SetHideToolBar(bool hideToolBar, bool animated = false) = 0;
54     virtual void SetToolbarConfiguration(std::vector<NG::BarItem>&& toolBarItems) = 0;
SetToolBarOptions(NG::NavigationToolbarOptions && opt)55     virtual void SetToolBarOptions(NG::NavigationToolbarOptions&& opt) {}
56     virtual void SetCustomToolBar(const RefPtr<AceType>& customNode) = 0;
57     virtual void SetNavDestinationMode(NG::NavDestinationMode mode);
SetRecoverable(bool recoverable)58     virtual void SetRecoverable(bool recoverable) {}
SetMenuItems(std::vector<NG::BarItem> && menuItems)59     virtual void SetMenuItems(std::vector<NG::BarItem>&& menuItems) {};
60     virtual void SetCustomMenu(const RefPtr<AceType>& customNode) = 0;
61     virtual void SetBackgroundColor(const Color& color, bool isVaild = true) = 0;
SetNavDestinationPathInfo(const std::string & moduleName,const std::string & pagePath)62     virtual void SetNavDestinationPathInfo(const std::string& moduleName, const std::string& pagePath) {};
CreateEmpty()63     virtual RefPtr<AceType> CreateEmpty()
64     {
65         return nullptr;
66     }
ParseCommonTitle(bool hasSubTitle,bool hasMainTitle,const std::string & subtitle,const std::string & title)67     virtual bool ParseCommonTitle(
68         bool hasSubTitle, bool hasMainTitle, const std::string& subtitle, const std::string& title)
69     {
70         return false;
71     }
72 
SetIgnoreLayoutSafeArea(const NG::SafeAreaExpandOpts & opts)73     virtual void SetIgnoreLayoutSafeArea(const NG::SafeAreaExpandOpts& opts) {};
SetSystemBarStyle(const RefPtr<SystemBarStyle> & style)74     virtual void SetSystemBarStyle(const RefPtr<SystemBarStyle>& style) {};
SetSystemTransitionType(NG::NavigationSystemTransitionType type)75     virtual void SetSystemTransitionType(NG::NavigationSystemTransitionType type) {};
SetScrollableProcessor(const std::function<RefPtr<NG::NavDestinationScrollableProcessor> ()> & creator)76     virtual void SetScrollableProcessor(
77         const std::function<RefPtr<NG::NavDestinationScrollableProcessor>()>& creator) {}
UpdateBindingWithScrollable(std::function<void (const RefPtr<NG::NavDestinationScrollableProcessor> & processor)> && callback)78     virtual void UpdateBindingWithScrollable(
79         std::function<void(const RefPtr<NG::NavDestinationScrollableProcessor>& processor)>&& callback) {}
80 
81 private:
82     static std::unique_ptr<NavDestinationModel> instance_;
83     static std::mutex mutex_;
84 };
85 } // namespace OHOS::Ace
86 
87 #endif // FRAMEWORKS_CORE_COMPONENTS_NG_PATTERNS_NAVDESTINATION_NAVDESTINATION_MODEL_H
88