Add a keybinding option to Terminal to open the Settings UI (#8048)

This commit iontroduces another `target` to the `openSettings` binding:
`settingsUI`. It opens the settings UI introduced in the previous
commit.

Closes #1564
Closes #8048 (PR)

Co-authored-by: Carlos Zamora <[email protected]>
Co-authored-by: Leon Liang <[email protected]>

src/cascadia/LocalTests_TerminalApp/TerminalApp.LocalTests.vcxproj

@@ -58,6 +58,7 @@
 
     <!-- If you don't reference these projects here, the
     _ConsoleGenerateAdditionalWinmdManifests step won't gather the winmd's -->
+    <ProjectReference Include="$(OpenConsoleDir)src\cascadia\TerminalSettingsEditor\Microsoft.Terminal.Settings.Editor.vcxproj" />
     <ProjectReference Include="$(OpenConsoleDir)src\cascadia\TerminalControl\TerminalControl.vcxproj" />
     <ProjectReference Include="$(OpenConsoleDir)src\cascadia\TerminalConnection\TerminalConnection.vcxproj" />
     <ProjectReference Include="$(OpenConsoleDir)\src\cascadia\TerminalApp\dll\TerminalApp.vcxproj" />

src/cascadia/LocalTests_TerminalApp/TestHostApp/TestHostApp.vcxproj

@@ -95,6 +95,8 @@
     <ProjectReference Include="$(OpenConsoleDir)src\cascadia\TerminalConnection\TerminalConnection.vcxproj">
       <Project>{CA5CAD1A-C46D-4588-B1C0-40F31AE9100B}</Project>
     </ProjectReference>
+
+    <ProjectReference Include="$(OpenConsoleDir)src\cascadia\TerminalSettingsEditor\Microsoft.Terminal.Settings.Editor.vcxproj" />
     <ProjectReference Include="$(OpenConsoleDir)src\cascadia\TerminalControl\TerminalControl.vcxproj" />
 
     <ProjectReference Include="$(OpenConsoleDir)src\cascadia\TerminalApp\dll\TerminalApp.vcxproj">

src/cascadia/TerminalApp/Resources/en-US/Resources.resw

@@ -486,6 +486,9 @@
   <data name="CouldNotOpenUriDialog.PrimaryButtonText" xml:space="preserve">
     <value>Cancel</value>
   </data>
+  <data name="SettingsTab" xml:space="preserve">
+    <value>Settings</value>
+  </data>
   <data name="FailedToWriteToSettings" xml:space="preserve">
     <value>We could not write to your settings file. Check the permissions on that file to ensure that the read-only flag is not set and that write access is granted.</value>
   </data>

src/cascadia/TerminalApp/SettingsTab.cpp

@@ -0,0 +1,92 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+
+#include "pch.h"
+#include <LibraryResources.h>
+#include "SettingsTab.h"
+#include "SettingsTab.g.cpp"
+#include "Utils.h"
+
+using namespace winrt;
+using namespace winrt::Windows::UI::Xaml;
+using namespace winrt::Windows::UI::Core;
+using namespace winrt::Microsoft::Terminal::TerminalControl;
+using namespace winrt::Microsoft::Terminal::Settings::Model;
+using namespace winrt::Microsoft::Terminal::Settings::Editor;
+using namespace winrt::Windows::System;
+
+namespace winrt
+{
+    namespace MUX = Microsoft::UI::Xaml;
+    namespace WUX = Windows::UI::Xaml;
+}
+
+namespace winrt::TerminalApp::implementation
+{
+    SettingsTab::SettingsTab(MainPage settingsUI)
+    {
+        Content(settingsUI);
+
+        _MakeTabViewItem();
+        _CreateContextMenu();
+        _CreateIcon();
+    }
+
+    void SettingsTab::UpdateSettings(CascadiaSettings settings)
+    {
+        auto settingsUI{ Content().as<MainPage>() };
+        settingsUI.UpdateSettings(settings);
+    }
+
+    // Method Description:
+    // - Focus the settings UI
+    // Arguments:
+    // - focusState: The FocusState mode by which focus is to be obtained.
+    // Return Value:
+    // - <none>
+    void SettingsTab::Focus(WUX::FocusState focusState)
+    {
+        _focusState = focusState;
+
+        if (_focusState != FocusState::Unfocused)
+        {
+            Content().as<WUX::Controls::Page>().Focus(focusState);
+        }
+    }
+
+    // Method Description:
+    // - Initializes a TabViewItem for this Tab instance.
+    // Arguments:
+    // - <none>
+    // Return Value:
+    // - <none>
+    void SettingsTab::_MakeTabViewItem()
+    {
+        TabViewItem(::winrt::MUX::Controls::TabViewItem{});
+        Title(RS_(L"SettingsTab"));
+        TabViewItem().Header(winrt::box_value(Title()));
+    }
+
+    // Method Description:
+    // - Set the icon on the TabViewItem for this tab.
+    // Arguments:
+    // - <none>
+    // Return Value:
+    // - <none>
+    winrt::fire_and_forget SettingsTab::_CreateIcon()
+    {
+        auto weakThis{ get_weak() };
+
+        co_await winrt::resume_foreground(TabViewItem().Dispatcher());
+
+        if (auto tab{ weakThis.get() })
+        {
+            auto fontFamily = winrt::WUX::Media::FontFamily(L"Segoe MDL2 Assets");
+            auto glyph = L"\xE713"; // This is the Setting icon (looks like a gear)
+
+            // The TabViewItem Icon needs MUX while the IconSourceElement in the CommandPalette needs WUX...
+            Icon(glyph);
+            TabViewItem().IconSource(IconPathConverter::IconSourceMUX(glyph));
+        }
+    }
+}

src/cascadia/TerminalApp/SettingsTab.h

@@ -0,0 +1,39 @@
+/*++
+Copyright (c) Microsoft Corporation
+Licensed under the MIT license.
+
+Module Name:
+- SettingsTab.h
+
+Abstract:
+- The SettingsTab is a tab whose content is a Settings UI control. They can
+  coexist in a TabView with all other types of tabs, like the TerminalTab.
+  There should only be at most one SettingsTab open at any given time.
+
+Author(s):
+- Leon Liang - October 2020
+
+--*/
+
+#pragma once
+#include "TabBase.h"
+#include "SettingsTab.g.h"
+#include <winrt/TerminalApp.h>
+#include <winrt/Microsoft.Terminal.Settings.Editor.h>
+#include "../../cascadia/inc/cppwinrt_utils.h"
+
+namespace winrt::TerminalApp::implementation
+{
+    struct SettingsTab : SettingsTabT<SettingsTab, TabBase>
+    {
+    public:
+        SettingsTab(winrt::Microsoft::Terminal::Settings::Editor::MainPage settingsUI);
+
+        void UpdateSettings(Microsoft::Terminal::Settings::Model::CascadiaSettings settings);
+        void Focus(winrt::Windows::UI::Xaml::FocusState focusState) override;
+
+    private:
+        void _MakeTabViewItem();
+        winrt::fire_and_forget _CreateIcon();
+    };
+}

src/cascadia/TerminalApp/SettingsTab.idl

@@ -0,0 +1,12 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+
+import "TabBase.idl";
+
+namespace TerminalApp
+{
+    [default_interface] runtimeclass SettingsTab : TabBase
+    {
+        void UpdateSettings(Microsoft.Terminal.Settings.Model.CascadiaSettings settings);
+    }
+}

src/cascadia/TerminalApp/TerminalAppLib.vcxproj

@@ -78,6 +78,9 @@
     <ClInclude Include="MinMaxCloseControl.h">
       <DependentUpon>MinMaxCloseControl.xaml</DependentUpon>
     </ClInclude>
+    <ClInclude Include="SettingsTab.h">
+      <DependentUpon>SettingsTab.idl</DependentUpon>
+    </ClInclude>
     <ClInclude Include="PaletteItem.h" />
     <ClInclude Include="TabBase.h">
       <DependentUpon>TabBase.idl</DependentUpon>
@@ -147,6 +150,9 @@
     <ClCompile Include="MinMaxCloseControl.cpp">
       <DependentUpon>MinMaxCloseControl.xaml</DependentUpon>
     </ClCompile>
+    <ClCompile Include="SettingsTab.cpp">
+      <DependentUpon>SettingsTab.idl</DependentUpon>
+    </ClCompile>
     <ClCompile Include="PaletteItem.cpp" />
     <ClCompile Include="TabBase.cpp">
       <DependentUpon>TabBase.idl</DependentUpon>
@@ -222,6 +228,7 @@
     <Midl Include="App.idl">
       <DependentUpon>App.xaml</DependentUpon>
     </Midl>
+    <Midl Include="SettingsTab.idl" />
     <Midl Include="PaletteItem.idl" />
     <Midl Include="ShortcutActionDispatch.idl" />
     <Midl Include="AppKeyBindings.idl" />
@@ -312,6 +319,12 @@
       <Private>false</Private>
       <CopyLocalSatelliteAssemblies>false</CopyLocalSatelliteAssemblies>
     </Reference>
+    <Reference Include="Microsoft.Terminal.Settings.Editor">
+      <HintPath>$(OpenConsoleCommonOutDir)Microsoft.Terminal.Settings.Editor\Microsoft.Terminal.Settings.Editor.winmd</HintPath>
+      <IsWinMDFile>true</IsWinMDFile>
+      <Private>false</Private>
+      <CopyLocalSatelliteAssemblies>false</CopyLocalSatelliteAssemblies>
+    </Reference>
     <Reference Include="Microsoft.Terminal.Settings.Model">
       <HintPath>$(OpenConsoleCommonOutDir)Microsoft.Terminal.Settings.Model\Microsoft.Terminal.Settings.Model.winmd</HintPath>
       <IsWinMDFile>true</IsWinMDFile>

src/cascadia/TerminalApp/TerminalAppLib.vcxproj.filters

@@ -31,6 +31,9 @@
     <ClCompile Include="Tab.cpp">
       <Filter>tab</Filter>
     </ClCompile>
+    <ClCompile Include="SettingsTab.cpp">
+      <Filter>tab</Filter>
+    </ClCompile>
     <ClCompile Include="FilteredCommand.cpp">
       <Filter>commandPalette</Filter>
     </ClCompile>
@@ -74,6 +77,9 @@
     <ClInclude Include="Tab.h">
       <Filter>tab</Filter>
     </ClInclude>
+    <ClInclude Include="SettingsTab.h">
+      <Filter>tab</Filter>
+    </ClInclude>
     <ClInclude Include="FilteredCommand.h">
       <Filter>commandPalette</Filter>
     </ClInclude>
@@ -110,6 +116,12 @@
     <Midl Include="TerminalSettings.idl">
       <Filter>settings</Filter>
     </Midl>
+    <Midl Include="ITab.idl">
+      <Filter>tab</Filter>
+    </Midl>
+    <Midl Include="SettingsTab.idl">
+      <Filter>tab</Filter>
+    </Midl>
     <Midl Include="TerminalTab.idl">
       <Filter>tab</Filter>
     </Midl>