[cmdpal] Add setting "ignore hotkey when full screen" (#38923)

* init

* merge main

* merge main

---------

Co-authored-by: Yu Leng (from Dev Box) <yuleng@microsoft.com>

src/modules/cmdpal/Microsoft.CmdPal.UI.ViewModels/SettingsModel.cs

@@ -40,6 +40,8 @@ public partial class SettingsModel : ObservableObject
 
     public bool ShowSystemTrayIcon { get; set; } = true;
 
+    public bool IgnoreShortcutWhenFullscreen { get; set; } = true;
+
     public Dictionary<string, ProviderSettings> ProviderSettings { get; set; } = [];
 
     public Dictionary<string, CommandAlias> Aliases { get; set; } = [];

src/modules/cmdpal/Microsoft.CmdPal.UI.ViewModels/SettingsViewModel.cs

@@ -108,6 +108,16 @@ public partial class SettingsViewModel : INotifyPropertyChanged
         }
     }
 
+    public bool IgnoreShortcutWhenFullscreen
+    {
+        get => _settings.IgnoreShortcutWhenFullscreen;
+        set
+        {
+            _settings.IgnoreShortcutWhenFullscreen = value;
+            Save();
+        }
+    }
+
     public ObservableCollection<ProviderSettingsViewModel> CommandProviders { get; } = [];
 
     public SettingsViewModel(SettingsModel settings, IServiceProvider serviceProvider, TaskScheduler scheduler)

src/modules/cmdpal/Microsoft.CmdPal.UI/Helpers/NativeMethods.cs

@@ -0,0 +1,26 @@
+// Copyright (c) Microsoft Corporation
+// The Microsoft Corporation licenses this file to you under the MIT license.
+// See the LICENSE file in the project root for more information.
+
+using System.Runtime.InteropServices;
+using System.Security;
+
+namespace Microsoft.CmdPal.UI.Helpers;
+
+[SuppressUnmanagedCodeSecurity]
+internal static class NativeMethods
+{
+    [DllImport("shell32.dll")]
+    public static extern int SHQueryUserNotificationState(out UserNotificationState state);
+}
+
+internal enum UserNotificationState : int
+{
+    QUNS_NOT_PRESENT = 1,
+    QUNS_BUSY,
+    QUNS_RUNNING_D3D_FULL_SCREEN,
+    QUNS_PRESENTATION_MODE,
+    QUNS_ACCEPTS_NOTIFICATIONS,
+    QUNS_QUIET_TIME,
+    QUNS_APP,
+}

src/modules/cmdpal/Microsoft.CmdPal.UI/Helpers/WindowHelper.cs

@@ -0,0 +1,28 @@
+// Copyright (c) Microsoft Corporation
+// The Microsoft Corporation licenses this file to you under the MIT license.
+// See the LICENSE file in the project root for more information.
+
+using System.Runtime.InteropServices;
+
+namespace Microsoft.CmdPal.UI.Helpers;
+
+internal sealed partial class WindowHelper
+{
+    public static bool IsWindowFullscreen()
+    {
+        UserNotificationState state;
+
+        // https://learn.microsoft.com/en-us/windows/win32/api/shellapi/ne-shellapi-query_user_notification_state
+        if (Marshal.GetExceptionForHR(NativeMethods.SHQueryUserNotificationState(out state)) == null)
+        {
+            if (state == UserNotificationState.QUNS_RUNNING_D3D_FULL_SCREEN ||
+                state == UserNotificationState.QUNS_BUSY ||
+                state == UserNotificationState.QUNS_PRESENTATION_MODE)
+            {
+                return true;
+            }
+        }
+
+        return false;
+    }
+}

src/modules/cmdpal/Microsoft.CmdPal.UI/MainWindow.xaml.cs

@@ -43,6 +43,7 @@ public sealed partial class MainWindow : Window,
     private readonly WNDPROC? _hotkeyWndProc;
     private readonly WNDPROC? _originalWndProc;
     private readonly List<TopLevelHotkey> _hotkeys = [];
+    private bool _ignoreHotKeyWhenFullScreen = true;
 
     // Stylistically, window messages are WM_*
 #pragma warning disable SA1310 // Field names should not contain underscore
@@ -157,6 +158,8 @@ public sealed partial class MainWindow : Window,
         SetupHotkey(settings);
         SetupTrayIcon(settings.ShowSystemTrayIcon);
 
+        _ignoreHotKeyWhenFullScreen = settings.IgnoreShortcutWhenFullscreen;
+
         // This will prevent our window from appearing in alt+tab or the taskbar.
         // You'll _need_ to use the hotkey to summon it.
         AppWindow.IsShownInSwitchers = System.Diagnostics.Debugger.IsAttached;
@@ -504,6 +507,15 @@ public sealed partial class MainWindow : Window,
                     var hotkeyIndex = (int)wParam.Value;
                     if (hotkeyIndex < _hotkeys.Count)
                     {
+                        if (_ignoreHotKeyWhenFullScreen)
+                        {
+                            // If we're in full screen mode, ignore the hotkey
+                            if (WindowHelper.IsWindowFullscreen())
+                            {
+                                return (LRESULT)IntPtr.Zero;
+                            }
+                        }
+
                         var hotkey = _hotkeys[hotkeyIndex];
                         HandleSummon(hotkey.CommandId);
 

src/modules/cmdpal/Microsoft.CmdPal.UI/Settings/GeneralPage.xaml

@@ -48,6 +48,9 @@
                             </controls:SettingsCard>
                         </controls:SettingsExpander.Items>
                     </controls:SettingsExpander>
+                    <controls:SettingsCard x:Uid="Settings_GeneralPage_IgnoreShortcutWhenFullscreen_SettingsCard" HeaderIcon="{ui:FontIcon Glyph=&#xE7FC;}">
+                        <ToggleSwitch IsOn="{x:Bind viewModel.IgnoreShortcutWhenFullscreen, Mode=TwoWay}" />
+                    </controls:SettingsCard>
                     <controls:SettingsCard x:Uid="Settings_GeneralPage_GoHome_SettingsCard" HeaderIcon="{ui:FontIcon Glyph=&#xE80F;}">
                         <ToggleSwitch IsOn="{x:Bind viewModel.HotkeyGoesHome, Mode=TwoWay}" />
                     </controls:SettingsCard>

src/modules/cmdpal/Microsoft.CmdPal.UI/Strings/en-us/Resources.resw

@@ -328,6 +328,12 @@ Right-click to remove the key combination, thereby deactivating the shortcut.</v
   <data name="Settings_GeneralPage_LowLevelHook_SettingsCard.Description" xml:space="preserve">
     <value>Try this if there are issues with the shortcut (Command Palette might not get focus when triggered from an elevated window)</value>
   </data>
+  <data name="Settings_GeneralPage_IgnoreShortcutWhenFullscreen_SettingsCard.Header" xml:space="preserve">
+    <value>Ignore shortcut in fullscreen mode</value>
+  </data>
+  <data name="Settings_GeneralPage_IgnoreShortcutWhenFullscreen_SettingsCard.Description" xml:space="preserve">
+    <value>Preventing disruption of the program running in fullscreen by unintentional activation of shortcut</value>
+  </data>
   <data name="Settings_GeneralPage_GoHome_SettingsCard.Header" xml:space="preserve">
     <value>Go home when activated</value>
   </data>