Updated pane context menu (#18126)

dm17ryk · zadjii-msft · web-flow · commit a093ca3d54ff · 2025-05-15T15:56:58.000-07:00
## Motivation The motivation is that Windows users are more accustomed to working with GUI Menus using a mouse, unlike Linux users. ## Summary of the Pull Request added split pane with profile or duplicate up/down/left/right context menus as submenu added swap panes up/down/left/right context menus as submenu added toggle pane zoom context menu added close other panes context menu ## References : - Relevant Issues : (#18137) ## Type of change : - [x] New feature --------- Co-authored-by: Mike Griese <migrie@microsoft.com>
diff --git a/src/cascadia/TerminalApp/Resources/en-US/Resources.resw b/src/cascadia/TerminalApp/Resources/en-US/Resources.resw
@@ -214,6 +214,45 @@
   <data name="SplitPaneText" xml:space="preserve">
     <value>Split pane</value>
   </data>
+  <data name="SplitPaneToolTipText" xml:space="preserve">
+    <value>Right click for split directions - right/down/up/left</value>
+  </data>
+  <data name="SplitPaneDownText" xml:space="preserve">
+    <value>Split pane down</value>
+  </data>
+  <data name="SplitPaneRightText" xml:space="preserve">
+    <value>Split pane right</value>
+  </data>
+  <data name="SplitPaneUpText" xml:space="preserve">
+    <value>Split pane up</value>
+  </data>
+  <data name="SplitPaneLeftText" xml:space="preserve">
+    <value>Split pane left</value>
+  </data>
+  <data name="SplitPaneDuplicateText" xml:space="preserve">
+    <value>Duplicate</value>
+  </data>
+  <data name="SwapPaneText" xml:space="preserve">
+    <value>Swap pane</value>
+  </data>
+  <data name="SwapPaneDownText" xml:space="preserve">
+    <value>Swap pane down</value>
+  </data>
+  <data name="SwapPaneRightText" xml:space="preserve">
+    <value>Swap pane right</value>
+  </data>
+  <data name="SwapPaneUpText" xml:space="preserve">
+    <value>Swap pane up</value>
+  </data>
+  <data name="SwapPaneLeftText" xml:space="preserve">
+    <value>Swap pane left</value>
+  </data>
+  <data name="TogglePaneZoomText" xml:space="preserve">
+    <value>Toggle pane zoom</value>
+  </data>
+  <data name="CloseOtherPanesText" xml:space="preserve">
+    <value>Close other panes</value>
+  </data>
   <data name="SearchWebText" xml:space="preserve">
     <value>Web search</value>
   </data>
diff --git a/src/cascadia/TerminalApp/TerminalPage.cpp b/src/cascadia/TerminalApp/TerminalPage.cpp
@@ -4988,9 +4988,48 @@ namespace winrt::TerminalApp::implementation
             };
         };
 
