a77b49406c
This PR makes the Header of TabViewItem a custom user control. ## Validation Steps Performed Manual testing Closes #8201
889 lines
32 KiB
C++
889 lines
32 KiB
C++
// Copyright (c) Microsoft Corporation.
|
|
// Licensed under the MIT license.
|
|
|
|
#include "pch.h"
|
|
#include <LibraryResources.h>
|
|
#include "ColorPickupFlyout.h"
|
|
#include "TerminalTab.h"
|
|
#include "TerminalTab.g.cpp"
|
|
#include "Utils.h"
|
|
#include "ColorHelper.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::Windows::System;
|
|
|
|
namespace winrt
|
|
{
|
|
namespace MUX = Microsoft::UI::Xaml;
|
|
namespace WUX = Windows::UI::Xaml;
|
|
}
|
|
|
|
namespace winrt::TerminalApp::implementation
|
|
{
|
|
TerminalTab::TerminalTab(const GUID& profile, const TermControl& control)
|
|
{
|
|
_rootPane = std::make_shared<Pane>(profile, control, true);
|
|
|
|
_rootPane->Closed([=](auto&& /*s*/, auto&& /*e*/) {
|
|
_ClosedHandlers(nullptr, nullptr);
|
|
});
|
|
|
|
_activePane = _rootPane;
|
|
Content(_rootPane->GetRootElement());
|
|
|
|
_MakeTabViewItem();
|
|
_CreateContextMenu();
|
|
|
|
// Add an event handler for the header control to tell us when they want their title to change
|
|
_headerControl.TitleChangeRequested([weakThis = get_weak()](auto&& title) {
|
|
if (auto tab{ weakThis.get() })
|
|
{
|
|
tab->SetTabText(title);
|
|
}
|
|
});
|
|
|
|
// Use our header control as the TabViewItem's header
|
|
TabViewItem().Header(_headerControl);
|
|
}
|
|
|
|
// Method Description:
|
|
// - Initializes a TabViewItem for this Tab instance.
|
|
// Arguments:
|
|
// - <none>
|
|
// Return Value:
|
|
// - <none>
|
|
void TerminalTab::_MakeTabViewItem()
|
|
{
|
|
TabViewItem(::winrt::MUX::Controls::TabViewItem{});
|
|
|
|
TabViewItem().DoubleTapped([weakThis = get_weak()](auto&& /*s*/, auto&& /*e*/) {
|
|
if (auto tab{ weakThis.get() })
|
|
{
|
|
tab->ActivateTabRenamer();
|
|
}
|
|
});
|
|
|
|
UpdateTitle();
|
|
_RecalculateAndApplyTabColor();
|
|
}
|
|
|
|
// Method Description:
|
|
// - Returns nullptr if no children of this tab were the last control to be
|
|
// focused, or the TermControl that _was_ the last control to be focused (if
|
|
// there was one).
|
|
// - This control might not currently be focused, if the tab itself is not
|
|
// currently focused.
|
|
// Arguments:
|
|
// - <none>
|
|
// Return Value:
|
|
// - nullptr if no children were marked `_lastFocused`, else the TermControl
|
|
// that was last focused.
|
|
TermControl TerminalTab::GetActiveTerminalControl() const
|
|
{
|
|
return _activePane->GetTerminalControl();
|
|
}
|
|
|
|
// Method Description:
|
|
// - Called after construction of a Tab object to bind event handlers to its
|
|
// associated Pane and TermControl object
|
|
// Arguments:
|
|
// - control: reference to the TermControl object to bind event to
|
|
// Return Value:
|
|
// - <none>
|
|
void TerminalTab::Initialize(const TermControl& control)
|
|
{
|
|
_BindEventHandlers(control);
|
|
}
|
|
|
|
// Method Description:
|
|
// - Updates our focus state. If we're gaining focus, make sure to transfer
|
|
// focus to the last focused terminal control in our tree of controls.
|
|
// Arguments:
|
|
// - focused: our new focus state
|
|
// Return Value:
|
|
// - <none>
|
|
void TerminalTab::Focus(WUX::FocusState focusState)
|
|
{
|
|
_focusState = focusState;
|
|
|
|
if (_focusState != FocusState::Unfocused)
|
|
{
|
|
auto lastFocusedControl = GetActiveTerminalControl();
|
|
if (lastFocusedControl)
|
|
{
|
|
lastFocusedControl.Focus(_focusState);
|
|
lastFocusedControl.TaskbarProgressChanged();
|
|
}
|
|
}
|
|
}
|
|
|
|
// Method Description:
|
|
// - Returns nullopt if no children of this tab were the last control to be
|
|
// focused, or the GUID of the profile of the last control to be focused (if
|
|
// there was one).
|
|
// Arguments:
|
|
// - <none>
|
|
// Return Value:
|
|
// - nullopt if no children of this tab were the last control to be
|
|
// focused, else the GUID of the profile of the last control to be focused
|
|
std::optional<GUID> TerminalTab::GetFocusedProfile() const noexcept
|
|
{
|
|
return _activePane->GetFocusedProfile();
|
|
}
|
|
|
|
// Method Description:
|
|
// - Called after construction of a Tab object to bind event handlers to its
|
|
// associated Pane and TermControl object
|
|
// Arguments:
|
|
// - control: reference to the TermControl object to bind event to
|
|
// Return Value:
|
|
// - <none>
|
|
void TerminalTab::_BindEventHandlers(const TermControl& control) noexcept
|
|
{
|
|
_AttachEventHandlersToPane(_rootPane);
|
|
_AttachEventHandlersToControl(control);
|
|
}
|
|
|
|
// Method Description:
|
|
// - Attempts to update the settings of this tab's tree of panes.
|
|
// Arguments:
|
|
// - settings: The new TerminalSettings to apply to any matching controls
|
|
// - profile: The GUID of the profile these settings should apply to.
|
|
// Return Value:
|
|
// - <none>
|
|
void TerminalTab::UpdateSettings(const TerminalSettings& settings, const GUID& profile)
|
|
{
|
|
_rootPane->UpdateSettings(settings, profile);
|
|
}
|
|
|
|
// Method Description:
|
|
// - Set the icon on the TabViewItem for this tab.
|
|
// Arguments:
|
|
// - iconPath: The new path string to use as the IconPath for our TabViewItem
|
|
// Return Value:
|
|
// - <none>
|
|
winrt::fire_and_forget TerminalTab::UpdateIcon(const winrt::hstring iconPath)
|
|
{
|
|
// Don't reload our icon if it hasn't changed.
|
|
if (iconPath == _lastIconPath)
|
|
{
|
|
return;
|
|
}
|
|
|
|
_lastIconPath = iconPath;
|
|
|
|
auto weakThis{ get_weak() };
|
|
|
|
co_await winrt::resume_foreground(TabViewItem().Dispatcher());
|
|
|
|
if (auto tab{ weakThis.get() })
|
|
{
|
|
// The TabViewItem Icon needs MUX while the IconSourceElement in the CommandPalette needs WUX...
|
|
Icon(_lastIconPath);
|
|
TabViewItem().IconSource(IconPathConverter::IconSourceMUX(_lastIconPath));
|
|
|
|
// Update SwitchToTab command's icon
|
|
SwitchToTabCommand().Icon(_lastIconPath);
|
|
}
|
|
}
|
|
|
|
// Method Description:
|
|
// - Gets the title string of the last focused terminal control in our tree.
|
|
// Returns the empty string if there is no such control.
|
|
// Arguments:
|
|
// - <none>
|
|
// Return Value:
|
|
// - the title string of the last focused terminal control in our tree.
|
|
winrt::hstring TerminalTab::_GetActiveTitle() const
|
|
{
|
|
if (!_runtimeTabText.empty())
|
|
{
|
|
return _runtimeTabText;
|
|
}
|
|
const auto lastFocusedControl = GetActiveTerminalControl();
|
|
return lastFocusedControl ? lastFocusedControl.Title() : L"";
|
|
}
|
|
|
|
// Method Description:
|
|
// - Set the text on the TabViewItem for this tab, and bubbles the new title
|
|
// value up to anyone listening for changes to our title. Callers can
|
|
// listen for the title change with a PropertyChanged even handler.
|
|
// Arguments:
|
|
// - <none>
|
|
// Return Value:
|
|
// - <none>
|
|
winrt::fire_and_forget TerminalTab::UpdateTitle()
|
|
{
|
|
auto weakThis{ get_weak() };
|
|
co_await winrt::resume_foreground(TabViewItem().Dispatcher());
|
|
if (auto tab{ weakThis.get() })
|
|
{
|
|
const auto activeTitle = _GetActiveTitle();
|
|
// Bubble our current tab text to anyone who's listening for changes.
|
|
Title(activeTitle);
|
|
|
|
// Update SwitchToTab command's name
|
|
SwitchToTabCommand().Name(Title());
|
|
|
|
// Update the control to reflect the changed title
|
|
_headerControl.Title(activeTitle);
|
|
}
|
|
}
|
|
|
|
// Method Description:
|
|
// - Move the viewport of the terminal up or down a number of lines. Negative
|
|
// values of `delta` will move the view up, and positive values will move
|
|
// the viewport down.
|
|
// Arguments:
|
|
// - delta: a number of lines to move the viewport relative to the current viewport.
|
|
// Return Value:
|
|
// - <none>
|
|
winrt::fire_and_forget TerminalTab::Scroll(const int delta)
|
|
{
|
|
auto control = GetActiveTerminalControl();
|
|
|
|
co_await winrt::resume_foreground(control.Dispatcher());
|
|
|
|
const auto currentOffset = control.GetScrollOffset();
|
|
control.ScrollViewport(currentOffset + delta);
|
|
}
|
|
|
|
// Method Description:
|
|
// - Determines whether the focused pane has sufficient space to be split.
|
|
// Arguments:
|
|
// - splitType: The type of split we want to create.
|
|
// Return Value:
|
|
// - True if the focused pane can be split. False otherwise.
|
|
bool TerminalTab::CanSplitPane(SplitState splitType)
|
|
{
|
|
return _activePane->CanSplit(splitType);
|
|
}
|
|
|
|
// Method Description:
|
|
// - Split the focused pane in our tree of panes, and place the
|
|
// given TermControl into the newly created pane.
|
|
// Arguments:
|
|
// - splitType: The type of split we want to create.
|
|
// - profile: The profile GUID to associate with the newly created pane.
|
|
// - control: A TermControl to use in the new pane.
|
|
// Return Value:
|
|
// - <none>
|
|
void TerminalTab::SplitPane(SplitState splitType, const GUID& profile, TermControl& control)
|
|
{
|
|
auto [first, second] = _activePane->Split(splitType, profile, control);
|
|
_activePane = first;
|
|
_AttachEventHandlersToControl(control);
|
|
|
|
// Add a event handlers to the new panes' GotFocus event. When the pane
|
|
// gains focus, we'll mark it as the new active pane.
|
|
_AttachEventHandlersToPane(first);
|
|
_AttachEventHandlersToPane(second);
|
|
|
|
// Immediately update our tracker of the focused pane now. If we're
|
|
// splitting panes during startup (from a commandline), then it's
|
|
// possible that the focus events won't propagate immediately. Updating
|
|
// the focus here will give the same effect though.
|
|
_UpdateActivePane(second);
|
|
}
|
|
|
|
// Method Description:
|
|
// - See Pane::CalcSnappedDimension
|
|
float TerminalTab::CalcSnappedDimension(const bool widthOrHeight, const float dimension) const
|
|
{
|
|
return _rootPane->CalcSnappedDimension(widthOrHeight, dimension);
|
|
}
|
|
|
|
// Method Description:
|
|
// - Update the size of our panes to fill the new given size. This happens when
|
|
// the window is resized.
|
|
// Arguments:
|
|
// - newSize: the amount of space that the panes have to fill now.
|
|
// Return Value:
|
|
// - <none>
|
|
void TerminalTab::ResizeContent(const winrt::Windows::Foundation::Size& newSize)
|
|
{
|
|
// NOTE: This _must_ be called on the root pane, so that it can propagate
|
|
// throughout the entire tree.
|
|
_rootPane->ResizeContent(newSize);
|
|
}
|
|
|
|
// Method Description:
|
|
// - Attempt to move a separator between panes, as to resize each child on
|
|
// either size of the separator. See Pane::ResizePane for details.
|
|
// Arguments:
|
|
// - direction: The direction to move the separator in.
|
|
// Return Value:
|
|
// - <none>
|
|
void TerminalTab::ResizePane(const Direction& direction)
|
|
{
|
|
// NOTE: This _must_ be called on the root pane, so that it can propagate
|
|
// throughout the entire tree.
|
|
_rootPane->ResizePane(direction);
|
|
}
|
|
|
|
// Method Description:
|
|
// - Attempt to move focus between panes, as to focus the child on
|
|
// the other side of the separator. See Pane::NavigateFocus for details.
|
|
// Arguments:
|
|
// - direction: The direction to move the focus in.
|
|
// Return Value:
|
|
// - <none>
|
|
void TerminalTab::NavigateFocus(const Direction& direction)
|
|
{
|
|
// NOTE: This _must_ be called on the root pane, so that it can propagate
|
|
// throughout the entire tree.
|
|
_rootPane->NavigateFocus(direction);
|
|
}
|
|
|
|
// Method Description:
|
|
// - Prepares this tab for being removed from the UI hierarchy by shutting down all active connections.
|
|
void TerminalTab::Shutdown()
|
|
{
|
|
_rootPane->Shutdown();
|
|
}
|
|
|
|
// Method Description:
|
|
// - Closes the currently focused pane in this tab. If it's the last pane in
|
|
// this tab, our Closed event will be fired (at a later time) for anyone
|
|
// registered as a handler of our close event.
|
|
// Arguments:
|
|
// - <none>
|
|
// Return Value:
|
|
// - <none>
|
|
void TerminalTab::ClosePane()
|
|
{
|
|
_activePane->Close();
|
|
}
|
|
|
|
void TerminalTab::SetTabText(winrt::hstring title)
|
|
{
|
|
_runtimeTabText = title;
|
|
UpdateTitle();
|
|
}
|
|
|
|
void TerminalTab::ResetTabText()
|
|
{
|
|
_runtimeTabText = L"";
|
|
UpdateTitle();
|
|
}
|
|
|
|
// Method Description:
|
|
// - Show a TextBox in the Header to allow the user to set a string
|
|
// to use as an override for the tab's text
|
|
// Arguments:
|
|
// - <none>
|
|
// Return Value:
|
|
// - <none>
|
|
void TerminalTab::ActivateTabRenamer()
|
|
{
|
|
_headerControl.BeginRename();
|
|
}
|
|
|
|
// Method Description:
|
|
// - Register any event handlers that we may need with the given TermControl.
|
|
// This should be called on each and every TermControl that we add to the tree
|
|
// of Panes in this tab. We'll add events too:
|
|
// * notify us when the control's title changed, so we can update our own
|
|
// title (if necessary)
|
|
// Arguments:
|
|
// - control: the TermControl to add events to.
|
|
// Return Value:
|
|
// - <none>
|
|
void TerminalTab::_AttachEventHandlersToControl(const TermControl& control)
|
|
{
|
|
auto weakThis{ get_weak() };
|
|
|
|
control.TitleChanged([weakThis](auto newTitle) {
|
|
// Check if Tab's lifetime has expired
|
|
if (auto tab{ weakThis.get() })
|
|
{
|
|
// The title of the control changed, but not necessarily the title of the tab.
|
|
// Set the tab's text to the active panes' text.
|
|
tab->UpdateTitle();
|
|
}
|
|
});
|
|
|
|
// This is called when the terminal changes its font size or sets it for the first
|
|
// time (because when we just create terminal via its ctor it has invalid font size).
|
|
// On the latter event, we tell the root pane to resize itself so that its descendants
|
|
// (including ourself) can properly snap to character grids. In future, we may also
|
|
// want to do that on regular font changes.
|
|
control.FontSizeChanged([this](const int /* fontWidth */,
|
|
const int /* fontHeight */,
|
|
const bool isInitialChange) {
|
|
if (isInitialChange)
|
|
{
|
|
_rootPane->Relayout();
|
|
}
|
|
});
|
|
|
|
control.TabColorChanged([weakThis](auto&&, auto&&) {
|
|
if (auto tab{ weakThis.get() })
|
|
{
|
|
// The control's tabColor changed, but it is not necessarily the
|
|
// active control in this tab. We'll just recalculate the
|
|
// current color anyways.
|
|
tab->_RecalculateAndApplyTabColor();
|
|
}
|
|
});
|
|
}
|
|
|
|
// Method Description:
|
|
// - Mark the given pane as the active pane in this tab. All other panes
|
|
// will be marked as inactive. We'll also update our own UI state to
|
|
// reflect this newly active pane.
|
|
// Arguments:
|
|
// - pane: a Pane to mark as active.
|
|
// Return Value:
|
|
// - <none>
|
|
void TerminalTab::_UpdateActivePane(std::shared_ptr<Pane> pane)
|
|
{
|
|
// Clear the active state of the entire tree, and mark only the pane as active.
|
|
_rootPane->ClearActive();
|
|
_activePane = pane;
|
|
_activePane->SetActive();
|
|
|
|
// Update our own title text to match the newly-active pane.
|
|
UpdateTitle();
|
|
|
|
// Raise our own ActivePaneChanged event.
|
|
_ActivePaneChangedHandlers();
|
|
}
|
|
|
|
// Method Description:
|
|
// - Add an event handler to this pane's GotFocus event. When that pane gains
|
|
// focus, we'll mark it as the new active pane. We'll also query the title of
|
|
// that pane when it's focused to set our own text, and finally, we'll trigger
|
|
// our own ActivePaneChanged event.
|
|
// Arguments:
|
|
// - <none>
|
|
// Return Value:
|
|
// - <none>
|
|
void TerminalTab::_AttachEventHandlersToPane(std::shared_ptr<Pane> pane)
|
|
{
|
|
auto weakThis{ get_weak() };
|
|
|
|
pane->GotFocus([weakThis](std::shared_ptr<Pane> sender) {
|
|
// Do nothing if the Tab's lifetime is expired or pane isn't new.
|
|
auto tab{ weakThis.get() };
|
|
|
|
if (tab && sender != tab->_activePane)
|
|
{
|
|
tab->_UpdateActivePane(sender);
|
|
tab->_RecalculateAndApplyTabColor();
|
|
}
|
|
});
|
|
|
|
// Add a Closed event handler to the Pane. If the pane closes out from
|
|
// underneath us, and it's zoomed, we want to be able to make sure to
|
|
// update our state accordingly to un-zoom that pane. See GH#7252.
|
|
pane->Closed([weakThis](auto&& /*s*/, auto && /*e*/) -> winrt::fire_and_forget {
|
|
if (auto tab{ weakThis.get() })
|
|
{
|
|
if (tab->_zoomedPane)
|
|
{
|
|
co_await winrt::resume_foreground(tab->Content().Dispatcher());
|
|
|
|
tab->Content(tab->_rootPane->GetRootElement());
|
|
tab->ExitZoom();
|
|
}
|
|
}
|
|
});
|
|
|
|
// Add a PaneRaiseVisualBell event handler to the Pane. When the pane emits this event,
|
|
// we need to bubble it all the way to app host. In this part of the chain we bubble it
|
|
// from the hosting tab to the page.
|
|
pane->PaneRaiseVisualBell([weakThis](auto&& /*s*/) {
|
|
if (auto tab{ weakThis.get() })
|
|
{
|
|
tab->_TabRaiseVisualBellHandlers();
|
|
}
|
|
});
|
|
}
|
|
|
|
// Method Description:
|
|
// - Creates a context menu attached to the tab.
|
|
// Currently contains elements allowing to select or
|
|
// to close the current tab
|
|
// Arguments:
|
|
// - <none>
|
|
// Return Value:
|
|
// - <none>
|
|
void TerminalTab::_CreateContextMenu()
|
|
{
|
|
auto weakThis{ get_weak() };
|
|
|
|
// Close
|
|
Controls::MenuFlyoutItem closeTabMenuItem;
|
|
Controls::FontIcon closeSymbol;
|
|
closeSymbol.FontFamily(Media::FontFamily{ L"Segoe MDL2 Assets" });
|
|
closeSymbol.Glyph(L"\xE8BB");
|
|
|
|
closeTabMenuItem.Click([weakThis](auto&&, auto&&) {
|
|
if (auto tab{ weakThis.get() })
|
|
{
|
|
tab->_rootPane->Close();
|
|
}
|
|
});
|
|
closeTabMenuItem.Text(RS_(L"TabClose"));
|
|
closeTabMenuItem.Icon(closeSymbol);
|
|
|
|
// "Color..."
|
|
Controls::MenuFlyoutItem chooseColorMenuItem;
|
|
Controls::FontIcon colorPickSymbol;
|
|
colorPickSymbol.FontFamily(Media::FontFamily{ L"Segoe MDL2 Assets" });
|
|
colorPickSymbol.Glyph(L"\xE790");
|
|
|
|
chooseColorMenuItem.Click([weakThis](auto&&, auto&&) {
|
|
if (auto tab{ weakThis.get() })
|
|
{
|
|
tab->ActivateColorPicker();
|
|
}
|
|
});
|
|
chooseColorMenuItem.Text(RS_(L"TabColorChoose"));
|
|
chooseColorMenuItem.Icon(colorPickSymbol);
|
|
|
|
// Color Picker (it's convenient to have it here)
|
|
_tabColorPickup.ColorSelected([weakThis](auto newTabColor) {
|
|
if (auto tab{ weakThis.get() })
|
|
{
|
|
tab->SetRuntimeTabColor(newTabColor);
|
|
}
|
|
});
|
|
|
|
_tabColorPickup.ColorCleared([weakThis]() {
|
|
if (auto tab{ weakThis.get() })
|
|
{
|
|
tab->ResetRuntimeTabColor();
|
|
}
|
|
});
|
|
|
|
Controls::MenuFlyoutItem renameTabMenuItem;
|
|
{
|
|
// "Rename Tab"
|
|
Controls::FontIcon renameTabSymbol;
|
|
renameTabSymbol.FontFamily(Media::FontFamily{ L"Segoe MDL2 Assets" });
|
|
renameTabSymbol.Glyph(L"\xE932"); // Label
|
|
|
|
renameTabMenuItem.Click([weakThis](auto&&, auto&&) {
|
|
if (auto tab{ weakThis.get() })
|
|
{
|
|
tab->ActivateTabRenamer();
|
|
}
|
|
});
|
|
renameTabMenuItem.Text(RS_(L"RenameTabText"));
|
|
renameTabMenuItem.Icon(renameTabSymbol);
|
|
}
|
|
|
|
// Build the menu
|
|
Controls::MenuFlyout newTabFlyout;
|
|
Controls::MenuFlyoutSeparator menuSeparator;
|
|
newTabFlyout.Items().Append(chooseColorMenuItem);
|
|
newTabFlyout.Items().Append(renameTabMenuItem);
|
|
newTabFlyout.Items().Append(menuSeparator);
|
|
newTabFlyout.Items().Append(_CreateCloseSubMenu());
|
|
newTabFlyout.Items().Append(closeTabMenuItem);
|
|
TabViewItem().ContextFlyout(newTabFlyout);
|
|
}
|
|
|
|
// Method Description:
|
|
// Returns the tab color, if any
|
|
// Arguments:
|
|
// - <none>
|
|
// Return Value:
|
|
// - The tab's color, if any
|
|
std::optional<winrt::Windows::UI::Color> TerminalTab::GetTabColor()
|
|
{
|
|
const auto currControlColor{ GetActiveTerminalControl().TabColor() };
|
|
std::optional<winrt::Windows::UI::Color> controlTabColor;
|
|
if (currControlColor != nullptr)
|
|
{
|
|
controlTabColor = currControlColor.Value();
|
|
}
|
|
|
|
// A Tab's color will be the result of layering a variety of sources,
|
|
// from the bottom up:
|
|
//
|
|
// Color | | Set by
|
|
// -------------------- | -- | --
|
|
// Runtime Color | _optional_ | Color Picker / `setTabColor` action
|
|
// Control Tab Color | _optional_ | Profile's `tabColor`, or a color set by VT
|
|
// Theme Tab Background | _optional_ | `tab.backgroundColor` in the theme
|
|
// Tab Default Color | **default** | TabView in XAML
|
|
//
|
|
// coalesce will get us the first of these values that's
|
|
// actually set, with nullopt being our sentinel for "use the default
|
|
// tabview color" (and clear out any colors we've set).
|
|
|
|
return til::coalesce(_runtimeTabColor,
|
|
controlTabColor,
|
|
_themeTabColor,
|
|
std::optional<Windows::UI::Color>(std::nullopt));
|
|
}
|
|
|
|
// Method Description:
|
|
// - Sets the runtime tab background color to the color chosen by the user
|
|
// - Sets the tab foreground color depending on the luminance of
|
|
// the background color
|
|
// Arguments:
|
|
// - color: the color the user picked for their tab
|
|
// Return Value:
|
|
// - <none>
|
|
void TerminalTab::SetRuntimeTabColor(const winrt::Windows::UI::Color& color)
|
|
{
|
|
_runtimeTabColor.emplace(color);
|
|
_RecalculateAndApplyTabColor();
|
|
}
|
|
|
|
// Method Description:
|
|
// - This function dispatches a function to the UI thread to recalculate
|
|
// what this tab's current background color should be. If a color is set,
|
|
// it will apply the given color to the tab's background. Otherwise, it
|
|
// will clear the tab's background color.
|
|
// Arguments:
|
|
// - <none>
|
|
// Return Value:
|
|
// - <none>
|
|
void TerminalTab::_RecalculateAndApplyTabColor()
|
|
{
|
|
auto weakThis{ get_weak() };
|
|
|
|
TabViewItem().Dispatcher().RunAsync(CoreDispatcherPriority::Normal, [weakThis]() {
|
|
auto ptrTab = weakThis.get();
|
|
if (!ptrTab)
|
|
return;
|
|
|
|
auto tab{ ptrTab };
|
|
|
|
std::optional<winrt::Windows::UI::Color> currentColor = tab->GetTabColor();
|
|
if (currentColor.has_value())
|
|
{
|
|
tab->_ApplyTabColor(currentColor.value());
|
|
}
|
|
else
|
|
{
|
|
tab->_ClearTabBackgroundColor();
|
|
}
|
|
});
|
|
}
|
|
|
|
// Method Description:
|
|
// - Applies the given color to the background of this tab's TabViewItem.
|
|
// - Sets the tab foreground color depending on the luminance of
|
|
// the background color
|
|
// - This method should only be called on the UI thread.
|
|
// Arguments:
|
|
// - color: the color the user picked for their tab
|
|
// Return Value:
|
|
// - <none>
|
|
void TerminalTab::_ApplyTabColor(const winrt::Windows::UI::Color& color)
|
|
{
|
|
Media::SolidColorBrush selectedTabBrush{};
|
|
Media::SolidColorBrush deselectedTabBrush{};
|
|
Media::SolidColorBrush fontBrush{};
|
|
Media::SolidColorBrush hoverTabBrush{};
|
|
// calculate the luminance of the current color and select a font
|
|
// color based on that
|
|
// see https://www.w3.org/TR/WCAG20/#relativeluminancedef
|
|
if (TerminalApp::ColorHelper::IsBrightColor(color))
|
|
{
|
|
fontBrush.Color(winrt::Windows::UI::Colors::Black());
|
|
}
|
|
else
|
|
{
|
|
fontBrush.Color(winrt::Windows::UI::Colors::White());
|
|
}
|
|
|
|
hoverTabBrush.Color(TerminalApp::ColorHelper::GetAccentColor(color));
|
|
selectedTabBrush.Color(color);
|
|
|
|
// currently if a tab has a custom color, a deselected state is
|
|
// signified by using the same color with a bit ot transparency
|
|
auto deselectedTabColor = color;
|
|
deselectedTabColor.A = 64;
|
|
deselectedTabBrush.Color(deselectedTabColor);
|
|
|
|
// currently if a tab has a custom color, a deselected state is
|
|
// signified by using the same color with a bit ot transparency
|
|
TabViewItem().Resources().Insert(winrt::box_value(L"TabViewItemHeaderBackgroundSelected"), selectedTabBrush);
|
|
TabViewItem().Resources().Insert(winrt::box_value(L"TabViewItemHeaderBackground"), deselectedTabBrush);
|
|
TabViewItem().Resources().Insert(winrt::box_value(L"TabViewItemHeaderBackgroundPointerOver"), hoverTabBrush);
|
|
TabViewItem().Resources().Insert(winrt::box_value(L"TabViewItemHeaderBackgroundPressed"), selectedTabBrush);
|
|
TabViewItem().Resources().Insert(winrt::box_value(L"TabViewItemHeaderForeground"), fontBrush);
|
|
TabViewItem().Resources().Insert(winrt::box_value(L"TabViewItemHeaderForegroundSelected"), fontBrush);
|
|
TabViewItem().Resources().Insert(winrt::box_value(L"TabViewItemHeaderForegroundPointerOver"), fontBrush);
|
|
TabViewItem().Resources().Insert(winrt::box_value(L"TabViewItemHeaderForegroundPressed"), fontBrush);
|
|
TabViewItem().Resources().Insert(winrt::box_value(L"TabViewButtonForegroundActiveTab"), fontBrush);
|
|
TabViewItem().Resources().Insert(winrt::box_value(L"TabViewButtonForegroundPressed"), fontBrush);
|
|
TabViewItem().Resources().Insert(winrt::box_value(L"TabViewButtonForegroundPointerOver"), fontBrush);
|
|
|
|
_RefreshVisualState();
|
|
|
|
_colorSelected(color);
|
|
}
|
|
|
|
// Method Description:
|
|
// - Clear the custom runtime color of the tab, if any color is set. This
|
|
// will re-apply whatever the tab's base color should be (either the color
|
|
// from the control, the theme, or the default tab color.)
|
|
// Arguments:
|
|
// - <none>
|
|
// Return Value:
|
|
// - <none>
|
|
void TerminalTab::ResetRuntimeTabColor()
|
|
{
|
|
_runtimeTabColor.reset();
|
|
_RecalculateAndApplyTabColor();
|
|
}
|
|
|
|
// Method Description:
|
|
// - Clear out any color we've set for the TabViewItem.
|
|
// - This method should only be called on the UI thread.
|
|
// Arguments:
|
|
// - <none>
|
|
// Return Value:
|
|
// - <none>
|
|
void TerminalTab::_ClearTabBackgroundColor()
|
|
{
|
|
winrt::hstring keys[] = {
|
|
L"TabViewItemHeaderBackground",
|
|
L"TabViewItemHeaderBackgroundSelected",
|
|
L"TabViewItemHeaderBackgroundPointerOver",
|
|
L"TabViewItemHeaderForeground",
|
|
L"TabViewItemHeaderForegroundSelected",
|
|
L"TabViewItemHeaderForegroundPointerOver",
|
|
L"TabViewItemHeaderBackgroundPressed",
|
|
L"TabViewItemHeaderForegroundPressed",
|
|
L"TabViewButtonForegroundActiveTab"
|
|
};
|
|
|
|
// simply clear any of the colors in the tab's dict
|
|
for (auto keyString : keys)
|
|
{
|
|
auto key = winrt::box_value(keyString);
|
|
if (TabViewItem().Resources().HasKey(key))
|
|
{
|
|
TabViewItem().Resources().Remove(key);
|
|
}
|
|
}
|
|
|
|
_RefreshVisualState();
|
|
_colorCleared();
|
|
}
|
|
|
|
// Method Description:
|
|
// - Display the tab color picker at the location of the TabViewItem for this tab.
|
|
// Arguments:
|
|
// - <none>
|
|
// Return Value:
|
|
// - <none>
|
|
void TerminalTab::ActivateColorPicker()
|
|
{
|
|
_tabColorPickup.ShowAt(TabViewItem());
|
|
}
|
|
|
|
// Method Description:
|
|
// Toggles the visual state of the tab view item,
|
|
// so that changes to the tab color are reflected immediately
|
|
// Arguments:
|
|
// - <none>
|
|
// Return Value:
|
|
// - <none>
|
|
void TerminalTab::_RefreshVisualState()
|
|
{
|
|
if (_focusState != FocusState::Unfocused)
|
|
{
|
|
VisualStateManager::GoToState(TabViewItem(), L"Normal", true);
|
|
VisualStateManager::GoToState(TabViewItem(), L"Selected", true);
|
|
}
|
|
else
|
|
{
|
|
VisualStateManager::GoToState(TabViewItem(), L"Selected", true);
|
|
VisualStateManager::GoToState(TabViewItem(), L"Normal", true);
|
|
}
|
|
}
|
|
|
|
// - Get the total number of leaf panes in this tab. This will be the number
|
|
// of actual controls hosted by this tab.
|
|
// Arguments:
|
|
// - <none>
|
|
// Return Value:
|
|
// - The total number of leaf panes hosted by this tab.
|
|
int TerminalTab::GetLeafPaneCount() const noexcept
|
|
{
|
|
return _rootPane->GetLeafPaneCount();
|
|
}
|
|
|
|
// Method Description:
|
|
// - This is a helper to determine which direction an "Automatic" split should
|
|
// happen in for the active pane of this tab, but without using the ActualWidth() and
|
|
// ActualHeight() methods.
|
|
// - See Pane::PreCalculateAutoSplit
|
|
// Arguments:
|
|
// - availableSpace: The theoretical space that's available for this Tab's content
|
|
// Return Value:
|
|
// - The SplitState that we should use for an `Automatic` split given
|
|
// `availableSpace`
|
|
SplitState TerminalTab::PreCalculateAutoSplit(winrt::Windows::Foundation::Size availableSpace) const
|
|
{
|
|
return _rootPane->PreCalculateAutoSplit(_activePane, availableSpace).value_or(SplitState::Vertical);
|
|
}
|
|
|
|
bool TerminalTab::PreCalculateCanSplit(SplitState splitType, winrt::Windows::Foundation::Size availableSpace) const
|
|
{
|
|
return _rootPane->PreCalculateCanSplit(_activePane, splitType, availableSpace).value_or(false);
|
|
}
|
|
|
|
// Method Description:
|
|
// - Toggle our zoom state.
|
|
// * If we're not zoomed, then zoom the active pane, making it take the
|
|
// full size of the tab. We'll achieve this by changing our response to
|
|
// Tab::GetTabContent, so that it'll return the zoomed pane only.
|
|
// * If we're currently zoomed on a pane, un-zoom that pane.
|
|
// Arguments:
|
|
// - <none>
|
|
// Return Value:
|
|
// - <none>
|
|
void TerminalTab::ToggleZoom()
|
|
{
|
|
if (_zoomedPane)
|
|
{
|
|
ExitZoom();
|
|
}
|
|
else
|
|
{
|
|
EnterZoom();
|
|
}
|
|
}
|
|
void TerminalTab::EnterZoom()
|
|
{
|
|
_zoomedPane = _activePane;
|
|
_rootPane->Maximize(_zoomedPane);
|
|
// Update the tab header to show the magnifying glass
|
|
_headerControl.IsPaneZoomed(true);
|
|
Content(_zoomedPane->GetRootElement());
|
|
}
|
|
void TerminalTab::ExitZoom()
|
|
{
|
|
_rootPane->Restore(_zoomedPane);
|
|
_zoomedPane = nullptr;
|
|
// Update the tab header to hide the magnifying glass
|
|
_headerControl.IsPaneZoomed(false);
|
|
Content(_rootPane->GetRootElement());
|
|
}
|
|
|
|
bool TerminalTab::IsZoomed()
|
|
{
|
|
return _zoomedPane != nullptr;
|
|
}
|
|
|
|
DEFINE_EVENT(TerminalTab, ActivePaneChanged, _ActivePaneChangedHandlers, winrt::delegate<>);
|
|
DEFINE_EVENT(TerminalTab, ColorSelected, _colorSelected, winrt::delegate<winrt::Windows::UI::Color>);
|
|
DEFINE_EVENT(TerminalTab, ColorCleared, _colorCleared, winrt::delegate<>);
|
|
DEFINE_EVENT(TerminalTab, TabRaiseVisualBell, _TabRaiseVisualBellHandlers, winrt::delegate<>);
|
|
}
|