Shortcut Guide V2

.github/actions/spell-check/allow/code.txt

@@ -47,6 +47,7 @@ resw
 resx
 srt
 Stereolithography
+taskmgr
 terabyte
 UYVY
 xbf
@@ -320,6 +321,10 @@ MRUCMPPROC
 MRUINFO
 REGSTR
 
+#Xaml
+NVI
+Storyboards
+
 # Misc Win32 APIs and PInvokes
 INVOKEIDLIST
 

.github/actions/spell-check/expect.txt

@@ -858,6 +858,8 @@ jpnime
 Jsons
 jsonval
 jxr
+KBSC
+kdc
 keybd
 KEYBDDATA
 KEYBDINPUT
@@ -1268,6 +1270,7 @@ OUTOFCONTEXT
 Outptr
 outputtype
 outsettings
+outsourced
 OVERLAPPEDWINDOW
 Oversampling
 OVERWRITEPROMPT
@@ -1333,6 +1336,7 @@ pici
 pidl
 PIDLIST
 pii
+pinboard
 pinfo
 pinvoke
 pipename
@@ -1413,6 +1417,7 @@ projectname
 PROPERTYKEY
 Propset
 PROPVARIANT
+Prt
 PRTL
 prvpane
 psapi
@@ -2088,6 +2093,7 @@ WNDCLASSW
 WNDPROC
 wnode
 wom
+workerw
 WORKSPACESEDITOR
 WORKSPACESLAUNCHER
 WORKSPACESSNAPSHOTTOOL

.pipelines/ESRPSigning_core.json

@@ -230,8 +230,12 @@
             "WinUI3Apps\\PowerToys.RegistryPreview.dll",
             "WinUI3Apps\\PowerToys.RegistryPreview.exe",
 
-            "PowerToys.ShortcutGuide.exe",
-            "PowerToys.ShortcutGuideModuleInterface.dll",
+            "WinUI3Apps\\PowerToys.ShortcutGuide.exe",
+            "WinUI3Apps\\PowerToys.ShortcutGuide.dll",
+            "WinUI3Apps\\PowerToys.ShortcutGuideModuleInterface.dll",
+            "WinUI3Apps\\PowerToys.ShortcutGuide.IndexYmlGenerator.dll",
+            "WinUI3Apps\\PowerToys.ShortcutGuide.IndexYmlGenerator.exe",
+            "WinUI3Apps\\ShortcutGuide.CPPProject.dll",
 
             "PowerToys.ZoomIt.exe",
             "PowerToys.ZoomItModuleInterface.dll",

Directory.Packages.props

@@ -135,6 +135,7 @@
     <PackageVersion Include="WinUIEx" Version="2.8.0" />
     <PackageVersion Include="WPF-UI" Version="3.0.5" />
     <PackageVersion Include="WyHash" Version="1.0.5" />
+    <PackageVersion Include="YamlDotNet" Version="16.3.0" />
     <PackageVersion Include="WixToolset.Heat" Version="5.0.2" />
     <PackageVersion Include="WixToolset.Firewall.wixext" Version="5.0.2" />
     <PackageVersion Include="WixToolset.Util.wixext" Version="5.0.2" />

NOTICE.md

@@ -1570,4 +1570,5 @@ SOFTWARE.
 - UTF.Unknown
 - WinUIEx
 - WPF-UI
-- WyHash
+- WyHash
+- YamlDotNet

PowerToys.slnx

@@ -428,7 +428,7 @@
     </Project>
   </Folder>
   <Folder Name="/modules/FileLocksmith/">
-    <Project Path="src/modules/FileLocksmith/FileLocksmithCLI/FileLocksmithCLI.vcxproj" Id="49D456D3-F485-45AF-8875-45B44F193DDC" />
+    <Project Path="src/modules/FileLocksmith/FileLocksmithCLI/FileLocksmithCLI.vcxproj" Id="49d456d3-f485-45af-8875-45b44f193ddc" />
     <Project Path="src/modules/FileLocksmith/FileLocksmithContextMenu/FileLocksmithContextMenu.vcxproj" Id="799a50d8-de89-4ed1-8ff8-ad5a9ed8c0ca" />
     <Project Path="src/modules/FileLocksmith/FileLocksmithExt/FileLocksmithExt.vcxproj" Id="57175ec7-92a5-4c1e-8244-e3fbca2a81de" />
     <Project Path="src/modules/FileLocksmith/FileLocksmithLib/FileLocksmithLib.vcxproj" Id="9d52fd25-ef90-4f9a-a015-91efc5daf54f" />
