Make tab header a custom control

src/cascadia/TerminalApp/TabHeaderControl.cpp

@@ -0,0 +1,110 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+
+#include "pch.h"
+#include "TabHeaderControl.h"
+
+#include "TabHeaderControl.g.cpp"
+
+using namespace winrt;
+using namespace winrt::Microsoft::UI::Xaml;
+
+namespace winrt::TerminalApp::implementation
+{
+    TabHeaderControl::TabHeaderControl()
+    {
+        InitializeComponent();
+
+        // We'll only process the KeyUp event if we received an initial KeyDown event first.
+        // Avoids issue immediately closing the tab rename when we see the enter KeyUp event that was
+        // sent to the command palette to trigger the openTabRenamer action in the first place.
+        HeaderRenamerTextBox().KeyDown([&](auto&&, auto&&) {
+            _receivedKeyDown = true;
+        });
+
+        // NOTE: (Preview)KeyDown does not work here. If you use that, we'll
+        // remove the TextBox from the UI tree, then the following KeyUp
+        // will bubble to the NewTabButton, which we don't want to have
+        // happen.
+        HeaderRenamerTextBox().KeyUp([&](auto&&, Windows::UI::Xaml::Input::KeyRoutedEventArgs const& e) {
+            if (_receivedKeyDown)
+            {
+                if (e.OriginalKey() == Windows::System::VirtualKey::Enter)
+                {
+                    // User is done making changes, close the rename box
+                    _CloseRenameBox();
+                }
+                else if (e.OriginalKey() == Windows::System::VirtualKey::Escape)
+                {
+                    // User wants to discard the changes they made,
+                    // reset the rename box text to the old text and close the rename box
+                    HeaderRenamerTextBox().Text(HeaderTextBlock().Text());
+                    _CloseRenameBox();
+                }
+            }
+        });
+    }
+
+    // Method Description
+    // - Retrives the current title
+    // Return Value:
+    // - The current title as a winrt hstring
+    winrt::hstring TabHeaderControl::CurrentHeaderText()
+    {
+        return HeaderTextBlock().Text();
+    }
+
+    // Method Description
+    // - Updates the current title
+    // Arguments:
+    // - The desired title
+    void TabHeaderControl::UpdateHeaderText(winrt::hstring title)
+    {
+        HeaderTextBlock().Text(title);
+    }
+
+    // Method Description:
+    // - Updates the zoom icon indicating whether a pane is zoomed
+    // Arguments:
+    // - The desired visibility state of the zoom icon
+    void TabHeaderControl::SetZoomIcon(Windows::UI::Xaml::Visibility state)
+    {
+        HeaderZoomIcon().Visibility(state);
+    }
+
+    // Method Description:
+    // - Show the tab rename box for the user to rename the tab title
+    // - We automatically use the previous title as the initial text of the box
+    void TabHeaderControl::ConstructTabRenameBox()
+    {
+        _receivedKeyDown = false;
+
+        HeaderTextBlock().Visibility(Windows::UI::Xaml::Visibility::Collapsed);
+        HeaderRenamerTextBox().Visibility(Windows::UI::Xaml::Visibility::Visible);
+
+        HeaderRenamerTextBox().Text(HeaderTextBlock().Text());
+        HeaderRenamerTextBox().SelectAll();
+        HeaderRenamerTextBox().Focus(Windows::UI::Xaml::FocusState::Programmatic);
+    }
+
+    // Method Description:
+    // - Event handler for when the rename box loses focus
+    void TabHeaderControl::RenameBoxLostFocusHandler(Windows::Foundation::IInspectable const& /*sender*/,
+                                                     Windows::UI::Xaml::RoutedEventArgs const& /*e*/)
+    {
+        _CloseRenameBox();
+    }
+
+    // Method Description:
+    // - Hides the rename box and displays the title text block
+    // - Updates the title text block with the rename box's text
+    void TabHeaderControl::_CloseRenameBox()
+    {
+        HeaderTextBlock().Text(HeaderRenamerTextBox().Text());
+
+        HeaderRenamerTextBox().Visibility(Windows::UI::Xaml::Visibility::Collapsed);
+        HeaderTextBlock().Visibility(Windows::UI::Xaml::Visibility::Visible);
+
+        _HeaderTitleChangedHandlers();
+    }
+}

src/cascadia/TerminalApp/TabHeaderControl.h

@@ -0,0 +1,37 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+
+#pragma once
+
+#include "winrt/Microsoft.UI.Xaml.Controls.h"
+#include "inc/cppwinrt_utils.h"
+
+#include "TabHeaderControl.g.h"
+
+namespace winrt::TerminalApp::implementation
+{
+    struct TabHeaderControl : TabHeaderControlT<TabHeaderControl>
+    {
+        TabHeaderControl();
+        winrt::hstring CurrentHeaderText();
+        void UpdateHeaderText(winrt::hstring title);
+        void SetZoomIcon(Windows::UI::Xaml::Visibility state);
+        void ConstructTabRenameBox();
+
+        void RenameBoxLostFocusHandler(winrt::Windows::Foundation::IInspectable const& sender,
+                                       winrt::Windows::UI::Xaml::RoutedEventArgs const& e);
+
+        WINRT_CALLBACK(HeaderTitleChanged, TerminalApp::HeaderTitleChangedArgs);
+
+    private:
+        void _CloseRenameBox();
+        bool _receivedKeyDown{ false };
+    };
+}
+
+namespace winrt::TerminalApp::factory_implementation
+{
+    struct TabHeaderControl : TabHeaderControlT<TabHeaderControl, implementation::TabHeaderControl>
+    {
+    };
+}

