From 3b2ee448f90c35dbadd20bce64090bf849057de5 Mon Sep 17 00:00:00 2001 From: Mike Griese Date: Tue, 14 Jul 2020 16:02:18 -0500 Subject: [PATCH] Add support for "Always on top" mode (#6903) This PR adds support for always on top mode, via two mechanisms: * The global setting `alwaysOnTop`. When set to true, the window will be created in the "topmost" group of windows. Changing this value will hot-reload whether the window is in the topmost group. * The action `toggleAlwaysOnTop`, which will toggle the `alwaysOnTop` property at runtime. ## Detailed Description of the Pull Request / Additional comments All "topmost" windows maintain an internal z-ordering relative to one another, but they're all always above all other "non-topmost" windows. So multiple Windows Terminal windows which are both `alwaysOnTop` will maintain a z-order relative to one another, but they'll all be on top of all other windows. ## Validation Steps Performed Toggled always on top mode, both in the settings and also at runtime, and verified that it largely did what I expected. Closes #3038 --- .github/actions/spell-check/expect/expect.txt | 1 + doc/cascadia/profiles.schema.json | 6 ++ src/cascadia/TerminalApp/ActionAndArgs.cpp | 3 + .../TerminalApp/AppActionHandlers.cpp | 7 ++ src/cascadia/TerminalApp/AppLogic.cpp | 15 ++++ src/cascadia/TerminalApp/AppLogic.h | 8 +- src/cascadia/TerminalApp/AppLogic.idl | 9 ++- .../TerminalApp/GlobalAppSettings.cpp | 3 + src/cascadia/TerminalApp/GlobalAppSettings.h | 1 + .../Resources/en-US/Resources.resw | 3 + .../TerminalApp/ShortcutActionDispatch.cpp | 5 ++ .../TerminalApp/ShortcutActionDispatch.h | 1 + .../TerminalApp/ShortcutActionDispatch.idl | 2 + src/cascadia/TerminalApp/TerminalPage.cpp | 59 ++++++++++++--- src/cascadia/TerminalApp/TerminalPage.h | 11 ++- src/cascadia/TerminalApp/TerminalPage.idl | 11 ++- src/cascadia/TerminalApp/defaults.json | 2 + src/cascadia/WindowsTerminal/AppHost.cpp | 24 ++++-- src/cascadia/WindowsTerminal/AppHost.h | 10 ++- src/cascadia/WindowsTerminal/IslandWindow.cpp | 73 ++++++++++++++----- src/cascadia/WindowsTerminal/IslandWindow.h | 6 +- 21 files changed, 209 insertions(+), 51 deletions(-) diff --git a/.github/actions/spell-check/expect/expect.txt b/.github/actions/spell-check/expect/expect.txt index 4774abf99..5a404754e 100644 --- a/.github/actions/spell-check/expect/expect.txt +++ b/.github/actions/spell-check/expect/expect.txt @@ -1530,6 +1530,7 @@ nothrow NOTICKS NOTIMPL notin +NOTOPMOST NOTNULL NOTRACK NOTSUPPORTED diff --git a/doc/cascadia/profiles.schema.json b/doc/cascadia/profiles.schema.json index 7232d65f1..3df0f2d56 100644 --- a/doc/cascadia/profiles.schema.json +++ b/doc/cascadia/profiles.schema.json @@ -56,6 +56,7 @@ "switchToTab", "toggleFocusMode", "toggleFullscreen", + "toggleAlwaysOnTop", "toggleRetroEffect", "find", "setTabColor", @@ -324,6 +325,11 @@ "additionalProperties": true, "description": "Properties that affect the entire window, regardless of the profile settings.", "properties": { + "alwaysOnTop": { + "default": false, + "description": "When set to true, the window is created on top of all other windows. If multiple windows are all \"always on top\", the most recently focused one will be the topmost", + "type": "boolean" + }, "alwaysShowTabs": { "default": true, "description": "When set to true, tabs are always displayed. When set to false and \"showTabsInTitlebar\" is set to false, tabs only appear after opening a new tab.", diff --git a/src/cascadia/TerminalApp/ActionAndArgs.cpp b/src/cascadia/TerminalApp/ActionAndArgs.cpp index cdb7c61ea..5375ea02c 100644 --- a/src/cascadia/TerminalApp/ActionAndArgs.cpp +++ b/src/cascadia/TerminalApp/ActionAndArgs.cpp @@ -31,6 +31,7 @@ static constexpr std::string_view FindKey{ "find" }; static constexpr std::string_view ToggleRetroEffectKey{ "toggleRetroEffect" }; static constexpr std::string_view ToggleFocusModeKey{ "toggleFocusMode" }; static constexpr std::string_view ToggleFullscreenKey{ "toggleFullscreen" }; +static constexpr std::string_view ToggleAlwaysOnTopKey{ "toggleAlwaysOnTop" }; static constexpr std::string_view SetTabColorKey{ "setTabColor" }; static constexpr std::string_view OpenTabColorPickerKey{ "openTabColorPicker" }; static constexpr std::string_view RenameTabKey{ "renameTab" }; @@ -76,6 +77,7 @@ namespace winrt::TerminalApp::implementation { ToggleRetroEffectKey, ShortcutAction::ToggleRetroEffect }, { ToggleFocusModeKey, ShortcutAction::ToggleFocusMode }, { ToggleFullscreenKey, ShortcutAction::ToggleFullscreen }, + { ToggleAlwaysOnTopKey, ShortcutAction::ToggleAlwaysOnTop }, { SplitPaneKey, ShortcutAction::SplitPane }, { SetTabColorKey, ShortcutAction::SetTabColor }, { OpenTabColorPickerKey, ShortcutAction::OpenTabColorPicker }, @@ -256,6 +258,7 @@ namespace winrt::TerminalApp::implementation { ShortcutAction::ToggleRetroEffect, RS_(L"ToggleRetroEffectCommandKey") }, { ShortcutAction::ToggleFocusMode, RS_(L"ToggleFocusModeCommandKey") }, { ShortcutAction::ToggleFullscreen, RS_(L"ToggleFullscreenCommandKey") }, + { ShortcutAction::ToggleAlwaysOnTop, RS_(L"ToggleAlwaysOnTopCommandKey") }, { ShortcutAction::SplitPane, RS_(L"SplitPaneCommandKey") }, { ShortcutAction::Invalid, L"" }, { ShortcutAction::Find, RS_(L"FindCommandKey") }, diff --git a/src/cascadia/TerminalApp/AppActionHandlers.cpp b/src/cascadia/TerminalApp/AppActionHandlers.cpp index 06f008925..271513d4e 100644 --- a/src/cascadia/TerminalApp/AppActionHandlers.cpp +++ b/src/cascadia/TerminalApp/AppActionHandlers.cpp @@ -253,6 +253,13 @@ namespace winrt::TerminalApp::implementation args.Handled(true); } + void TerminalPage::_HandleToggleAlwaysOnTop(const IInspectable& /*sender*/, + const TerminalApp::ActionEventArgs& args) + { + ToggleAlwaysOnTop(); + args.Handled(true); + } + void TerminalPage::_HandleToggleCommandPalette(const IInspectable& /*sender*/, const TerminalApp::ActionEventArgs& args) { diff --git a/src/cascadia/TerminalApp/AppLogic.cpp b/src/cascadia/TerminalApp/AppLogic.cpp index 77f4e4aef..e036bd9ee 100644 --- a/src/cascadia/TerminalApp/AppLogic.cpp +++ b/src/cascadia/TerminalApp/AppLogic.cpp @@ -1121,6 +1121,21 @@ namespace winrt::TerminalApp::implementation return RS_(L"ApplicationVersionUnknown"); } + bool AppLogic::FocusMode() const + { + return _root ? _root->FocusMode() : false; + } + + bool AppLogic::Fullscreen() const + { + return _root ? _root->Fullscreen() : false; + } + + bool AppLogic::AlwaysOnTop() const + { + return _root ? _root->AlwaysOnTop() : false; + } + // -------------------------------- WinRT Events --------------------------------- // Winrt events need a method for adding a callback to the event and removing the callback. // These macros will define them both for you. diff --git a/src/cascadia/TerminalApp/AppLogic.h b/src/cascadia/TerminalApp/AppLogic.h index 9c030b200..c879a6f18 100644 --- a/src/cascadia/TerminalApp/AppLogic.h +++ b/src/cascadia/TerminalApp/AppLogic.h @@ -33,6 +33,9 @@ namespace winrt::TerminalApp::implementation winrt::hstring ApplicationDisplayName() const; winrt::hstring ApplicationVersion() const; + bool FocusMode() const; + bool Fullscreen() const; + bool AlwaysOnTop() const; Windows::Foundation::Point GetLaunchDimensions(uint32_t dpi); winrt::Windows::Foundation::Point GetLaunchInitialPositions(int32_t defaultInitialX, int32_t defaultInitialY); @@ -104,8 +107,9 @@ namespace winrt::TerminalApp::implementation FORWARDED_TYPED_EVENT(SetTitleBarContent, winrt::Windows::Foundation::IInspectable, winrt::Windows::UI::Xaml::UIElement, _root, SetTitleBarContent); FORWARDED_TYPED_EVENT(TitleChanged, winrt::Windows::Foundation::IInspectable, winrt::hstring, _root, TitleChanged); FORWARDED_TYPED_EVENT(LastTabClosed, winrt::Windows::Foundation::IInspectable, winrt::TerminalApp::LastTabClosedEventArgs, _root, LastTabClosed); - FORWARDED_TYPED_EVENT(ToggleFocusMode, winrt::Windows::Foundation::IInspectable, winrt::TerminalApp::ToggleFocusModeEventArgs, _root, ToggleFocusMode); - FORWARDED_TYPED_EVENT(ToggleFullscreen, winrt::Windows::Foundation::IInspectable, winrt::TerminalApp::ToggleFullscreenEventArgs, _root, ToggleFullscreen); + FORWARDED_TYPED_EVENT(FocusModeChanged, winrt::Windows::Foundation::IInspectable, winrt::Windows::Foundation::IInspectable, _root, FocusModeChanged); + FORWARDED_TYPED_EVENT(FullscreenChanged, winrt::Windows::Foundation::IInspectable, winrt::Windows::Foundation::IInspectable, _root, FullscreenChanged); + FORWARDED_TYPED_EVENT(AlwaysOnTopChanged, winrt::Windows::Foundation::IInspectable, winrt::Windows::Foundation::IInspectable, _root, AlwaysOnTopChanged); }; } diff --git a/src/cascadia/TerminalApp/AppLogic.idl b/src/cascadia/TerminalApp/AppLogic.idl index 63441984f..071a5ce84 100644 --- a/src/cascadia/TerminalApp/AppLogic.idl +++ b/src/cascadia/TerminalApp/AppLogic.idl @@ -41,6 +41,10 @@ namespace TerminalApp String ApplicationDisplayName { get; }; String ApplicationVersion { get; }; + Boolean FocusMode { get; }; + Boolean Fullscreen { get; }; + Boolean AlwaysOnTop { get; }; + Windows.Foundation.Point GetLaunchDimensions(UInt32 dpi); Windows.Foundation.Point GetLaunchInitialPositions(Int32 defaultInitialX, Int32 defaultInitialY); Windows.UI.Xaml.ElementTheme GetRequestedTheme(); @@ -58,7 +62,8 @@ namespace TerminalApp event Windows.Foundation.TypedEventHandler TitleChanged; event Windows.Foundation.TypedEventHandler LastTabClosed; event Windows.Foundation.TypedEventHandler RequestedThemeChanged; - event Windows.Foundation.TypedEventHandler ToggleFullscreen; - event Windows.Foundation.TypedEventHandler ToggleFocusMode; + event Windows.Foundation.TypedEventHandler FocusModeChanged; + event Windows.Foundation.TypedEventHandler FullscreenChanged; + event Windows.Foundation.TypedEventHandler AlwaysOnTopChanged; } } diff --git a/src/cascadia/TerminalApp/GlobalAppSettings.cpp b/src/cascadia/TerminalApp/GlobalAppSettings.cpp index e623634ae..1e074d86c 100644 --- a/src/cascadia/TerminalApp/GlobalAppSettings.cpp +++ b/src/cascadia/TerminalApp/GlobalAppSettings.cpp @@ -36,6 +36,7 @@ static constexpr std::string_view LaunchModeKey{ "launchMode" }; static constexpr std::string_view ConfirmCloseAllKey{ "confirmCloseAllTabs" }; static constexpr std::string_view SnapToGridOnResizeKey{ "snapToGridOnResize" }; static constexpr std::string_view EnableStartupTaskKey{ "startOnUserLogin" }; +static constexpr std::string_view AlwaysOnTopKey{ "alwaysOnTop" }; static constexpr std::string_view DebugFeaturesKey{ "debugFeatures" }; @@ -207,6 +208,8 @@ void GlobalAppSettings::LayerJson(const Json::Value& json) JsonUtils::GetBool(json, EnableStartupTaskKey, _StartOnUserLogin); + JsonUtils::GetBool(json, AlwaysOnTopKey, _AlwaysOnTop); + // This is a helper lambda to get the keybindings and commands out of both // and array of objects. We'll use this twice, once on the legacy // `keybindings` key, and again on the newer `bindings` key. diff --git a/src/cascadia/TerminalApp/GlobalAppSettings.h b/src/cascadia/TerminalApp/GlobalAppSettings.h index 58f8ea5a4..988d7fe1c 100644 --- a/src/cascadia/TerminalApp/GlobalAppSettings.h +++ b/src/cascadia/TerminalApp/GlobalAppSettings.h @@ -84,6 +84,7 @@ public: GETSET_PROPERTY(bool, ForceVTInput, false); GETSET_PROPERTY(bool, DebugFeaturesEnabled); // default value set in constructor GETSET_PROPERTY(bool, StartOnUserLogin, false); + GETSET_PROPERTY(bool, AlwaysOnTop, false); private: std::optional _unparsedDefaultProfile; diff --git a/src/cascadia/TerminalApp/Resources/en-US/Resources.resw b/src/cascadia/TerminalApp/Resources/en-US/Resources.resw index 1f810d4de..09283b55c 100644 --- a/src/cascadia/TerminalApp/Resources/en-US/Resources.resw +++ b/src/cascadia/TerminalApp/Resources/en-US/Resources.resw @@ -399,6 +399,9 @@ Toggle fullscreen + + Toggle always on top mode + Open new tab dropdown diff --git a/src/cascadia/TerminalApp/ShortcutActionDispatch.cpp b/src/cascadia/TerminalApp/ShortcutActionDispatch.cpp index 8248d453a..a040106e2 100644 --- a/src/cascadia/TerminalApp/ShortcutActionDispatch.cpp +++ b/src/cascadia/TerminalApp/ShortcutActionDispatch.cpp @@ -169,6 +169,11 @@ namespace winrt::TerminalApp::implementation _ToggleFullscreenHandlers(*this, *eventArgs); break; } + case ShortcutAction::ToggleAlwaysOnTop: + { + _ToggleAlwaysOnTopHandlers(*this, *eventArgs); + break; + } case ShortcutAction::ToggleCommandPalette: { _ToggleCommandPaletteHandlers(*this, *eventArgs); diff --git a/src/cascadia/TerminalApp/ShortcutActionDispatch.h b/src/cascadia/TerminalApp/ShortcutActionDispatch.h index e59c8ce47..9b930db98 100644 --- a/src/cascadia/TerminalApp/ShortcutActionDispatch.h +++ b/src/cascadia/TerminalApp/ShortcutActionDispatch.h @@ -49,6 +49,7 @@ namespace winrt::TerminalApp::implementation TYPED_EVENT(ToggleRetroEffect, TerminalApp::ShortcutActionDispatch, TerminalApp::ActionEventArgs); TYPED_EVENT(ToggleFocusMode, TerminalApp::ShortcutActionDispatch, TerminalApp::ActionEventArgs); TYPED_EVENT(ToggleFullscreen, TerminalApp::ShortcutActionDispatch, TerminalApp::ActionEventArgs); + TYPED_EVENT(ToggleAlwaysOnTop, TerminalApp::ShortcutActionDispatch, TerminalApp::ActionEventArgs); TYPED_EVENT(ToggleCommandPalette, TerminalApp::ShortcutActionDispatch, TerminalApp::ActionEventArgs); TYPED_EVENT(SetTabColor, TerminalApp::ShortcutActionDispatch, TerminalApp::ActionEventArgs); TYPED_EVENT(OpenTabColorPicker, TerminalApp::ShortcutActionDispatch, TerminalApp::ActionEventArgs); diff --git a/src/cascadia/TerminalApp/ShortcutActionDispatch.idl b/src/cascadia/TerminalApp/ShortcutActionDispatch.idl index 50f1bc7cd..2588c3258 100644 --- a/src/cascadia/TerminalApp/ShortcutActionDispatch.idl +++ b/src/cascadia/TerminalApp/ShortcutActionDispatch.idl @@ -34,6 +34,7 @@ namespace TerminalApp ToggleRetroEffect, ToggleFocusMode, ToggleFullscreen, + ToggleAlwaysOnTop, SetTabColor, OpenTabColorPicker, OpenSettings, @@ -78,6 +79,7 @@ namespace TerminalApp event Windows.Foundation.TypedEventHandler ToggleRetroEffect; event Windows.Foundation.TypedEventHandler ToggleFocusMode; event Windows.Foundation.TypedEventHandler ToggleFullscreen; + event Windows.Foundation.TypedEventHandler ToggleAlwaysOnTop; event Windows.Foundation.TypedEventHandler ToggleCommandPalette; event Windows.Foundation.TypedEventHandler SetTabColor; event Windows.Foundation.TypedEventHandler OpenTabColorPicker; diff --git a/src/cascadia/TerminalApp/TerminalPage.cpp b/src/cascadia/TerminalApp/TerminalPage.cpp index deecd3485..6ed6d8e97 100644 --- a/src/cascadia/TerminalApp/TerminalPage.cpp +++ b/src/cascadia/TerminalApp/TerminalPage.cpp @@ -852,6 +852,7 @@ namespace winrt::TerminalApp::implementation _actionDispatch->ToggleRetroEffect({ this, &TerminalPage::_HandleToggleRetroEffect }); _actionDispatch->ToggleFocusMode({ this, &TerminalPage::_HandleToggleFocusMode }); _actionDispatch->ToggleFullscreen({ this, &TerminalPage::_HandleToggleFullscreen }); + _actionDispatch->ToggleAlwaysOnTop({ this, &TerminalPage::_HandleToggleAlwaysOnTop }); _actionDispatch->ToggleCommandPalette({ this, &TerminalPage::_HandleToggleCommandPalette }); _actionDispatch->SetTabColor({ this, &TerminalPage::_HandleSetTabColor }); _actionDispatch->OpenTabColorPicker({ this, &TerminalPage::_HandleOpenTabColorPicker }); @@ -1913,6 +1914,12 @@ namespace winrt::TerminalApp::implementation _UpdateTabWidthMode(); _CreateNewTabFlyout(); } + + // Reload the current value of alwaysOnTop from the settings file. This + // will let the user hot-reload this setting, but any runtime changes to + // the alwaysOnTop setting will be lost. + _isAlwaysOnTop = _settings->GlobalSettings().AlwaysOnTop(); + _alwaysOnTopChangedHandlers(*this, nullptr); } // Method Description: @@ -1969,34 +1976,42 @@ namespace winrt::TerminalApp::implementation // Method Description: // - Toggles borderless mode. Hides the tab row, and raises our - // ToggleFocusMode event. + // FocusModeChanged event. // Arguments: // - // Return Value: // - void TerminalPage::ToggleFocusMode() { - _toggleFocusModeHandlers(*this, nullptr); - _isInFocusMode = !_isInFocusMode; - _UpdateTabView(); + _focusModeChangedHandlers(*this, nullptr); } // Method Description: // - Toggles fullscreen mode. Hides the tab row, and raises our - // ToggleFullscreen event. + // FullscreenChanged event. // Arguments: // - // Return Value: // - void TerminalPage::ToggleFullscreen() { - _toggleFullscreenHandlers(*this, nullptr); - _isFullscreen = !_isFullscreen; - _UpdateTabView(); + _fullscreenChangedHandlers(*this, nullptr); + } + + // Method Description: + // - Toggles always on top mode. Raises our AlwaysOnTopChanged event. + // Arguments: + // - + // Return Value: + // - + void TerminalPage::ToggleAlwaysOnTop() + { + _isAlwaysOnTop = !_isAlwaysOnTop; + _alwaysOnTopChangedHandlers(*this, nullptr); } // Method Description: @@ -2187,12 +2202,36 @@ namespace winrt::TerminalApp::implementation } } + bool TerminalPage::FocusMode() const + { + return _isInFocusMode; + } + + bool TerminalPage::Fullscreen() const + { + return _isFullscreen; + } + // Method Description: + // - Returns true if we're currently in "Always on top" mode. When we're in + // always on top mode, the window should be on top of all other windows. + // If multiple windows are all "always on top", they'll maintain their own + // z-order, with all the windows on top of all other non-topmost windows. + // Arguments: + // - + // Return Value: + // - true if we should be in "always on top" mode + bool TerminalPage::AlwaysOnTop() const + { + return _isAlwaysOnTop; + } + // -------------------------------- WinRT Events --------------------------------- // Winrt events need a method for adding a callback to the event and removing the callback. // These macros will define them both for you. DEFINE_EVENT_WITH_TYPED_EVENT_HANDLER(TerminalPage, TitleChanged, _titleChangeHandlers, winrt::Windows::Foundation::IInspectable, winrt::hstring); DEFINE_EVENT_WITH_TYPED_EVENT_HANDLER(TerminalPage, LastTabClosed, _lastTabClosedHandlers, winrt::Windows::Foundation::IInspectable, winrt::TerminalApp::LastTabClosedEventArgs); DEFINE_EVENT_WITH_TYPED_EVENT_HANDLER(TerminalPage, SetTitleBarContent, _setTitleBarContentHandlers, winrt::Windows::Foundation::IInspectable, UIElement); - DEFINE_EVENT_WITH_TYPED_EVENT_HANDLER(TerminalPage, ToggleFocusMode, _toggleFocusModeHandlers, winrt::Windows::Foundation::IInspectable, winrt::TerminalApp::ToggleFocusModeEventArgs); - DEFINE_EVENT_WITH_TYPED_EVENT_HANDLER(TerminalPage, ToggleFullscreen, _toggleFullscreenHandlers, winrt::Windows::Foundation::IInspectable, winrt::TerminalApp::ToggleFullscreenEventArgs); + DEFINE_EVENT_WITH_TYPED_EVENT_HANDLER(TerminalPage, FocusModeChanged, _focusModeChangedHandlers, winrt::Windows::Foundation::IInspectable, winrt::Windows::Foundation::IInspectable); + DEFINE_EVENT_WITH_TYPED_EVENT_HANDLER(TerminalPage, FullscreenChanged, _fullscreenChangedHandlers, winrt::Windows::Foundation::IInspectable, winrt::Windows::Foundation::IInspectable); + DEFINE_EVENT_WITH_TYPED_EVENT_HANDLER(TerminalPage, AlwaysOnTopChanged, _alwaysOnTopChangedHandlers, winrt::Windows::Foundation::IInspectable, winrt::Windows::Foundation::IInspectable); } diff --git a/src/cascadia/TerminalApp/TerminalPage.h b/src/cascadia/TerminalApp/TerminalPage.h index b5536b837..2aa717cfa 100644 --- a/src/cascadia/TerminalApp/TerminalPage.h +++ b/src/cascadia/TerminalApp/TerminalPage.h @@ -51,6 +51,10 @@ namespace winrt::TerminalApp::implementation void ToggleFocusMode(); void ToggleFullscreen(); + void ToggleAlwaysOnTop(); + bool FocusMode() const; + bool Fullscreen() const; + bool AlwaysOnTop() const; void SetStartupActions(std::deque& actions); @@ -61,8 +65,9 @@ namespace winrt::TerminalApp::implementation DECLARE_EVENT_WITH_TYPED_EVENT_HANDLER(TitleChanged, _titleChangeHandlers, winrt::Windows::Foundation::IInspectable, winrt::hstring); DECLARE_EVENT_WITH_TYPED_EVENT_HANDLER(LastTabClosed, _lastTabClosedHandlers, winrt::Windows::Foundation::IInspectable, winrt::TerminalApp::LastTabClosedEventArgs); DECLARE_EVENT_WITH_TYPED_EVENT_HANDLER(SetTitleBarContent, _setTitleBarContentHandlers, winrt::Windows::Foundation::IInspectable, winrt::Windows::UI::Xaml::UIElement); - DECLARE_EVENT_WITH_TYPED_EVENT_HANDLER(ToggleFocusMode, _toggleFocusModeHandlers, winrt::Windows::Foundation::IInspectable, winrt::TerminalApp::ToggleFocusModeEventArgs); - DECLARE_EVENT_WITH_TYPED_EVENT_HANDLER(ToggleFullscreen, _toggleFullscreenHandlers, winrt::Windows::Foundation::IInspectable, winrt::TerminalApp::ToggleFullscreenEventArgs); + DECLARE_EVENT_WITH_TYPED_EVENT_HANDLER(FocusModeChanged, _focusModeChangedHandlers, winrt::Windows::Foundation::IInspectable, winrt::Windows::Foundation::IInspectable); + DECLARE_EVENT_WITH_TYPED_EVENT_HANDLER(FullscreenChanged, _fullscreenChangedHandlers, winrt::Windows::Foundation::IInspectable, winrt::Windows::Foundation::IInspectable); + DECLARE_EVENT_WITH_TYPED_EVENT_HANDLER(AlwaysOnTopChanged, _alwaysOnTopChangedHandlers, winrt::Windows::Foundation::IInspectable, winrt::Windows::Foundation::IInspectable); TYPED_EVENT(Initialized, winrt::Windows::Foundation::IInspectable, winrt::Windows::UI::Xaml::RoutedEventArgs); private: @@ -87,6 +92,7 @@ namespace winrt::TerminalApp::implementation bool _isInFocusMode{ false }; bool _isFullscreen{ false }; + bool _isAlwaysOnTop{ false }; bool _rearranging; std::optional _rearrangeFrom; @@ -211,6 +217,7 @@ namespace winrt::TerminalApp::implementation void _HandleToggleRetroEffect(const IInspectable& sender, const TerminalApp::ActionEventArgs& args); void _HandleToggleFocusMode(const IInspectable& sender, const TerminalApp::ActionEventArgs& args); void _HandleToggleFullscreen(const IInspectable& sender, const TerminalApp::ActionEventArgs& args); + void _HandleToggleAlwaysOnTop(const IInspectable& sender, const TerminalApp::ActionEventArgs& args); void _HandleSetTabColor(const IInspectable& sender, const TerminalApp::ActionEventArgs& args); void _HandleOpenTabColorPicker(const IInspectable& sender, const TerminalApp::ActionEventArgs& args); void _HandleRenameTab(const IInspectable& sender, const TerminalApp::ActionEventArgs& args); diff --git a/src/cascadia/TerminalApp/TerminalPage.idl b/src/cascadia/TerminalApp/TerminalPage.idl index 9d5bd0aa8..7fb5cb29a 100644 --- a/src/cascadia/TerminalApp/TerminalPage.idl +++ b/src/cascadia/TerminalApp/TerminalPage.idl @@ -4,8 +4,6 @@ namespace TerminalApp { delegate void LastTabClosedEventArgs(); - delegate void ToggleFullscreenEventArgs(); - delegate void ToggleFocusModeEventArgs(); interface IDialogPresenter { @@ -20,6 +18,10 @@ namespace TerminalApp String ApplicationDisplayName { get; }; String ApplicationVersion { get; }; + Boolean FocusMode { get; }; + Boolean Fullscreen { get; }; + Boolean AlwaysOnTop { get; }; + // We cannot use the default XAML APIs because we want to make sure // that there's only one application-global dialog visible at a time, // and because of GH#5224. @@ -28,8 +30,9 @@ namespace TerminalApp event Windows.Foundation.TypedEventHandler TitleChanged; event Windows.Foundation.TypedEventHandler LastTabClosed; event Windows.Foundation.TypedEventHandler SetTitleBarContent; - event Windows.Foundation.TypedEventHandler ToggleFullscreen; - event Windows.Foundation.TypedEventHandler ToggleFocusMode; + event Windows.Foundation.TypedEventHandler FocusModeChanged; + event Windows.Foundation.TypedEventHandler FullscreenChanged; + event Windows.Foundation.TypedEventHandler AlwaysOnTopChanged; event Windows.Foundation.TypedEventHandler Initialized; } } diff --git a/src/cascadia/TerminalApp/defaults.json b/src/cascadia/TerminalApp/defaults.json index 531c17244..b4167968f 100644 --- a/src/cascadia/TerminalApp/defaults.json +++ b/src/cascadia/TerminalApp/defaults.json @@ -6,6 +6,7 @@ "initialCols": 120, "initialRows": 30, "launchMode": "default", + "alwaysOnTop": false, // Selection "copyOnSelect": false, @@ -277,6 +278,7 @@ { "command": "toggleFullscreen", "keys": "alt+enter" }, { "command": "toggleFullscreen", "keys": "f11" }, { "command": "toggleFocusMode" }, + { "command": "toggleAlwaysOnTop" }, { "command": "openNewTabDropdown", "keys": "ctrl+shift+space" }, { "command": "openSettings", "keys": "ctrl+," }, { "command": { "action": "openSettings", "target": "defaultsFile" }, "keys": "ctrl+alt+," }, diff --git a/src/cascadia/WindowsTerminal/AppHost.cpp b/src/cascadia/WindowsTerminal/AppHost.cpp index 487547555..b2c3c32a3 100644 --- a/src/cascadia/WindowsTerminal/AppHost.cpp +++ b/src/cascadia/WindowsTerminal/AppHost.cpp @@ -52,6 +52,7 @@ AppHost::AppHost() noexcept : std::placeholders::_1, std::placeholders::_2)); _window->MouseScrolled({ this, &AppHost::_WindowMouseWheeled }); + _window->SetAlwaysOnTop(_logic.AlwaysOnTop()); _window->MakeWindow(); } @@ -156,8 +157,9 @@ void AppHost::Initialize() _window->DragRegionClicked([this]() { _logic.TitlebarClicked(); }); _logic.RequestedThemeChanged({ this, &AppHost::_UpdateTheme }); - _logic.ToggleFullscreen({ this, &AppHost::_ToggleFullscreen }); - _logic.ToggleFocusMode({ this, &AppHost::_ToggleFocusMode }); + _logic.FullscreenChanged({ this, &AppHost::_FullscreenChanged }); + _logic.FocusModeChanged({ this, &AppHost::_FocusModeChanged }); + _logic.AlwaysOnTopChanged({ this, &AppHost::_AlwaysOnTopChanged }); _logic.Create(); @@ -353,16 +355,22 @@ void AppHost::_UpdateTheme(const winrt::Windows::Foundation::IInspectable&, cons _window->OnApplicationThemeChanged(arg); } -void AppHost::_ToggleFocusMode(const winrt::Windows::Foundation::IInspectable&, - const winrt::TerminalApp::ToggleFocusModeEventArgs&) +void AppHost::_FocusModeChanged(const winrt::Windows::Foundation::IInspectable&, + const winrt::Windows::Foundation::IInspectable&) { - _window->ToggleFocusMode(); + _window->FocusModeChanged(_logic.FocusMode()); } -void AppHost::_ToggleFullscreen(const winrt::Windows::Foundation::IInspectable&, - const winrt::TerminalApp::ToggleFullscreenEventArgs&) +void AppHost::_FullscreenChanged(const winrt::Windows::Foundation::IInspectable&, + const winrt::Windows::Foundation::IInspectable&) { - _window->ToggleFullscreen(); + _window->FullscreenChanged(_logic.Fullscreen()); +} + +void AppHost::_AlwaysOnTopChanged(const winrt::Windows::Foundation::IInspectable&, + const winrt::Windows::Foundation::IInspectable&) +{ + _window->SetAlwaysOnTop(_logic.AlwaysOnTop()); } // Method Description: diff --git a/src/cascadia/WindowsTerminal/AppHost.h b/src/cascadia/WindowsTerminal/AppHost.h index 842f8c19b..4e072411d 100644 --- a/src/cascadia/WindowsTerminal/AppHost.h +++ b/src/cascadia/WindowsTerminal/AppHost.h @@ -33,9 +33,11 @@ private: const winrt::Windows::UI::Xaml::UIElement& arg); void _UpdateTheme(const winrt::Windows::Foundation::IInspectable&, const winrt::Windows::UI::Xaml::ElementTheme& arg); - void _ToggleFocusMode(const winrt::Windows::Foundation::IInspectable& sender, - const winrt::TerminalApp::ToggleFocusModeEventArgs& arg); - void _ToggleFullscreen(const winrt::Windows::Foundation::IInspectable& sender, - const winrt::TerminalApp::ToggleFullscreenEventArgs& arg); + void _FocusModeChanged(const winrt::Windows::Foundation::IInspectable& sender, + const winrt::Windows::Foundation::IInspectable& arg); + void _FullscreenChanged(const winrt::Windows::Foundation::IInspectable& sender, + const winrt::Windows::Foundation::IInspectable& arg); + void _AlwaysOnTopChanged(const winrt::Windows::Foundation::IInspectable& sender, + const winrt::Windows::Foundation::IInspectable& arg); void _WindowMouseWheeled(const til::point coord, const int32_t delta); }; diff --git a/src/cascadia/WindowsTerminal/IslandWindow.cpp b/src/cascadia/WindowsTerminal/IslandWindow.cpp index 3e78181d6..e6497d1d4 100644 --- a/src/cascadia/WindowsTerminal/IslandWindow.cpp +++ b/src/cascadia/WindowsTerminal/IslandWindow.cpp @@ -51,17 +51,18 @@ void IslandWindow::MakeWindow() noexcept // Create the window with the default size here - During the creation of the // window, the system will give us a chance to set its size in WM_CREATE. // WM_CREATE will be handled synchronously, before CreateWindow returns. - WINRT_VERIFY(CreateWindow(wc.lpszClassName, - L"Windows Terminal", - WS_OVERLAPPEDWINDOW, - CW_USEDEFAULT, - CW_USEDEFAULT, - CW_USEDEFAULT, - CW_USEDEFAULT, - nullptr, - nullptr, - wc.hInstance, - this)); + WINRT_VERIFY(CreateWindowEx(_alwaysOnTop ? WS_EX_TOPMOST : 0, + wc.lpszClassName, + L"Windows Terminal", + WS_OVERLAPPEDWINDOW, + CW_USEDEFAULT, + CW_USEDEFAULT, + CW_USEDEFAULT, + CW_USEDEFAULT, + nullptr, + nullptr, + wc.hInstance, + this)); WINRT_ASSERT(_window); } @@ -442,25 +443,63 @@ void IslandWindow::OnApplicationThemeChanged(const winrt::Windows::UI::Xaml::Ele } // Method Description: -// - Toggles our focus mode state. See _SetIsBorderless for more details. +// - Updates our focus mode state. See _SetIsBorderless for more details. // Arguments: // - // Return Value: // - -void IslandWindow::ToggleFocusMode() +void IslandWindow::FocusModeChanged(const bool focusMode) { - _SetIsBorderless(!_borderless); + // Do nothing if the value was unchanged. + if (focusMode == _borderless) + { + return; + } + + _SetIsBorderless(focusMode); } // Method Description: -// - Toggles our fullscreen state. See _SetIsFullscreen for more details. +// - Updates our fullscreen state. See _SetIsFullscreen for more details. // Arguments: // - // Return Value: // - -void IslandWindow::ToggleFullscreen() +void IslandWindow::FullscreenChanged(const bool fullscreen) { - _SetIsFullscreen(!_fullscreen); + // Do nothing if the value was unchanged. + if (fullscreen == _fullscreen) + { + return; + } + + _SetIsFullscreen(fullscreen); +} + +// Method Description: +// - Enter or exit the "always on top" state. Before the window is created, this +// value will later be used when we create the window to create the window on +// top of all others. After the window is created, it will either enter the +// group of topmost windows, or exit the group of topmost windows. +// Arguments: +// - alwaysOnTop: whether we should be entering or exiting always on top mode. +// Return Value: +// - +void IslandWindow::SetAlwaysOnTop(const bool alwaysOnTop) +{ + _alwaysOnTop = alwaysOnTop; + + const auto hwnd = GetHandle(); + if (hwnd) + { + SetWindowPos(hwnd, + _alwaysOnTop ? HWND_TOPMOST : HWND_NOTOPMOST, + 0, // the window dimensions are unused, because we're passing SWP_NOSIZE + 0, + 0, + 0, + SWP_NOMOVE | SWP_NOSIZE); + } } // From GdiEngine::s_SetWindowLongWHelper diff --git a/src/cascadia/WindowsTerminal/IslandWindow.h b/src/cascadia/WindowsTerminal/IslandWindow.h index eff8f7724..cd593e666 100644 --- a/src/cascadia/WindowsTerminal/IslandWindow.h +++ b/src/cascadia/WindowsTerminal/IslandWindow.h @@ -32,8 +32,9 @@ public: void SetCreateCallback(std::function pfn) noexcept; void SetSnapDimensionCallback(std::function pfn) noexcept; - void ToggleFocusMode(); - void ToggleFullscreen(); + void FocusModeChanged(const bool focusMode); + void FullscreenChanged(const bool fullscreen); + void SetAlwaysOnTop(const bool alwaysOnTop); #pragma endregion @@ -63,6 +64,7 @@ protected: bool _borderless{ false }; bool _fullscreen{ false }; + bool _alwaysOnTop{ false }; RECT _fullscreenWindowSize; RECT _nonFullscreenWindowSize;