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_NAVIGATION_NAVIGATION_MODEL_H 17 #define FOUNDATION_ACE_FRAMEWORKS_CORE_COMPONENTS_NG_PATTERNS_NAVIGATION_NAVIGATION_MODEL_H 18 19 #include <functional> 20 #include <mutex> 21 #include <string> 22 23 #include "base/geometry/dimension.h" 24 #include "base/memory/referenced.h" 25 #include "base/system_bar/system_bar_style.h" 26 #include "core/components_ng/pattern/navigation/navigation_declaration.h" 27 #include "core/components_ng/pattern/navigation/navigation_options.h" 28 #include "core/components_ng/pattern/navigation/navigation_stack.h" 29 #include "core/components_ng/pattern/navigation/navigation_transition_proxy.h" 30 #include "core/components_ng/pattern/navrouter/navdestination_context.h" 31 #include "core/components_ng/pattern/navigation/title_bar_pattern.h" 32 33 namespace OHOS::Ace { 34 35 enum class NavigationPatternType { 36 TITLE_BAR = 0, 37 NAV_BAR, 38 NAVIGATION, 39 }; 40 using NavigationTransitionEvent = std::function<NG::NavigationTransition( 41 RefPtr<NG::NavDestinationContext> from, RefPtr<NG::NavDestinationContext> to, NG::NavigationOperation operation)>; 42 using OnNavBarWidthChangeEvent = std::function<void(const Dimension)>; 43 class ACE_FORCE_EXPORT NavigationModel { 44 public: 45 static NavigationModel* GetInstance(); 46 virtual ~NavigationModel() = default; 47 48 virtual void Create(bool useHomeDestination = false) = 0; 49 virtual void SetNavigationStack() = 0; 50 virtual void SetNavigationStack(const RefPtr<NG::NavigationStack>& navigationStack) = 0; SetNavigationStackWithCreatorAndUpdater(std::function<RefPtr<NG::NavigationStack> ()> creator,std::function<void (RefPtr<NG::NavigationStack>)> updater)51 virtual void SetNavigationStackWithCreatorAndUpdater(std::function<RefPtr<NG::NavigationStack>()> creator, 52 std::function<void(RefPtr<NG::NavigationStack>)> updater) {}; SetNavigationPathInfo(const std::string & moduleName,const std::string & pagePath)53 virtual void SetNavigationPathInfo(const std::string& moduleName, const std::string& pagePath) {}; 54 virtual void SetNavigationStackProvided(bool provided) = 0; 55 virtual bool ParseCommonTitle(bool hasSubTitle, bool hasMainTitle, const std::string& subtitle, 56 const std::string& title, bool ignoreMainTitle = false) 57 { 58 return false; 59 } 60 virtual void SetTitle(const std::string& title, bool hasSubTitle = false) = 0; SetTitlebarOptions(NG::NavigationTitlebarOptions && opt)61 virtual void SetTitlebarOptions(NG::NavigationTitlebarOptions&& opt) {} 62 virtual void SetCustomTitle(const RefPtr<AceType>& customNode) = 0; 63 virtual void SetTitleHeight(const Dimension& height, bool isValid = true) = 0; SetTitleHeight(const Dimension & height,const RefPtr<ResourceObject> & resObj)64 virtual void SetTitleHeight(const Dimension& height, const RefPtr<ResourceObject>& resObj) {} 65 virtual void SetTitleMode(NG::NavigationTitleMode mode) = 0; 66 virtual void SetSubtitle(const std::string& subtitle) = 0; 67 virtual void SetEnableModeChangeAnimation(bool isEnable) = 0; SetSplitPlaceholder(const RefPtr<NG::UINode> & splitPlaceholder)68 virtual void SetSplitPlaceholder(const RefPtr<NG::UINode>& splitPlaceholder) {} ResetSplitPlaceholder()69 virtual void ResetSplitPlaceholder() {} 70 virtual void SetHideTitleBar(bool hideTitleBar, bool animated = false) = 0; 71 virtual void SetHideNavBar(bool hideNavBar) = 0; 72 virtual void SetBackButtonIcon(const std::function<void(WeakPtr<NG::FrameNode>)>& symbolApply, 73 const std::string& src, const NG::ImageOption& imageOption, RefPtr<PixelMap>& pixMap, 74 const std::vector<std::string>& nameList, bool userDefinedAccessibilityText = false, 75 const std::string& backButtonAccessibilityText = ""); 76 virtual void SetBackButtonIcon(const std::function<void(WeakPtr<NG::FrameNode>)>& symbolApply, 77 const RefPtr<ResourceObject>& resObj, const NG::ImageOption& imageOption, RefPtr<PixelMap>& pixMap, 78 const std::vector<std::string>& nameList, bool userDefinedAccessibilityText = false, 79 const std::string& backButtonAccessibilityText = ""); 80 virtual void SetBackButtonIconTextRes(const std::function<void(WeakPtr<NG::FrameNode>)>& symbolApply, 81 const std::string& src, const NG::ImageOption& imageOption, RefPtr<PixelMap>& pixMap, 82 const std::vector<std::string>& nameList, bool userDefinedAccessibilityText, 83 const RefPtr<ResourceObject>& resObj); 84 virtual void SetBackButtonIconSrcAndTextRes(const std::function<void(WeakPtr<NG::FrameNode>)>& symbolApply, 85 const RefPtr<ResourceObject>& backButtonResObj, const NG::ImageOption& imageOption, RefPtr<PixelMap>& pixMap, 86 const std::vector<std::string>& nameList, bool userDefinedAccessibilityText, 87 const RefPtr<ResourceObject>& backButtonTextResObj); 88 virtual void UpdateBackButtonIcon(const std::vector<std::string>& nameList, 89 NG::FrameNode* frameNode, const RefPtr<ResourceObject>& backButtonIconResObj); 90 virtual void UpdateBackButtonIconText(bool userDefinedAccessibilityText, 91 const RefPtr<NG::TitleBarNode>& titleBarNode, const RefPtr<ResourceObject>& backButtonTextResObj); 92 virtual void SetHideBackButton(bool hideBackButton) = 0; 93 virtual void SetHideToolBar(bool hideToolBar, bool animated = false) = 0; 94 virtual void SetCustomToolBar(const RefPtr<AceType>& customNode) = 0; 95 virtual bool NeedSetItems() = 0; 96 virtual void SetToolBarItems(std::vector<NG::BarItem>&& toolBarItems) = 0; SetHideItemText(bool isHideItemText)97 virtual void SetHideItemText(bool isHideItemText) {}; SetEnableToolBarAdaptation(bool disable)98 virtual void SetEnableToolBarAdaptation(bool disable) {}; 99 virtual void SetToolbarConfiguration(std::vector<NG::BarItem>&& toolBarItems) = 0; SetToolbarConfiguration(std::vector<NG::BarItem> && toolBarItems,NG::MoreButtonOptions && opt)100 virtual void SetToolbarConfiguration(std::vector<NG::BarItem>&& toolBarItems, NG::MoreButtonOptions&& opt) {} GetToolBarItems(std::list<RefPtr<AceType>> & items)101 virtual void GetToolBarItems(std::list<RefPtr<AceType>>& items) {}; SetToolbarOptions(NG::NavigationToolbarOptions && opt)102 virtual void SetToolbarOptions(NG::NavigationToolbarOptions&& opt) {} SetToolbarMorebuttonOptions(NG::MoreButtonOptions && opt)103 virtual void SetToolbarMorebuttonOptions(NG::MoreButtonOptions&& opt) {} 104 virtual void SetMenuItems(std::vector<NG::BarItem>&& menuItems) = 0; GetMenuItems(std::list<RefPtr<AceType>> & items)105 virtual void GetMenuItems(std::list<RefPtr<AceType>>& items) {}; SetMenuOptions(NG::NavigationMenuOptions && opt)106 virtual void SetMenuOptions(NG::NavigationMenuOptions&& opt) {} 107 virtual void SetCustomMenu(const RefPtr<AceType>& customNode) = 0; 108 virtual void SetOnTitleModeChange(std::function<void(NG::NavigationTitleMode)>&& onTitleModeChange, 109 std::function<void(const BaseEventInfo* baseInfo)>&& eventInfo) = 0; 110 virtual void SetUsrNavigationMode(NG::NavigationMode mode) = 0; 111 virtual void SetNavBarPosition(NG::NavBarPosition mode) = 0; 112 virtual void SetNavBarWidth(const Dimension& value, bool isDoubleBind = false) = 0; SetNavBarWidth(const RefPtr<ResourceObject> & navBarWidthResObj)113 virtual void SetNavBarWidth(const RefPtr<ResourceObject>& navBarWidthResObj) {} 114 virtual void SetMinNavBarWidth(const Dimension& value) = 0; 115 virtual void SetMaxNavBarWidth(const Dimension& value) = 0; SetMinNavBarWidth(const RefPtr<ResourceObject> & minNavBarWidthResObj)116 virtual void SetMinNavBarWidth(const RefPtr<ResourceObject>& minNavBarWidthResObj) {} SetMaxNavBarWidth(const RefPtr<ResourceObject> & maxNavBarWidthResObj)117 virtual void SetMaxNavBarWidth(const RefPtr<ResourceObject>& maxNavBarWidthResObj) {} 118 virtual void SetMinContentWidth(const Dimension& value) = 0; SetMinContentWidth(const RefPtr<ResourceObject> & minContentWidthResObj)119 virtual void SetMinContentWidth(const RefPtr<ResourceObject>& minContentWidthResObj) {} 120 virtual void SetOnNavBarStateChange(std::function<void(bool)>&& onNavBarStateChange) = 0; 121 virtual void SetOnNavigationModeChange(std::function<void(NG::NavigationMode)>&& onNavigationModeChange); SetOnNavBarWidthChangeEvent(OnNavBarWidthChangeEvent event)122 virtual void SetOnNavBarWidthChangeEvent(OnNavBarWidthChangeEvent event) {}; 123 virtual void SetNavigationMode(NG::NavigationMode mode) = 0; 124 virtual void SetNavDestination(std::function<void(std::string)>&& builder) = 0; 125 virtual RefPtr<NG::NavigationStack> GetNavigationStack() = 0; 126 virtual void SetMenuCount(int32_t menuCount) = 0; 127 virtual void SetCustomTransition(NavigationTransitionEvent&& animationTransition); 128 virtual void SetIsCustomAnimation(bool isCustom); SetIgnoreLayoutSafeArea(const NG::IgnoreLayoutSafeAreaOpts & opts)129 virtual void SetIgnoreLayoutSafeArea(const NG::IgnoreLayoutSafeAreaOpts& opts) {}; SetSystemBarStyle(const RefPtr<SystemBarStyle> & style)130 virtual void SetSystemBarStyle(const RefPtr<SystemBarStyle>& style) {}; SetRecoverable(bool recoverable)131 virtual void SetRecoverable(bool recoverable) {} SetEnableDragBar(bool recoverable)132 virtual void SetEnableDragBar(bool recoverable) {} ResetResObj(NavigationPatternType type,const std::string & key)133 virtual void ResetResObj(NavigationPatternType type, const std::string& key) {} ParseCommonTitle(bool hasSubTitle,bool hasMainTitle,const RefPtr<ResourceObject> & subResObj,const RefPtr<ResourceObject> & mainResObj)134 virtual bool ParseCommonTitle(bool hasSubTitle, bool hasMainTitle, const RefPtr<ResourceObject>& subResObj, 135 const RefPtr<ResourceObject>& mainResObj) {return false;}; UpdateMainTitle(const RefPtr<NG::TitleBarNode> & titleBarNode,const RefPtr<ResourceObject> & mainResObj)136 virtual void UpdateMainTitle( 137 const RefPtr<NG::TitleBarNode>& titleBarNode, const RefPtr<ResourceObject>& mainResObj) {}; UpdateSubTitle(const RefPtr<NG::TitleBarNode> & titleBarNode,const RefPtr<ResourceObject> & subResObj)138 virtual void UpdateSubTitle( 139 const RefPtr<NG::TitleBarNode>& titleBarNode, const RefPtr<ResourceObject>& subResObj) {}; UseHomeDestination()140 virtual bool UseHomeDestination() const { return false; } SetHomePathInfoWithCallback(std::function<void (const RefPtr<NG::NavigationStack> &)> && setHomePathInfoCallback)141 virtual void SetHomePathInfoWithCallback( 142 std::function<void(const RefPtr<NG::NavigationStack>&)>&& setHomePathInfoCallback) {} 143 144 private: 145 static std::unique_ptr<NavigationModel> instance_; 146 static std::mutex mutex_; 147 }; 148 } // namespace OHOS::Ace 149 #endif // FOUNDATION_ACE_FRAMEWORKS_CORE_COMPONENTS_NG_PATTERNS_NAVIGATION_NAVIGATION_MODEL_H 150