src/cascadia/TerminalApp/TabHeaderControl.idl

@@ -0,0 +1,18 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+
+namespace TerminalApp
+{
+    delegate void HeaderTitleChangedArgs();
+
+    [default_interface] runtimeclass TabHeaderControl : Windows.UI.Xaml.Controls.UserControl
+    {
+        TabHeaderControl();
+        String CurrentHeaderText();
+        void UpdateHeaderText(String title);
+        void SetZoomIcon(Windows.UI.Xaml.Visibility state);
+        void ConstructTabRenameBox();
+
+        event HeaderTitleChangedArgs HeaderTitleChanged;
+    }
+}

src/cascadia/TerminalApp/TabHeaderControl.xaml

@@ -0,0 +1,30 @@
+<!-- Copyright (c) Microsoft Corporation. All rights reserved. Licensed under
+the MIT License. See LICENSE in the project root for license information. -->
+<UserControl
+    x:Class="TerminalApp.TabHeaderControl"
+    xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
+    xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
+    xmlns:local="using:TerminalApp"
+    xmlns:mux="using:Microsoft.UI.Xaml.Controls"
+    xmlns:d="http://schemas.microsoft.com/expression/blend/2008"
+    xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006"
+    mc:Ignorable="d">
+
+    <StackPanel x:Name="HeaderStackPanel"
+                Orientation="Horizontal">
+        <FontIcon x:Name="HeaderZoomIcon"
+                  FontFamily="Segoe MDL2 Assets"
+                  Visibility="Collapsed"
+                  Glyph="&#xE8A3;"
+                  FontSize="12"
+                  Margin="0,0,8,0"/>
+        <TextBlock x:Name="HeaderTextBlock"
+                   Visibility="Visible"/>
+        <TextBox x:Name="HeaderRenamerTextBox"
+                 Visibility="Collapsed"
+                 MinHeight="0"
+                 Padding="4,0,4,0"
+                 Margin="0,-8,0,-8"
+                 LostFocus="RenameBoxLostFocusHandler"/>
+    </StackPanel>
+</UserControl>

src/cascadia/TerminalApp/TerminalAppLib.vcxproj

@@ -53,6 +53,9 @@
     </Page>
     <Page Include="TabRowControl.xaml">
       <SubType>Designer</SubType>
+    </Page>
+        <Page Include="TabHeaderControl.xaml">
+      <SubType>Designer</SubType>
     </Page>
     <Page Include="HighlightedTextControl.xaml">
       <SubType>Designer</SubType>
@@ -89,6 +92,9 @@
     <ClInclude Include="TabRowControl.h">
       <DependentUpon>TabRowControl.xaml</DependentUpon>
     </ClInclude>
+    <ClInclude Include="TabHeaderControl.h">
+      <DependentUpon>TabHeaderControl.xaml</DependentUpon>
+    </ClInclude>
     <ClInclude Include="HighlightedTextControl.h">
       <DependentUpon>HighlightedTextControl.xaml</DependentUpon>
     </ClInclude>
@@ -154,6 +160,9 @@
     <ClCompile Include="TabRowControl.cpp">
       <DependentUpon>TabRowControl.xaml</DependentUpon>
     </ClCompile>
+    <ClCompile Include="TabHeaderControl.cpp">
+      <DependentUpon>TabHeaderControl.xaml</DependentUpon>
+    </ClCompile>
     <ClCompile Include="HighlightedTextControl.cpp">
       <DependentUpon>HighlightedTextControl.xaml</DependentUpon>
     </ClCompile>
@@ -230,6 +239,10 @@
       <DependentUpon>TabRowControl.xaml</DependentUpon>
       <SubType>Code</SubType>
     </Midl>
+    <Midl Include="TabHeaderControl.idl">
+      <DependentUpon>TabHeaderControl.xaml</DependentUpon>
+      <SubType>Code</SubType>
+    </Midl>
     <Midl Include="HighlightedTextControl.idl">
       <DependentUpon>HighlightedTextControl.xaml</DependentUpon>
       <SubType>Code</SubType>

src/cascadia/TerminalApp/TerminalAppLib.vcxproj.filters

@@ -106,6 +106,9 @@
     <Page Include="TabRowControl.xaml">
       <Filter>controls</Filter>
     </Page>
+    <Page Include="TabHeaderControl.xaml">
+      <Filter>controls</Filter>
+    </Page>
     <Page Include="TerminalPage.xaml">
       <Filter>controls</Filter>
     </Page>