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 32 namespace OHOS::Ace { 33 using NavigationTransitionEvent = std::function<NG::NavigationTransition( 34 RefPtr<NG::NavDestinationContext> from, RefPtr<NG::NavDestinationContext> to, NG::NavigationOperation operation)>; 35 using OnNavBarWidthChangeEvent = std::function<void(const Dimension)>; 36 class ACE_FORCE_EXPORT NavigationModel { 37 public: 38 static NavigationModel* GetInstance(); 39 virtual ~NavigationModel() = default; 40 41 virtual void Create() = 0; 42 virtual void SetNavigationStack() = 0; 43 virtual void SetNavigationStack(const RefPtr<NG::NavigationStack>& navigationStack) = 0; SetNavigationStackWithCreatorAndUpdater(std::function<RefPtr<NG::NavigationStack> ()> creator,std::function<void (RefPtr<NG::NavigationStack>)> updater)44 virtual void SetNavigationStackWithCreatorAndUpdater(std::function<RefPtr<NG::NavigationStack>()> creator, 45 std::function<void(RefPtr<NG::NavigationStack>)> updater) {}; SetNavigationPathInfo(const std::string & moduleName,const std::string & pagePath)46 virtual void SetNavigationPathInfo(const std::string& moduleName, const std::string& pagePath) {}; 47 virtual void SetNavigationStackProvided(bool provided) = 0; 48 virtual bool ParseCommonTitle(bool hasSubTitle, bool hasMainTitle, const std::string& subtitle, 49 const std::string& title, bool ignoreMainTitle = false) 50 { 51 return false; 52 } 53 virtual void SetTitle(const std::string& title, bool hasSubTitle = false) = 0; SetTitlebarOptions(NG::NavigationTitlebarOptions && opt)54 virtual void SetTitlebarOptions(NG::NavigationTitlebarOptions&& opt) {} 55 virtual void SetCustomTitle(const RefPtr<AceType>& customNode) = 0; 56 virtual void SetTitleHeight(const Dimension& height, bool isValid = true) = 0; 57 virtual void SetTitleMode(NG::NavigationTitleMode mode) = 0; 58 virtual void SetSubtitle(const std::string& subtitle) = 0; 59 virtual void SetEnableModeChangeAnimation(bool isEnable) = 0; 60 virtual void SetHideTitleBar(bool hideTitleBar, bool animated = false) = 0; 61 virtual void SetHideNavBar(bool hideNavBar) = 0; 62 virtual void SetBackButtonIcon(const std::function<void(WeakPtr<NG::FrameNode>)>& symbolApply, 63 const std::string& src, const NG::ImageOption& imageOption, RefPtr<PixelMap>& pixMap, 64 const std::vector<std::string>& nameList, bool userDefinedAccessibilityText = false, 65 const std::string& backButtonAccessibilityText = ""); 66 virtual void SetHideBackButton(bool hideBackButton) = 0; 67 virtual void SetHideToolBar(bool hideToolBar, bool animated = false) = 0; 68 virtual void SetCustomToolBar(const RefPtr<AceType>& customNode) = 0; 69 virtual bool NeedSetItems() = 0; 70 virtual void SetToolBarItems(std::vector<NG::BarItem>&& toolBarItems) = 0; SetHideItemText(bool isHideItemText)71 virtual void SetHideItemText(bool isHideItemText) {}; SetEnableToolBarAdaptation(bool disable)72 virtual void SetEnableToolBarAdaptation(bool disable) {}; 73 virtual void SetToolbarConfiguration(std::vector<NG::BarItem>&& toolBarItems) = 0; GetToolBarItems(std::list<RefPtr<AceType>> & items)74 virtual void GetToolBarItems(std::list<RefPtr<AceType>>& items) {}; SetToolbarOptions(NG::NavigationToolbarOptions && opt)75 virtual void SetToolbarOptions(NG::NavigationToolbarOptions&& opt) {} SetToolbarMorebuttonOptions(NG::MoreButtonOptions && opt)76 virtual void SetToolbarMorebuttonOptions(NG::MoreButtonOptions&& opt) {} 77 virtual void SetMenuItems(std::vector<NG::BarItem>&& menuItems) = 0; GetMenuItems(std::list<RefPtr<AceType>> & items)78 virtual void GetMenuItems(std::list<RefPtr<AceType>>& items) {}; SetMenuOptions(NG::NavigationMenuOptions && opt)79 virtual void SetMenuOptions(NG::NavigationMenuOptions&& opt) {} 80 virtual void SetCustomMenu(const RefPtr<AceType>& customNode) = 0; 81 virtual void SetOnTitleModeChange(std::function<void(NG::NavigationTitleMode)>&& onTitleModeChange, 82 std::function<void(const BaseEventInfo* baseInfo)>&& eventInfo) = 0; 83 virtual void SetUsrNavigationMode(NG::NavigationMode mode) = 0; 84 virtual void SetNavBarPosition(NG::NavBarPosition mode) = 0; 85 virtual void SetNavBarWidth(const Dimension& value, bool isDoubleBind = false) = 0; 86 virtual void SetMinNavBarWidth(const Dimension& value) = 0; 87 virtual void SetMaxNavBarWidth(const Dimension& value) = 0; 88 virtual void SetMinContentWidth(const Dimension& value) = 0; 89 virtual void SetOnNavBarStateChange(std::function<void(bool)>&& onNavBarStateChange) = 0; 90 virtual void SetOnNavigationModeChange(std::function<void(NG::NavigationMode)>&& onNavigationModeChange); SetOnNavBarWidthChangeEvent(OnNavBarWidthChangeEvent event)91 virtual void SetOnNavBarWidthChangeEvent(OnNavBarWidthChangeEvent event) {}; 92 virtual void SetNavigationMode(NG::NavigationMode mode) = 0; 93 virtual void SetNavDestination(std::function<void(std::string)>&& builder) = 0; 94 virtual RefPtr<NG::NavigationStack> GetNavigationStack() = 0; 95 virtual void SetMenuCount(int32_t menuCount) = 0; 96 virtual void SetCustomTransition(NavigationTransitionEvent&& animationTransition); 97 virtual void SetIsCustomAnimation(bool isCustom); SetIgnoreLayoutSafeArea(const NG::SafeAreaExpandOpts & opts)98 virtual void SetIgnoreLayoutSafeArea(const NG::SafeAreaExpandOpts& opts) {}; SetSystemBarStyle(const RefPtr<SystemBarStyle> & style)99 virtual void SetSystemBarStyle(const RefPtr<SystemBarStyle>& style) {}; SetRecoverable(bool recoverable)100 virtual void SetRecoverable(bool recoverable) {} SetEnableDragBar(bool recoverable)101 virtual void SetEnableDragBar(bool recoverable) {} 102 103 private: 104 static std::unique_ptr<NavigationModel> instance_; 105 static std::mutex mutex_; 106 }; 107 } // namespace OHOS::Ace 108 #endif // FOUNDATION_ACE_FRAMEWORKS_CORE_COMPONENTS_NG_PATTERNS_NAVIGATION_NAVIGATION_MODEL_H 109