diff --git a/src/PackageIdentity/PackageIdentity.vcxproj b/src/PackageIdentity/PackageIdentity.vcxproj index 8e8c9ce65a..26ae3d1749 100644 --- a/src/PackageIdentity/PackageIdentity.vcxproj +++ b/src/PackageIdentity/PackageIdentity.vcxproj @@ -117,4 +117,4 @@ - \ No newline at end of file + diff --git a/src/modules/alwaysontop/AlwaysOnTop/AlwaysOnTop.cpp b/src/modules/alwaysontop/AlwaysOnTop/AlwaysOnTop.cpp index f09cc2997f..9963f90858 100644 --- a/src/modules/alwaysontop/AlwaysOnTop/AlwaysOnTop.cpp +++ b/src/modules/alwaysontop/AlwaysOnTop/AlwaysOnTop.cpp @@ -21,6 +21,25 @@ namespace NonLocalizable { const static wchar_t* TOOL_WINDOW_CLASS_NAME = L"AlwaysOnTopWindow"; const static wchar_t* WINDOW_IS_PINNED_PROP = L"AlwaysOnTop_Pinned"; + constexpr UINT SYSTEM_MENU_TOGGLE_ALWAYS_ON_TOP_COMMAND = 0xEFE0; + constexpr DWORD SYSTEM_EVENT_MENU_POPUP_START = 0x0006; + constexpr DWORD SYSTEM_EVENT_MENU_POPUP_END = 0x0007; +} + +namespace +{ + void UnsubscribeEvents(std::vector& hooks) noexcept + { + for (const auto hook : hooks) + { + if (hook) + { + UnhookWinEvent(hook); + } + } + + hooks.clear(); + } } bool isExcluded(HWND window) @@ -32,7 +51,7 @@ bool isExcluded(HWND window) } AlwaysOnTop::AlwaysOnTop(bool useLLKH, DWORD mainThreadId) : - SettingsObserver({SettingId::FrameEnabled, SettingId::Hotkey, SettingId::ExcludeApps}), + SettingsObserver({SettingId::FrameEnabled, SettingId::Hotkey, SettingId::ExcludeApps, SettingId::ShowInSystemMenu}), m_hinstance(reinterpret_cast(&__ImageBase)), m_useCentralizedLLKH(useLLKH), m_mainThreadId(mainThreadId), @@ -53,6 +72,11 @@ AlwaysOnTop::AlwaysOnTop(bool useLLKH, DWORD mainThreadId) : SubscribeToEvents(); StartTrackingTopmostWindows(); + + if (HWND foregroundWindow = GetForegroundWindow()) + { + UpdateSystemMenuItem(foregroundWindow); + } } else { @@ -144,6 +168,13 @@ void AlwaysOnTop::SettingsUpdate(SettingId id) } } break; + case SettingId::ShowInSystemMenu: + { + UpdateSystemMenuEventHooks(AlwaysOnTopSettings::settings().showInSystemMenu); + m_lastSystemMenuWindow = nullptr; + UpdateSystemMenuItem(GetForegroundWindow()); + } + break; default: break; } @@ -225,6 +256,8 @@ void AlwaysOnTop::ProcessCommand(HWND window) { m_sound.Play(soundType); } + + UpdateSystemMenuItem(window); } void AlwaysOnTop::StartTrackingTopmostWindows() @@ -414,6 +447,86 @@ void AlwaysOnTop::SubscribeToEvents() Logger::error(L"Failed to set win event hook"); } } + + UpdateSystemMenuEventHooks(AlwaysOnTopSettings::settings().showInSystemMenu); +} + +void AlwaysOnTop::UpdateSystemMenuEventHooks(bool enable) +{ + constexpr std::array menu_events_to_subscribe = { + NonLocalizable::SYSTEM_EVENT_MENU_POPUP_START, + NonLocalizable::SYSTEM_EVENT_MENU_POPUP_END, + EVENT_OBJECT_INVOKED, + }; + + if (enable) + { + if (m_systemMenuWinEventHooks.size() == menu_events_to_subscribe.size()) + { + return; + } + + // Recover from any partial hook registration before re-registering. + UnsubscribeEvents(m_systemMenuWinEventHooks); + + for (const auto event : menu_events_to_subscribe) + { + auto hook = SetWinEventHook(event, event, nullptr, WinHookProc, 0, 0, WINEVENT_OUTOFCONTEXT | WINEVENT_SKIPOWNPROCESS); + if (hook) + { + m_systemMenuWinEventHooks.emplace_back(hook); + } + else + { + Logger::error(L"Failed to set system menu win event hook"); + } + } + } + else + { + UnsubscribeEvents(m_systemMenuWinEventHooks); + } +} + +void AlwaysOnTop::UpdateSystemMenuItem(HWND window) const noexcept +{ + if (!window || !IsWindow(window)) + { + return; + } + + const auto systemMenu = GetSystemMenu(window, false); + if (!systemMenu) + { + return; + } + + if (!AlwaysOnTopSettings::settings().showInSystemMenu) + { + if (GetMenuState(systemMenu, NonLocalizable::SYSTEM_MENU_TOGGLE_ALWAYS_ON_TOP_COMMAND, MF_BYCOMMAND) != static_cast(-1)) + { + RemoveMenu(systemMenu, NonLocalizable::SYSTEM_MENU_TOGGLE_ALWAYS_ON_TOP_COMMAND, MF_BYCOMMAND); + } + return; + } + + auto text = GET_RESOURCE_STRING(IDS_SYSTEM_MENU_TOGGLE_ALWAYS_ON_TOP); + MENUITEMINFOW menuItemInfo{}; + menuItemInfo.cbSize = sizeof(menuItemInfo); + menuItemInfo.fMask = MIIM_ID | MIIM_STATE | MIIM_STRING; + menuItemInfo.wID = NonLocalizable::SYSTEM_MENU_TOGGLE_ALWAYS_ON_TOP_COMMAND; + menuItemInfo.fState = IsPinned(window) ? MFS_CHECKED : MFS_UNCHECKED; + menuItemInfo.dwTypeData = text.data(); + + if (GetMenuState(systemMenu, NonLocalizable::SYSTEM_MENU_TOGGLE_ALWAYS_ON_TOP_COMMAND, MF_BYCOMMAND) == static_cast(-1)) + { + InsertMenuItemW(systemMenu, SC_CLOSE, FALSE, &menuItemInfo); + } + else + { + menuItemInfo.fMask = MIIM_STATE | MIIM_STRING; + SetMenuItemInfoW(systemMenu, NonLocalizable::SYSTEM_MENU_TOGGLE_ALWAYS_ON_TOP_COMMAND, FALSE, &menuItemInfo); + } } void AlwaysOnTop::UnpinAll() @@ -434,6 +547,9 @@ void AlwaysOnTop::UnpinAll() void AlwaysOnTop::CleanUp() { + UnsubscribeEvents(m_systemMenuWinEventHooks); + UnsubscribeEvents(m_staticWinEventHooks); + UnpinAll(); if (m_window) { @@ -492,6 +608,79 @@ bool AlwaysOnTop::IsTracked(HWND window) const noexcept void AlwaysOnTop::HandleWinHookEvent(WinHookEvent* data) noexcept { + switch (data->event) + { + case NonLocalizable::SYSTEM_EVENT_MENU_POPUP_START: + { + if (data->idObject == OBJID_SYSMENU && data->hwnd) + { + m_lastSystemMenuWindow = AlwaysOnTopSettings::settings().showInSystemMenu ? data->hwnd : nullptr; + UpdateSystemMenuItem(data->hwnd); + } + } + return; + case NonLocalizable::SYSTEM_EVENT_MENU_POPUP_END: + { + if (data->idObject == OBJID_SYSMENU && data->hwnd == m_lastSystemMenuWindow) + { + m_lastSystemMenuWindow = nullptr; + } + } + return; + case EVENT_OBJECT_INVOKED: + { + if (!AlwaysOnTopSettings::settings().showInSystemMenu) + { + return; + } + + if (data->idChild != static_cast(NonLocalizable::SYSTEM_MENU_TOGGLE_ALWAYS_ON_TOP_COMMAND)) + { + return; + } + + const bool isMenuRelatedObject = (data->idObject == OBJID_SYSMENU || data->idObject == OBJID_MENU || data->idObject == OBJID_CLIENT); + if (!isMenuRelatedObject && (!m_lastSystemMenuWindow || !IsWindow(m_lastSystemMenuWindow))) + { + return; + } + + const auto hasToggleMenuItem = [](HWND window) -> bool { + if (!window || !IsWindow(window)) + { + return false; + } + + const auto systemMenu = GetSystemMenu(window, false); + return systemMenu && + GetMenuState(systemMenu, NonLocalizable::SYSTEM_MENU_TOGGLE_ALWAYS_ON_TOP_COMMAND, MF_BYCOMMAND) != static_cast(-1); + }; + + HWND commandWindow = nullptr; + const auto trySetCommandWindow = [&](HWND candidate) noexcept { + if (!commandWindow && hasToggleMenuItem(candidate)) + { + commandWindow = candidate; + } + }; + + if (m_lastSystemMenuWindow && IsWindow(m_lastSystemMenuWindow)) + { + trySetCommandWindow(m_lastSystemMenuWindow); + } + trySetCommandWindow(data->hwnd); + trySetCommandWindow(GetForegroundWindow()); + + if (commandWindow) + { + ProcessCommand(commandWindow); + } + } + return; + default: + break; + } + if (!AlwaysOnTopSettings::settings().enableFrame || !data->hwnd) { return; @@ -566,6 +755,8 @@ void AlwaysOnTop::HandleWinHookEvent(WinHookEvent* data) noexcept break; case EVENT_SYSTEM_FOREGROUND: { + UpdateSystemMenuItem(data->hwnd); + if (!is_process_elevated() && IsProcessOfWindowElevated(data->hwnd)) { m_notificationUtil->WarnIfElevationIsRequired(GET_RESOURCE_STRING(IDS_ALWAYSONTOP), @@ -776,4 +967,4 @@ void AlwaysOnTop::RestoreWindowAlpha(HWND window) SetWindowLong(window, GWL_EXSTYLE, exStyle & ~WS_EX_LAYERED); } } -} \ No newline at end of file +} diff --git a/src/modules/alwaysontop/AlwaysOnTop/AlwaysOnTop.h b/src/modules/alwaysontop/AlwaysOnTop/AlwaysOnTop.h index 438eaa64c4..cc1088d499 100644 --- a/src/modules/alwaysontop/AlwaysOnTop/AlwaysOnTop.h +++ b/src/modules/alwaysontop/AlwaysOnTop/AlwaysOnTop.h @@ -45,6 +45,7 @@ private: static inline AlwaysOnTop* s_instance = nullptr; std::vector m_staticWinEventHooks{}; + std::vector m_systemMenuWinEventHooks{}; Sound m_sound; VirtualDesktopUtils m_virtualDesktopUtils; @@ -69,15 +70,18 @@ private: std::thread m_thread; const bool m_useCentralizedLLKH; bool m_running = true; + HWND m_lastSystemMenuWindow{ nullptr }; std::unique_ptr m_notificationUtil; LRESULT WndProc(HWND, UINT, WPARAM, LPARAM) noexcept; void HandleWinHookEvent(WinHookEvent* data) noexcept; + void UpdateSystemMenuItem(HWND window) const noexcept; bool InitMainWindow(); void RegisterHotkey() const; void RegisterLLKH(); void SubscribeToEvents(); + void UpdateSystemMenuEventHooks(bool enable); void ProcessCommand(HWND window); void StartTrackingTopmostWindows(); diff --git a/src/modules/alwaysontop/AlwaysOnTop/Resources.resx b/src/modules/alwaysontop/AlwaysOnTop/Resources.resx index 17ce38ca69..950f03dfeb 100644 --- a/src/modules/alwaysontop/AlwaysOnTop/Resources.resx +++ b/src/modules/alwaysontop/AlwaysOnTop/Resources.resx @@ -131,4 +131,7 @@ Don't show again - \ No newline at end of file + + Always on top + + diff --git a/src/modules/alwaysontop/AlwaysOnTop/Settings.cpp b/src/modules/alwaysontop/AlwaysOnTop/Settings.cpp index b84b42f7b7..0991b1924f 100644 --- a/src/modules/alwaysontop/AlwaysOnTop/Settings.cpp +++ b/src/modules/alwaysontop/AlwaysOnTop/Settings.cpp @@ -14,6 +14,7 @@ namespace NonLocalizable const static wchar_t* HotkeyID = L"hotkey"; const static wchar_t* SoundEnabledID = L"sound-enabled"; + const static wchar_t* ShowInSystemMenuID = L"show-in-system-menu"; const static wchar_t* FrameEnabledID = L"frame-enabled"; const static wchar_t* FrameThicknessID = L"frame-thickness"; const static wchar_t* FrameColorID = L"frame-color"; @@ -115,6 +116,16 @@ void AlwaysOnTopSettings::LoadSettings() } } + if (const auto jsonVal = values.get_bool_value(NonLocalizable::ShowInSystemMenuID)) + { + auto val = *jsonVal; + if (m_settings.showInSystemMenu != val) + { + m_settings.showInSystemMenu = val; + NotifyObservers(SettingId::ShowInSystemMenu); + } + } + if (const auto jsonVal = values.get_int_value(NonLocalizable::FrameThicknessID)) { auto val = *jsonVal; diff --git a/src/modules/alwaysontop/AlwaysOnTop/Settings.h b/src/modules/alwaysontop/AlwaysOnTop/Settings.h index 9c0624298e..76efd3d7b6 100644 --- a/src/modules/alwaysontop/AlwaysOnTop/Settings.h +++ b/src/modules/alwaysontop/AlwaysOnTop/Settings.h @@ -18,6 +18,7 @@ struct Settings static constexpr int minTransparencyPercentage = 20; // minimum transparency (can't go below 20%) static constexpr int maxTransparencyPercentage = 100; // maximum (fully opaque) static constexpr int transparencyStep = 10; // step size for +/- adjustment + bool showInSystemMenu = false; bool enableFrame = true; bool enableSound = true; bool roundCornersEnabled = true; @@ -56,4 +57,4 @@ private: std::unordered_set m_observers; void NotifyObservers(SettingId id) const; -}; \ No newline at end of file +}; diff --git a/src/modules/alwaysontop/AlwaysOnTop/SettingsConstants.h b/src/modules/alwaysontop/AlwaysOnTop/SettingsConstants.h index 8fc21bfcc1..7c428bb41e 100644 --- a/src/modules/alwaysontop/AlwaysOnTop/SettingsConstants.h +++ b/src/modules/alwaysontop/AlwaysOnTop/SettingsConstants.h @@ -4,6 +4,7 @@ enum class SettingId { Hotkey = 0, SoundEnabled, + ShowInSystemMenu, FrameEnabled, FrameThickness, FrameColor, @@ -12,4 +13,4 @@ enum class SettingId ExcludeApps, FrameAccentColor, RoundCornersEnabled -}; \ No newline at end of file +}; diff --git a/src/settings-ui/Settings.UI.Library/AlwaysOnTopProperties.cs b/src/settings-ui/Settings.UI.Library/AlwaysOnTopProperties.cs index 7dc6a91d9d..8dab3c4a19 100644 --- a/src/settings-ui/Settings.UI.Library/AlwaysOnTopProperties.cs +++ b/src/settings-ui/Settings.UI.Library/AlwaysOnTopProperties.cs @@ -12,6 +12,7 @@ namespace Microsoft.PowerToys.Settings.UI.Library { public static readonly HotkeySettings DefaultHotkeyValue = new HotkeySettings(true, true, false, false, 0x54); public const bool DefaultFrameEnabled = true; + public const bool DefaultShowInSystemMenu = false; public const int DefaultFrameThickness = 15; public const string DefaultFrameColor = "#0099cc"; public const bool DefaultFrameAccentColor = true; @@ -23,6 +24,7 @@ namespace Microsoft.PowerToys.Settings.UI.Library public AlwaysOnTopProperties() { Hotkey = new KeyboardKeysProperty(DefaultHotkeyValue); + ShowInSystemMenu = new BoolProperty(DefaultShowInSystemMenu); FrameEnabled = new BoolProperty(DefaultFrameEnabled); FrameThickness = new IntProperty(DefaultFrameThickness); FrameColor = new StringProperty(DefaultFrameColor); @@ -40,6 +42,9 @@ namespace Microsoft.PowerToys.Settings.UI.Library [JsonPropertyName("frame-enabled")] public BoolProperty FrameEnabled { get; set; } + [JsonPropertyName("show-in-system-menu")] + public BoolProperty ShowInSystemMenu { get; set; } + [JsonPropertyName("frame-thickness")] public IntProperty FrameThickness { get; set; } diff --git a/src/settings-ui/Settings.UI.UnitTests/Cmd/SetSettingCommandTests.cs b/src/settings-ui/Settings.UI.UnitTests/Cmd/SetSettingCommandTests.cs index 4c6d1babfd..ab679b68a8 100644 --- a/src/settings-ui/Settings.UI.UnitTests/Cmd/SetSettingCommandTests.cs +++ b/src/settings-ui/Settings.UI.UnitTests/Cmd/SetSettingCommandTests.cs @@ -43,6 +43,7 @@ public class SetSettingCommandTests [DataRow(typeof(FancyZonesSettings), nameof(FZConfigProperties.FancyzonesBorderColor), "#00FF00")] [DataRow(typeof(MeasureToolSettings), nameof(MeasureToolProperties.ActivationShortcut), "Ctrl+Alt+Delete")] [DataRow(typeof(AlwaysOnTopSettings), nameof(AlwaysOnTopProperties.SoundEnabled), "False")] + [DataRow(typeof(AlwaysOnTopSettings), nameof(AlwaysOnTopProperties.ShowInSystemMenu), "true")] [DataRow(typeof(PowerAccentSettings), nameof(PowerAccentProperties.ShowUnicodeDescription), "true")] [DataRow(typeof(AwakeSettings), nameof(AwakeProperties.Mode), "EXPIRABLE")] [DataRow(typeof(AwakeSettings), nameof(AwakeProperties.ExpirationDateTime), "March 31, 2020 15:00 +00:00")] diff --git a/src/settings-ui/Settings.UI/SettingsXAML/Views/AlwaysOnTopPage.xaml b/src/settings-ui/Settings.UI/SettingsXAML/Views/AlwaysOnTopPage.xaml index 9da92bec0a..b1dcc1ae91 100644 --- a/src/settings-ui/Settings.UI/SettingsXAML/Views/AlwaysOnTopPage.xaml +++ b/src/settings-ui/Settings.UI/SettingsXAML/Views/AlwaysOnTopPage.xaml @@ -34,9 +34,20 @@ IsExpanded="True"> + + + + + + + + + + + @@ -97,22 +108,6 @@ - - - - - - - - - - - - - diff --git a/src/settings-ui/Settings.UI/Strings/en-us/Resources.resw b/src/settings-ui/Settings.UI/Strings/en-us/Resources.resw index bdce13b760..7315147ddb 100644 --- a/src/settings-ui/Settings.UI/Strings/en-us/Resources.resw +++ b/src/settings-ui/Settings.UI/Strings/en-us/Resources.resw @@ -2958,6 +2958,12 @@ Right-click to remove the key combination, thereby deactivating the shortcut. Appearance & behavior + + Show Always on Top in the title bar context menu + + + Lets you turn Always on Top mode on or off from the window's title bar right-click menu + Always On Top {Locked} @@ -2974,19 +2980,13 @@ Right-click to remove the key combination, thereby deactivating the shortcut.Activation shortcut - Customize the shortcut to pin or unpin an app window and use the same modifier keys with + or − to adjust its transparency - - - Window transparency - - - Adjust the transparency of the focused window on top + Customize the shortcut to pin or unpin an app window - Press **{0}** to increase the window opacity + Press **{0}** to increase the opacity of the window - Press **{0}** to decrease the window opacity + Press **{0}** to decrease the opacity of the window Always On Top @@ -5815,4 +5815,4 @@ Text uses the current drawing color. Sample - \ No newline at end of file + diff --git a/src/settings-ui/Settings.UI/ViewModels/AlwaysOnTopViewModel.cs b/src/settings-ui/Settings.UI/ViewModels/AlwaysOnTopViewModel.cs index a62c617589..534a0710f0 100644 --- a/src/settings-ui/Settings.UI/ViewModels/AlwaysOnTopViewModel.cs +++ b/src/settings-ui/Settings.UI/ViewModels/AlwaysOnTopViewModel.cs @@ -50,6 +50,7 @@ namespace Microsoft.PowerToys.Settings.UI.ViewModels Settings = moduleSettingsRepository.SettingsConfig; _hotkey = Settings.Properties.Hotkey.Value; + _showInSystemMenu = Settings.Properties.ShowInSystemMenu.Value; _frameEnabled = Settings.Properties.FrameEnabled.Value; _frameThickness = Settings.Properties.FrameThickness.Value; _frameColor = Settings.Properties.FrameColor.Value; @@ -164,6 +165,21 @@ namespace Microsoft.PowerToys.Settings.UI.ViewModels } } + public bool ShowInSystemMenu + { + get => _showInSystemMenu; + + set + { + if (value != _showInSystemMenu) + { + _showInSystemMenu = value; + Settings.Properties.ShowInSystemMenu.Value = value; + NotifyPropertyChanged(); + } + } + } + public int FrameThickness { get => _frameThickness; @@ -336,6 +352,7 @@ namespace Microsoft.PowerToys.Settings.UI.ViewModels private bool _enabledStateIsGPOConfigured; private bool _isEnabled; private HotkeySettings _hotkey; + private bool _showInSystemMenu; private bool _frameEnabled; private int _frameThickness; private string _frameColor;