@@ -439,7 +439,7 @@
     </Project>
   </Folder>
   <Folder Name="/modules/FileLocksmith/Tests/">
-    <Project Path="src/modules/FileLocksmith/FileLocksmithCLI/tests/FileLocksmithCLIUnitTests.vcxproj" Id="A1B2C3D4-E5F6-7890-1234-567890ABCDEF" />
+    <Project Path="src/modules/FileLocksmith/FileLocksmithCLI/tests/FileLocksmithCLIUnitTests.vcxproj" Id="a1b2c3d4-e5f6-7890-1234-567890abcdef" />
   </Folder>
   <Folder Name="/modules/Hosts/">
     <Project Path="src/modules/Hosts/Hosts/Hosts.csproj">
@@ -465,13 +465,13 @@
   </Folder>
   <Folder Name="/modules/imageresizer/">
     <Project Path="src/modules/imageresizer/dll/ImageResizerExt.vcxproj" Id="0b43679e-edfa-4da0-ad30-f4628b308b1b" />
-    <Project Path="src/modules/imageresizer/ImageResizerContextMenu/ImageResizerContextMenu.vcxproj" Id="93b72a06-c8bd-484f-a6f7-c9f280b150bf" />
-    <Project Path="src/modules/imageresizer/ImageResizerLib/ImageResizerLib.vcxproj" Id="18b3db45-4ffe-4d01-97d6-5223feee1853" />
-    <Project Path="src/modules/imageresizer/ui/ImageResizerUI.csproj">
+    <Project Path="src/modules/imageresizer/ImageResizerCLI/ImageResizerCLI.csproj">
       <Platform Solution="*|ARM64" Project="ARM64" />
       <Platform Solution="*|x64" Project="x64" />
     </Project>
-    <Project Path="src/modules/imageresizer/ImageResizerCLI/ImageResizerCLI.csproj">
+    <Project Path="src/modules/imageresizer/ImageResizerContextMenu/ImageResizerContextMenu.vcxproj" Id="93b72a06-c8bd-484f-a6f7-c9f280b150bf" />
+    <Project Path="src/modules/imageresizer/ImageResizerLib/ImageResizerLib.vcxproj" Id="18b3db45-4ffe-4d01-97d6-5223feee1853" />
+    <Project Path="src/modules/imageresizer/ui/ImageResizerUI.csproj">
       <Platform Solution="*|ARM64" Project="ARM64" />
       <Platform Solution="*|x64" Project="x64" />
     </Project>
@@ -961,9 +961,16 @@
       <Platform Solution="*|x64" Project="x64" />
     </Project>
   </Folder>
-  <Folder Name="/modules/shortcutguide/">
-    <Project Path="src/modules/ShortcutGuide/ShortcutGuide/ShortcutGuide.vcxproj" Id="2edb3eb4-fa92-4bff-b2d8-566584837231" />
-    <Project Path="src/modules/ShortcutGuide/ShortcutGuideModuleInterface/ShortcutGuideModuleInterface.vcxproj" Id="2d604c07-51fc-46bb-9eb7-75aecc7f5e81" />
+  <Folder Name="/modules/ShortcutGuide/">
+    <Project Path="src/modules/ShortcutGuide/ShortcutGuide.IndexYmlGenerator/ShortcutGuide.IndexYmlGenerator.csproj">
+      <Platform Solution="*|ARM64" Project="ARM64" />
+      <Platform Solution="*|x64" Project="x64" />
+    </Project>
+    <Project Path="src/modules/ShortcutGuide/ShortcutGuide.Ui/ShortcutGuide.Ui.csproj">
+      <Platform Solution="*|ARM64" Project="ARM64" />
+      <Platform Solution="*|x64" Project="x64" />
+    </Project>
+    <Project Path="src/modules/ShortcutGuide/ShortcutGuideModuleInterface/ShortcutGuideModuleInterface.vcxproj" Id="e487304a-b1fb-4e6b-8e70-014051af5b99" />
   </Folder>
   <Folder Name="/modules/Workspaces/">
     <Project Path="src/modules/Workspaces/Workspaces.ModuleServices/Workspaces.ModuleServices.csproj">

doc/devdocs/modules/shortcut_guide.md