-        auto makeItem = [&menu, &makeCallback](const winrt::hstring& label,
+        auto makeItem = [&makeCallback](const winrt::hstring& label,
+                                        const winrt::hstring& icon,
+                                        const auto& action,
+                                        auto& targetMenu) {
+            AppBarButton button{};
+
+            if (!icon.empty())
+            {
+                auto iconElement = UI::IconPathConverter::IconWUX(icon);
+                Automation::AutomationProperties::SetAccessibilityView(iconElement, Automation::Peers::AccessibilityView::Raw);
+                button.Icon(iconElement);
+            }
+
+            button.Label(label);
+            button.Click(makeCallback(action));
+            targetMenu.SecondaryCommands().Append(button);
+        };
+
+        auto makeMenuItem = [](const winrt::hstring& label,
+                               const winrt::hstring& icon,
+                               const auto& subMenu,
+                               auto& targetMenu) {
+            AppBarButton button{};
+
+            if (!icon.empty())
+            {
+                auto iconElement = UI::IconPathConverter::IconWUX(icon);
+                Automation::AutomationProperties::SetAccessibilityView(iconElement, Automation::Peers::AccessibilityView::Raw);
+                button.Icon(iconElement);
+            }
+
+            button.Label(label);
+            button.Flyout(subMenu);
+            targetMenu.SecondaryCommands().Append(button);
+        };
+
+        auto makeContextItem = [&makeCallback](const winrt::hstring& label,
                                                const winrt::hstring& icon,
-                                               const auto& action) {
+                                               const winrt::hstring& tooltip,
+                                               const auto& action,
+                                               const auto& subMenu,
+                                               auto& targetMenu) {
             AppBarButton button{};
 
             if (!icon.empty())
@@ -5002,34 +5041,122 @@ namespace winrt::TerminalApp::implementation
 
             button.Label(label);
             button.Click(makeCallback(action));
-            menu.SecondaryCommands().Append(button);
+            WUX::Controls::ToolTipService::SetToolTip(button, box_value(tooltip));
+            button.ContextFlyout(subMenu);
+            targetMenu.SecondaryCommands().Append(button);
         };
 
+        const auto focusedProfile = _GetFocusedTabImpl()->GetFocusedProfile();
+        auto separatorItem = AppBarSeparator{};
+        auto activeProfiles = _settings.ActiveProfiles();
+        auto activeProfileCount = gsl::narrow_cast<int>(activeProfiles.Size());
+        MUX::Controls::CommandBarFlyout splitPaneMenu{};
+
         // Wire up each item to the action that should be performed. By actually
         // connecting these to actions, we ensure the implementation is
         // consistent. This also leaves room for customizing this menu with
         // actions in the future.
 
-        makeItem(RS_(L"SplitPaneText"), L"\xF246", ActionAndArgs{ ShortcutAction::SplitPane, SplitPaneArgs{ SplitType::Duplicate } });
-        makeItem(RS_(L"DuplicateTabText"), L"\xF5ED", ActionAndArgs{ ShortcutAction::DuplicateTab, nullptr });
+        makeItem(RS_(L"DuplicateTabText"), L"\xF5ED", ActionAndArgs{ ShortcutAction::DuplicateTab, nullptr }, menu);
+
+        const auto focusedProfileName = focusedProfile.Name();
+        const auto focusedProfileIcon = focusedProfile.Icon();
+        const auto splitPaneDuplicateText = RS_(L"SplitPaneDuplicateText") + L" " + focusedProfileName; // SplitPaneDuplicateText
+
+        const auto splitPaneRightText = RS_(L"SplitPaneRightText");
+        const auto splitPaneDownText = RS_(L"SplitPaneDownText");
+        const auto splitPaneUpText = RS_(L"SplitPaneUpText");
+        const auto splitPaneLeftText = RS_(L"SplitPaneLeftText");
+        const auto splitPaneToolTipText = RS_(L"SplitPaneToolTipText");
+
+        MUX::Controls::CommandBarFlyout splitPaneContextMenu{};
+        makeItem(splitPaneRightText, focusedProfileIcon, ActionAndArgs{ ShortcutAction::SplitPane, SplitPaneArgs{ SplitType::Duplicate, SplitDirection::Right, .5, nullptr } }, splitPaneContextMenu);
+        makeItem(splitPaneDownText, focusedProfileIcon, ActionAndArgs{ ShortcutAction::SplitPane, SplitPaneArgs{ SplitType::Duplicate, SplitDirection::Down, .5, nullptr } }, splitPaneContextMenu);
+        makeItem(splitPaneUpText, focusedProfileIcon, ActionAndArgs{ ShortcutAction::SplitPane, SplitPaneArgs{ SplitType::Duplicate, SplitDirection::Up, .5, nullptr } }, splitPaneContextMenu);
+        makeItem(splitPaneLeftText, focusedProfileIcon, ActionAndArgs{ ShortcutAction::SplitPane, SplitPaneArgs{ SplitType::Duplicate, SplitDirection::Left, .5, nullptr } }, splitPaneContextMenu);
+
+        makeContextItem(splitPaneDuplicateText, focusedProfileIcon, splitPaneToolTipText, ActionAndArgs{ ShortcutAction::SplitPane, SplitPaneArgs{ SplitType::Duplicate, SplitDirection::Automatic, .5, nullptr } }, splitPaneContextMenu, splitPaneMenu);
+
+        // add menu separator
+        const auto separatorAutoItem = AppBarSeparator{};
+
+        splitPaneMenu.SecondaryCommands().Append(separatorAutoItem);
+
+        for (auto profileIndex = 0; profileIndex < activeProfileCount; profileIndex++)
+        {
+            const auto profile = activeProfiles.GetAt(profileIndex);
+            const auto profileName = profile.Name();
+            const auto profileIcon = profile.Icon();
+
+            NewTerminalArgs args{};
+            args.Profile(profileName);
+
+            MUX::Controls::CommandBarFlyout splitPaneContextMenu{};
+            makeItem(splitPaneRightText, profileIcon, ActionAndArgs{ ShortcutAction::SplitPane, SplitPaneArgs{ SplitType::Manual, SplitDirection::Right, .5, args } }, splitPaneContextMenu);
+            makeItem(splitPaneDownText, profileIcon, ActionAndArgs{ ShortcutAction::SplitPane, SplitPaneArgs{ SplitType::Manual, SplitDirection::Down, .5, args } }, splitPaneContextMenu);
+            makeItem(splitPaneUpText, profileIcon, ActionAndArgs{ ShortcutAction::SplitPane, SplitPaneArgs{ SplitType::Manual, SplitDirection::Up, .5, args } }, splitPaneContextMenu);
+            makeItem(splitPaneLeftText, profileIcon, ActionAndArgs{ ShortcutAction::SplitPane, SplitPaneArgs{ SplitType::Manual, SplitDirection::Left, .5, args } }, splitPaneContextMenu);
+
+            makeContextItem(profileName, profileIcon, splitPaneToolTipText, ActionAndArgs{ ShortcutAction::SplitPane, SplitPaneArgs{ SplitType::Manual, SplitDirection::Automatic, .5, args } }, splitPaneContextMenu, splitPaneMenu);
+        }
+
+        makeMenuItem(RS_(L"SplitPaneText"), L"\xF246", splitPaneMenu, menu);
 
         // Only wire up "Close Pane" if there's multiple panes.
         if (_GetFocusedTabImpl()->GetLeafPaneCount() > 1)
         {
-            makeItem(RS_(L"PaneClose"), L"\xE89F", ActionAndArgs{ ShortcutAction::ClosePane, nullptr });
+            MUX::Controls::CommandBarFlyout swapPaneMenu{};
+            const auto rootPane = _GetFocusedTabImpl()->GetRootPane();
+            const auto mruPanes = _GetFocusedTabImpl()->GetMruPanes();
+            auto activePane = _GetFocusedTabImpl()->GetActivePane();
+            rootPane->WalkTree([&](auto p) {
+                if (const auto& c{ p->GetTerminalControl() })
+                {
+                    if (c == control)
+                    {
+                        activePane = p;
+                    }
+                }
+            });
+
+            if (auto neighbor = rootPane->NavigateDirection(activePane, FocusDirection::Down, mruPanes))
+            {
+                makeItem(RS_(L"SwapPaneDownText"), neighbor->GetProfile().Icon(), ActionAndArgs{ ShortcutAction::SwapPane, SwapPaneArgs{ FocusDirection::Down } }, swapPaneMenu);
+            }
+
+            if (auto neighbor = rootPane->NavigateDirection(activePane, FocusDirection::Right, mruPanes))
+            {
+                makeItem(RS_(L"SwapPaneRightText"), neighbor->GetProfile().Icon(), ActionAndArgs{ ShortcutAction::SwapPane, SwapPaneArgs{ FocusDirection::Right } }, swapPaneMenu);
+            }
+
+            if (auto neighbor = rootPane->NavigateDirection(activePane, FocusDirection::Up, mruPanes))
+            {
+                makeItem(RS_(L"SwapPaneUpText"), neighbor->GetProfile().Icon(), ActionAndArgs{ ShortcutAction::SwapPane, SwapPaneArgs{ FocusDirection::Up } }, swapPaneMenu);
+            }
+
+            if (auto neighbor = rootPane->NavigateDirection(activePane, FocusDirection::Left, mruPanes))
+            {
+                makeItem(RS_(L"SwapPaneLeftText"), neighbor->GetProfile().Icon(), ActionAndArgs{ ShortcutAction::SwapPane, SwapPaneArgs{ FocusDirection::Left } }, swapPaneMenu);
+            }
+
+            makeMenuItem(RS_(L"SwapPaneText"), L"\xF1CB", swapPaneMenu, menu);
+
+            makeItem(RS_(L"TogglePaneZoomText"), L"\xE8A3", ActionAndArgs{ ShortcutAction::TogglePaneZoom, nullptr }, menu);
+            makeItem(RS_(L"CloseOtherPanesText"), L"\xE89F", ActionAndArgs{ ShortcutAction::CloseOtherPanes, nullptr }, menu);
+            makeItem(RS_(L"PaneClose"), L"\xE89F", ActionAndArgs{ ShortcutAction::ClosePane, nullptr }, menu);
         }
 
         if (control.ConnectionState() >= ConnectionState::Closed)
         {
-            makeItem(RS_(L"RestartConnectionText"), L"\xE72C", ActionAndArgs{ ShortcutAction::RestartConnection, nullptr });
+            makeItem(RS_(L"RestartConnectionText"), L"\xE72C", ActionAndArgs{ ShortcutAction::RestartConnection, nullptr }, menu);
         }
 
         if (withSelection)
         {
-            makeItem(RS_(L"SearchWebText"), L"\xF6FA", ActionAndArgs{ ShortcutAction::SearchForText, nullptr });
+            makeItem(RS_(L"SearchWebText"), L"\xF6FA", ActionAndArgs{ ShortcutAction::SearchForText, nullptr }, menu);
         }
 
-        makeItem(RS_(L"TabClose"), L"\xE711", ActionAndArgs{ ShortcutAction::CloseTab, CloseTabArgs{ _GetFocusedTabIndex().value() } });
+        makeItem(RS_(L"TabClose"), L"\xE711", ActionAndArgs{ ShortcutAction::CloseTab, CloseTabArgs{ _GetFocusedTabIndex().value() } }, menu);
     }
 
     void TerminalPage::_PopulateQuickFixMenu(const TermControl& control,
diff --git a/src/cascadia/TerminalApp/TerminalTab.h b/src/cascadia/TerminalApp/TerminalTab.h
@@ -91,6 +91,7 @@ namespace winrt::TerminalApp::implementation
         winrt::TerminalApp::TaskbarState GetCombinedTaskbarState() const;
 
         std::shared_ptr<Pane> GetRootPane() const { return _rootPane; }
+        std::vector<uint32_t> GetMruPanes() const { return _mruPanes; }
 
         winrt::TerminalApp::TerminalTabStatus TabStatus()
         {
diff --git a/src/cascadia/TerminalControl/Resources/en-US/Resources.resw b/src/cascadia/TerminalControl/Resources/en-US/Resources.resw
@@ -262,10 +262,18 @@ Please either install the missing font or choose another one.</value>
     <comment>The tooltip for a paste button</comment>
   </data>
   <data name="SearchCommandButton.Label" xml:space="preserve">
+    <value>Find...</value>
+    <comment>The label of a button for searching for the text</comment>
+  </data>
+  <data name="SearchCommandSelectionButton.Label" xml:space="preserve">
     <value>Find...</value>
     <comment>The label of a button for searching for the selected text</comment>
   </data>
   <data name="SearchCommandButton.ToolTipService.ToolTip" xml:space="preserve">
+    <value>Find</value>
+    <comment>The tooltip for a button for searching for the text</comment>
+  </data>
+  <data name="SearchCommandSelectionButton.ToolTipService.ToolTip" xml:space="preserve">
     <value>Find</value>
     <comment>The tooltip for a button for searching for the selected text</comment>
   </data>
@@ -334,4 +342,4 @@ Please either install the missing font or choose another one.</value>
     <value>Suggested input: {0}</value>
     <comment>{Locked="{0}"} {0} will be replaced with a string of input that is suggested for the user to input</comment>
   </data>
-</root>
+</root>
diff --git a/src/cascadia/TerminalControl/TermControl.xaml b/src/cascadia/TerminalControl/TermControl.xaml
@@ -52,6 +52,10 @@
                               x:Uid="SelectOutputButton"
                               Click="_SelectOutputHandler"
                               Icon="AlignLeft" />
+                <AppBarButton x:Name="SearchCommandButton"
+                              x:Uid="SearchCommandButton"
+                              Click="_SearchCommandHandler"
+                              Icon="Find" />
             </mux:CommandBarFlyout.SecondaryCommands>
         </mux:CommandBarFlyout>
 
@@ -65,10 +69,6 @@
                           Click="_PasteCommandHandler"
                           Icon="Paste" />
             <mux:CommandBarFlyout.SecondaryCommands>
-                <AppBarButton x:Name="SearchCommandButton"
-                              x:Uid="SearchCommandButton"
-                              Click="_SearchCommandHandler"
-                              Icon="Find" />
                 <AppBarButton x:Name="SelectCommandWithSelectionButton"
                               x:Uid="SelectCommandWithSelectionButton"
                               Click="_SelectCommandHandler">
@@ -82,6 +82,10 @@
                               x:Uid="SelectOutputWithSelectionButton"
                               Click="_SelectOutputHandler"
                               Icon="AlignLeft" />
+                <AppBarButton x:Name="SearchCommandSelectionButton"
+                              x:Uid="SearchCommandSelectionButton"
+                              Click="_SearchCommandHandler"
+                              Icon="Find" />
             </mux:CommandBarFlyout.SecondaryCommands>
         </mux:CommandBarFlyout>
 
diff --git a/src/cascadia/TerminalControl/TerminalControlLib.vcxproj b/src/cascadia/TerminalControl/TerminalControlLib.vcxproj
@@ -9,7 +9,6 @@
     <ConfigurationType>StaticLibrary</ConfigurationType>
     <SubSystem>Console</SubSystem>
     <OpenConsoleUniversalApp>true</OpenConsoleUniversalApp>
-
     <!-- C++/WinRT sets the depth to 1 if there is a XAML file in the project
          Unfortunately for us, we need it to be 3. When the namespace merging
          depth is 1, Microsoft.Terminal.Control becomes "Microsoft",
@@ -20,18 +19,14 @@
     -->
     <CppWinRTNamespaceMergeDepth>3</CppWinRTNamespaceMergeDepth>
     <XamlComponentResourceLocation>nested</XamlComponentResourceLocation>
-
   </PropertyGroup>
-
   <PropertyGroup Label="NuGet Dependencies">
     <TerminalCppWinrt>true</TerminalCppWinrt>
     <TerminalMUX>true</TerminalMUX>
   </PropertyGroup>
-
   <Import Project="..\..\..\common.openconsole.props" Condition="'$(OpenConsoleDir)'==''" />
   <Import Project="$(OpenConsoleDir)src\common.nugetversions.props" />
   <Import Project="$(OpenConsoleDir)src\cppwinrt.build.pre.props" />
-
   <!-- ========================= Headers ======================== -->
   <ItemGroup>
     <ClInclude Include="pch.h" />
@@ -143,7 +138,9 @@
   </ItemGroup>
   <!-- ========================= Misc Files ======================== -->
   <ItemGroup>
-    <PRIResource Include="Resources\en-US\Resources.resw" />
+    <PRIResource Include="Resources\en-US\Resources.resw">
+      <SubType>Designer</SubType>
+    </PRIResource>
     <OCResourceDirectory Include="Resources" />
   </ItemGroup>
   <!-- ========================= Project References ======================== -->
@@ -183,9 +180,7 @@
   </ItemDefinitionGroup>
   <!-- ========================= Globals ======================== -->
   <Import Project="$(OpenConsoleDir)src\cppwinrt.build.post.props" />
-
   <!-- This -must- go after cppwinrt.build.post.props because that includes many VS-provided props including appcontainer.common.props, which stomps on what cppwinrt.targets did. -->
   <Import Project="$(OpenConsoleDir)src\common.nugetversions.targets" />
-
   <Import Project="$(SolutionDir)build\rules\CollectWildcardResources.targets" />
-</Project>
+</Project>

Original file line number	Diff line number	Diff line change
`@@ -91,6 +91,7 @@ namespace winrt::TerminalApp::implementation`
`91`	`91`	`winrt::TerminalApp::TaskbarState GetCombinedTaskbarState() const;`
`92`	`92`
`93`	`93`	`std::shared_ptr<Pane> GetRootPane() const { return _rootPane; }`
	`94`	`+ std::vector<uint32_t> GetMruPanes() const { return _mruPanes; }`
`94`	`95`
`95`	`96`	`winrt::TerminalApp::TerminalTabStatus TabStatus()`
`96`	`97`	`{`