a14b6f89f6
## Summary of the Pull Request ![background-progress-000](https://user-images.githubusercontent.com/18356694/126653006-3ad2fdae-67ae-4cdb-aa46-25d09217e365.gif) This PR causes the Terminal to combine taskbar states at the tab and window level, according to the [MSDN docs for `SetProgressState`](https://docs.microsoft.com/en-us/windows/win32/api/shobjidl_core/nf-shobjidl_core-itaskbarlist3-setprogressstate#how-the-taskbar-button-chooses-the-progress-indicator-for-a-group). This allows the Terminal's taskbar icon to continue showing progress information, even if you're in a pane/tab that _doesn't_ have progress state. This is helpful for cases where the user may be running a build in one tab, and working on something else in another. ## References * [`SetProgressState`](https://docs.microsoft.com/en-us/windows/win32/api/shobjidl_core/nf-shobjidl_core-itaskbarlist3-setprogressstate#how-the-taskbar-button-chooses-the-progress-indicator-for-a-group) * Progress mega: #6700 ## PR Checklist * [x] Closes #10090 * [x] I work here * [ ] Tests added/passed * [n/a] Requires documentation to be updated ## Detailed Description of the Pull Request / Additional comments This also fixes a related bug where transitioning from the "error" or "warning" state directly to the "indeterminate" state would cause the taskbar icon to get stuck in a bad state. ## Validation Steps Performed <details> <summary><code>progress.cmd</code></summary> ```cmd @echo off setlocal enabledelayedexpansion set _type=3 if (%1) == () ( set _type=3 ) else ( set _type=%1 ) if (%_type%) == (0) ( <NUL set /p =]9;4 echo Cleared progress ) if (%_type%) == (1) ( <NUL set /p =]9;4;1;25 echo Started progress (normal, 25^) ) if (%_type%) == (2) ( <NUL set /p =]9;4;2;50 echo Started progress (error, 50^) ) if (%_type%) == (3) ( @rem start indeterminate progress in the taskbar @rem this `<NUL set /p =` magic will output the text _without a newline_ <NUL set /p =]9;4;3 echo Started progress (indeterminate, {omitted}) ) if (%_type%) == (4) ( <NUL set /p =]9;4;4;75 echo Started progress (warning, 75^) ) ``` </details>
158 lines
6.4 KiB
C++
158 lines
6.4 KiB
C++
// Copyright (c) Microsoft Corporation.
|
|
// Licensed under the MIT license.
|
|
|
|
#pragma once
|
|
#include "Pane.h"
|
|
#include "ColorPickupFlyout.h"
|
|
#include "TabBase.h"
|
|
#include "TerminalTab.g.h"
|
|
|
|
static constexpr double HeaderRenameBoxWidthDefault{ 165 };
|
|
static constexpr double HeaderRenameBoxWidthTitleLength{ std::numeric_limits<double>::infinity() };
|
|
|
|
// fwdecl unittest classes
|
|
namespace TerminalAppLocalTests
|
|
{
|
|
class TabTests;
|
|
};
|
|
|
|
namespace winrt::TerminalApp::implementation
|
|
{
|
|
struct TerminalTab : TerminalTabT<TerminalTab, TabBase>
|
|
{
|
|
public:
|
|
TerminalTab(const GUID& profile, const winrt::Microsoft::Terminal::Control::TermControl& control);
|
|
|
|
// Called after construction to perform the necessary setup, which relies on weak_ptr
|
|
void Initialize(const winrt::Microsoft::Terminal::Control::TermControl& control);
|
|
|
|
winrt::Microsoft::Terminal::Control::TermControl GetActiveTerminalControl() const;
|
|
std::optional<GUID> GetFocusedProfile() const noexcept;
|
|
|
|
void Focus(winrt::Windows::UI::Xaml::FocusState focusState) override;
|
|
|
|
winrt::fire_and_forget Scroll(const int delta);
|
|
|
|
void SplitPane(winrt::Microsoft::Terminal::Settings::Model::SplitState splitType,
|
|
const float splitSize,
|
|
const GUID& profile,
|
|
winrt::Microsoft::Terminal::Control::TermControl& control);
|
|
|
|
void ToggleSplitOrientation();
|
|
winrt::fire_and_forget UpdateIcon(const winrt::hstring iconPath);
|
|
winrt::fire_and_forget HideIcon(const bool hide);
|
|
|
|
winrt::fire_and_forget ShowBellIndicator(const bool show);
|
|
winrt::fire_and_forget ActivateBellIndicatorTimer();
|
|
|
|
float CalcSnappedDimension(const bool widthOrHeight, const float dimension) const;
|
|
winrt::Microsoft::Terminal::Settings::Model::SplitState PreCalculateAutoSplit(winrt::Windows::Foundation::Size rootSize) const;
|
|
bool PreCalculateCanSplit(winrt::Microsoft::Terminal::Settings::Model::SplitState splitType,
|
|
const float splitSize,
|
|
winrt::Windows::Foundation::Size availableSpace) const;
|
|
|
|
void ResizeContent(const winrt::Windows::Foundation::Size& newSize);
|
|
void ResizePane(const winrt::Microsoft::Terminal::Settings::Model::ResizeDirection& direction);
|
|
bool NavigateFocus(const winrt::Microsoft::Terminal::Settings::Model::FocusDirection& direction);
|
|
void MovePane(const winrt::Microsoft::Terminal::Settings::Model::FocusDirection& direction);
|
|
bool FocusPane(const uint32_t id);
|
|
|
|
void UpdateSettings(const Microsoft::Terminal::Settings::Model::TerminalSettingsCreateResult& settings, const GUID& profile);
|
|
winrt::fire_and_forget UpdateTitle();
|
|
|
|
void Shutdown() override;
|
|
void ClosePane();
|
|
|
|
void SetTabText(winrt::hstring title);
|
|
winrt::hstring GetTabText() const;
|
|
void ResetTabText();
|
|
void ActivateTabRenamer();
|
|
|
|
std::optional<winrt::Windows::UI::Color> GetTabColor();
|
|
|
|
void SetRuntimeTabColor(const winrt::Windows::UI::Color& color);
|
|
void ResetRuntimeTabColor();
|
|
void ActivateColorPicker();
|
|
|
|
void ToggleZoom();
|
|
bool IsZoomed();
|
|
void EnterZoom();
|
|
void ExitZoom();
|
|
|
|
int GetLeafPaneCount() const noexcept;
|
|
|
|
void TogglePaneReadOnly();
|
|
std::shared_ptr<Pane> GetActivePane() const;
|
|
winrt::TerminalApp::TaskbarState GetCombinedTaskbarState() const;
|
|
|
|
winrt::TerminalApp::TerminalTabStatus TabStatus()
|
|
{
|
|
return _tabStatus;
|
|
}
|
|
|
|
DECLARE_EVENT(ActivePaneChanged, _ActivePaneChangedHandlers, winrt::delegate<>);
|
|
DECLARE_EVENT(ColorSelected, _colorSelected, winrt::delegate<winrt::Windows::UI::Color>);
|
|
DECLARE_EVENT(ColorCleared, _colorCleared, winrt::delegate<>);
|
|
DECLARE_EVENT(TabRaiseVisualBell, _TabRaiseVisualBellHandlers, winrt::delegate<>);
|
|
DECLARE_EVENT(DuplicateRequested, _DuplicateRequestedHandlers, winrt::delegate<>);
|
|
DECLARE_EVENT(SplitTabRequested, _SplitTabRequestedHandlers, winrt::delegate<>);
|
|
TYPED_EVENT(TaskbarProgressChanged, IInspectable, IInspectable);
|
|
|
|
private:
|
|
std::shared_ptr<Pane> _rootPane{ nullptr };
|
|
std::shared_ptr<Pane> _activePane{ nullptr };
|
|
std::shared_ptr<Pane> _zoomedPane{ nullptr };
|
|
winrt::hstring _lastIconPath{};
|
|
winrt::TerminalApp::ColorPickupFlyout _tabColorPickup{};
|
|
std::optional<winrt::Windows::UI::Color> _themeTabColor{};
|
|
std::optional<winrt::Windows::UI::Color> _runtimeTabColor{};
|
|
winrt::TerminalApp::TabHeaderControl _headerControl{};
|
|
winrt::TerminalApp::TerminalTabStatus _tabStatus{};
|
|
|
|
std::vector<uint32_t> _mruPanes;
|
|
uint32_t _nextPaneId{ 0 };
|
|
|
|
bool _receivedKeyDown{ false };
|
|
bool _iconHidden{ false };
|
|
|
|
winrt::hstring _runtimeTabText{};
|
|
bool _inRename{ false };
|
|
winrt::Windows::UI::Xaml::Controls::TextBox::LayoutUpdated_revoker _tabRenameBoxLayoutUpdatedRevoker;
|
|
|
|
winrt::TerminalApp::ShortcutActionDispatch _dispatch;
|
|
|
|
std::optional<Windows::UI::Xaml::DispatcherTimer> _bellIndicatorTimer;
|
|
void _BellIndicatorTimerTick(Windows::Foundation::IInspectable const& sender, Windows::Foundation::IInspectable const& e);
|
|
|
|
void _MakeTabViewItem() override;
|
|
|
|
winrt::fire_and_forget _UpdateHeaderControlMaxWidth();
|
|
|
|
void _CreateContextMenu() override;
|
|
virtual winrt::hstring _CreateToolTipTitle() override;
|
|
|
|
void _RefreshVisualState();
|
|
|
|
void _BindEventHandlers(const winrt::Microsoft::Terminal::Control::TermControl& control) noexcept;
|
|
|
|
void _AttachEventHandlersToControl(const winrt::Microsoft::Terminal::Control::TermControl& control);
|
|
void _AttachEventHandlersToPane(std::shared_ptr<Pane> pane);
|
|
|
|
void _UpdateActivePane(std::shared_ptr<Pane> pane);
|
|
|
|
winrt::hstring _GetActiveTitle() const;
|
|
|
|
void _RecalculateAndApplyTabColor();
|
|
void _ApplyTabColor(const winrt::Windows::UI::Color& color);
|
|
void _ClearTabBackgroundColor();
|
|
|
|
void _RecalculateAndApplyReadOnly();
|
|
|
|
void _UpdateProgressState();
|
|
|
|
void _DuplicateTab();
|
|
|
|
friend class ::TerminalAppLocalTests::TabTests;
|
|
};
|
|
}
|