@@ -9,12 +9,14 @@
 [Pull Requests](https://github.com/microsoft/PowerToys/pulls?q=is%3Apr+is%3Aopen+label%3A%22Product-Shortcut+Guide%22+)
 
 ## Overview
-Shortcut Guide is a PowerToy that displays an overlay of available keyboard shortcuts when the Windows key is pressed and held. It provides a visual reference for Windows key combinations, helping users discover and utilize built-in Windows shortcuts.
+Shortcut Guide is a PowerToy that displays an overlay of available keyboard shortcuts when a user-set keyboard shortcut is pressed. It helps users discover and remember keyboard shortcuts for Windows and apps.
+
+> [!NOTE]
+> The spec for the manifest files is in development and will be linked here once available.
 
 ## Usage
-- Press and hold the Windows key to display the overlay of available shortcuts
-- Press the hotkey again to dismiss the overlay
-- The overlay displays Windows shortcuts with their corresponding actions
+- Press the user-defined hotkey to display the overlay
+- Press the hotkey again or press ESC to dismiss the overlay
 
 ## Build and Debug Instructions
 
@@ -25,67 +27,83 @@ Shortcut Guide is a PowerToy that displays an overlay of available keyboard shor
 4. The executable is named PowerToys.ShortcutGuide.exe
 
 ### Debug
-1. Right-click the ShortcutGuide project and select 'Set as Startup Project'
+1. Right-click the ShortcutGuide.Ui project and select 'Set as Startup Project'
 2. Right-click the project again and select 'Debug'
 
-## Code Structure
+> [!NOTE]
+> When run in debug mode, the window behaves differently than in release mode. It will not automatically close when loosing focus, it will be displayed on top of all other windows, and it is not hidden from the taskbar. 
+
+## Project Structure
+
+The Shortcut Guide module consists of the following 4 projects:
+
+### [`ShortcutGuide.Ui`](/src/modules/ShortcutGuide/ShortcutGuide.Ui/ShortcutGuide.Ui.csproj
+
+This is the main UI project for the Shortcut Guide module. Upon startup it does the following tasks:
+
+1. Copies the built-in manifest files to the users manifest directory (overwriting existing files).
+2. Generate the `index.yml` manifest file.
+3. Populate the PowerToys shortcut manifest with the user-defined shortcuts.
+4. Starts the UI.
+
+### [`ShortcutGuide.CPPProject`](/src/modules/ShortcutGuide/ShortcutGuide.CPPProject/ShortcutGuide.CPPProject.vcxproj)
+
+This project exports certain functions to be used by the Shortcut Guide module, that were not able to be implemented in C#.
+
+#### [`excluded_app.cpp`](/src/modules/ShortcutGuide/ShortcutGuide.CPPProject/excluded_app.cpp)
+
+This file contains one function with the following signature:
 
-![Diagram](../images/shortcutguide/diagram.png)
+```cpp
+__declspec(dllexport) bool IsCurrentWindowExcludedFromShortcutGuide()
+```
 
-### Core Files
+This function checks if the current window is excluded from the Shortcut Guide overlay. It returns `true` if the current window is excluded otherwise it returns `false`.
 
-#### [`dllmain.cpp`](/src/modules/shortcut_guide/dllmain.cpp)
-Contains DLL boilerplate code. Implements the PowertoyModuleIface, including enable/disable functionality and GPO policy handling. Captures hotkey events and starts the PowerToys.ShortcutGuide.exe process to display the shortcut guide window.
+#### [`tasklist_positions.cpp`](/src/modules/ShortcutGuide/ShortcutGuide.CPPProject/tasklist_positions.cpp)
 
-#### [`shortcut_guide.cpp`](/src/modules/shortcut_guide/shortcut_guide.cpp)
-Contains the module interface code. It initializes the settings values and the keyboard event listener. Defines the OverlayWindow class, which manages the overall logic and event handling for the PowerToys Shortcut Guide.
+This file contains helper functions to retrieve the positions of the taskbar buttons. It exports the following function:
 
-#### [`overlay_window.cpp`](/src/modules/shortcut_guide/overlay_window.cpp)
-Contains the code for loading the SVGs, creating and rendering of the overlay window. Manages and displays overlay windows with SVG graphics through two main classes:
-- D2DOverlaySVG: Handles loading, resizing, and manipulation of SVG graphics
-- D2DOverlayWindow: Manages the display and behavior of the overlay window
+```cpp
+__declspec(dllexport) TasklistButton* get_buttons(HMONITOR monitor, int* size)
+```
 
-#### [`keyboard_state.cpp`](/src/modules/shortcut_guide/keyboard_state.cpp)
-Contains helper methods for checking the current state of the keyboard.
+This function retrieves the positions of the taskbar buttons for a given monitor. It returns an array of `TasklistButton` structures (max 10), which contain the position and size of each button.
 
-#### [`target_state.cpp`](/src/modules/shortcut_guide/target_state.cpp)
-State machine that handles the keyboard events. It's responsible for deciding when to show the overlay, when to suppress the Start menu (if the overlay is displayed long enough), etc. Handles state transitions and synchronization to ensure the overlay is shown or hidden appropriately based on user interactions.
+`monitor` must be the monitor handle of the monitor containing the taskbar instance of which the buttons should be retrieved.
 
-#### [`trace.cpp`](/src/modules/shortcut_guide/trace.cpp)
-Contains code for telemetry.
+`size` will contain the resulting array size.
 
-### Supporting Files
+It determines the positions through Windows `FindWindowEx` function.
+For the primary taskbar it searches for:
+* A window called "Shell_TrayWnd"
+* that contains a window called "ReBarWindow32"
+* that contains a window called "MSTaskSwWClass"
+* that contains a window called "MSTaskListWClass"
 
-#### [`animation.cpp`](/src/modules/shortcut_guide/animation.cpp)
-Handles the timing and interpolation of animations. Calculates the current value of an animation based on elapsed time and a specified easing function.
+For any secondary taskbar it searches for:
+* A window called "Shell_SecondaryTrayWnd"
+* that contains a window called "WorkerW"
+* that contains a window called "MSTaskListWClass"
 
-#### [`d2d_svg.cpp`](/src/modules/shortcut_guide/d2d_svg.cpp)
-Provides functionality for loading, resizing, recoloring, rendering, and manipulating SVG images using Direct2D.
+It then enumerates all the button elements inside "MSTaskListWClass" while skipping such with a same name (which implies the user does not use combining taskbar buttons) 
 
-#### [`d2d_text.cpp`](/src/modules/shortcut_guide/d2d_text.cpp)
-Handles creation, resizing, alignment, and rendering of text using Direct2D and DirectWrite.
+### [`ShortcutGuide.IndexYmlGenerator`](/src/modules/ShortcutGuide/ShortcutGuide.IndexYmlGenerator/)
 
-#### [`d2d_window.cpp`](/src/modules/shortcut_guide/d2d_window.cpp)
-Manages a window using Direct2D and Direct3D for rendering. Handles window creation, resizing, rendering, and destruction.
+This application generates the `index.yml` manifest file.
 
-#### [`native_event_waiter.cpp`](/src/modules/shortcut_guide/native_event_waiter.cpp)
-Waits for a named event and executes a specified action when the event is triggered. Uses a separate thread to handle event waiting and action execution.
+It is a separate project so that its code can be easier ported to WinGet in the future.
 
-#### [`tasklist_positions.cpp`](/src/modules/shortcut_guide/tasklist_positions.cpp)
-Handles retrieving and updating the positions and information of taskbar buttons in Windows.
+### [`ShortcutGuideModuleInterface`](/src/modules/ShortcutGuide/ShortcutGuideModuleInterface/ShortcutGuideModuleInterface.vcxproj)
 
-#### [`main.cpp`](/src/modules/shortcut_guide/main.cpp)
-The entry point for the PowerToys Shortcut Guide application. Handles initialization, ensures single instance execution, manages parent process termination, creates and displays the overlay window, and runs the main event loop.
+The module interface that handles opening and closing the user interface.
 
 ## Features and Limitations
 
-- The overlay displays Windows shortcuts (Windows key combinations)
-- The module supports localization, but only for the Windows controls on the left side of the overlay
+- Currently the displayed shortcuts (Except the ones from PowerToys) are not localized.
 - It's currently rated as a P3 (lower priority) module
 
 ## Future Development
 
-A community-contributed version 2 is in development that will support:
-- Application-specific shortcuts based on the active application
-- Additional shortcuts beyond Windows key combinations
-- PowerToys shortcuts
+- Implementing with WinGet to get new shortcut manifest files
+- Adding localization support for the built-in manifest files