Ready for Review - [Mouse Jump] Customisable appearance - borders, margins, colours, etc - final part

[mikeclayton]

Summary of the Pull Request

This is the last part of the Mouse Jump styles work that finally enables the feature in Settings UI and in the Mouse Jump preview image.

See #27511 for the original feature suggestion.

Changes in this PR

• Moved the Mouse Jump "settings ui" xaml and code into a separate "MouseJumpPanel.xaml" control to make it easier to make changes to the settings controls
• Added a new "Appearance" expander in Mouse Jump settings with all the new border, colour, 3d effect, spacing, etc settings controls to allow the user to set custom properties
• Also added some predefined style options:
  • "Compact" is the original Mouse Jump style with just a borders around the whole image and no other chrome
  • "Bezelled" is the new default with some simple spacing between screens and 3d bezels drawn around them

Reviewer Notes

• Added a reference to CommunityToolkit.WinUI.Controls.Segmented in PowerToys.Settings to allow the "Compact | Bezelled | Custom" options for Preview Style

• Added a reference to MouseJump.Common in PowerToys.Settings to allow rendering the preview image when settings are changed

• I've made "Bezelled" the new default style as a precursor to the proposed Mouse Without Borders integration in Integrate Mouse Jump with Mouse Without Borders to allow jumping to remote computers when MWB is enabled #34126 - it'll be easier to make the bezel colours vary by host if they're already visible.

• Code touches the internals of the Segmented control to force the preview image to be centered - see PreviewImage_Loaded method - might be brittle if the implementation changes?

• Config upgrade seems a bit odd - the in-memory settings get upgraded fine with "version": "1.`" but it seems to get reverted and saved again as "version": "1.0" and then overwritten again as "version"": "1.1". I've worked around this by additionally checking if the new settings have values before upgrading, but it seems like that's what the version flag is supposed to be for. It works for now anyway, but not sure if this is the right way to do it...

• Does the "Copy to Custom preview style" need an "Are you sure? Yes / No" before overwriting and / or a "Copied!" message after copying? I'm happy to leave it as is, but feedback welcome...

PR Checklist

• Closes [Mouse Jump] Customisable appearance - borders, margins, colours, etc #27511
• Communication: I've discussed this with core contributors already. If work hasn't been agreed, this work might be rejected
• Tests: Added/updated and all pass
• Localization: All end user facing strings can be localized
  • all ui strings come from Resources.resw
• Dev docs: Added/updated
  • no changes required
• New binaries: Added on the required places
  • no changes required
  • JSON for signing for new binaries
  • WXS for installer for new binaries and localization folder
  • YML for CI pipeline for new test projects
  • YML for signed pipeline
• Documentation updated: If checked, please file a pull request on our docs repo and link it here: #xxx
  • no changes required

Validation Steps Performed

• Workflow tests
  • Automated tests passing locally
  • Minimal actions workflow (spelling check) passing for PR
  • Full actions workflow (msbuild) passing for PR
• UI tests
  • Happy path
    • preview image appears when activated
    • clicking the preview image moves the mouse cursor to the correct location
    • right-click dismisses the preview image without moving the mouse
    • pressing escape dismisses the preview image without moving the mouse
  • Works on multiple monitors with different dpi scaling settings (e.g. 100% vs 150%)
    • [Mouse Jump] - new feature - #23216 #23566 (comment)
    • [Mouse Jump] - new feature - #23216 #23566 (comment)
  • Handling negative coordinates on non-primary monitors if higher or "lefter" than primary monitor
    • [Mouse Jump] - new feature - #23216 #23566 (comment)
  • Mouse crosshair moves when Mouse Jump moves the cursor (mouse clicks and keyboard shortcuts)
    • Mouse pointer Crosshair & Mouse Jump Issue #24523
    • [MouseJump]Also simulate mouse input event #24527
  • Activating when the preview window is already visible moves the form to the new mouse position
  • Number and key shortcuts (1-9, Home / End, Left / Right Arrow) jump to the appropriate monitor
  • Number-pad shortcuts (1-9 jump to the appropriate monitor
• Settings tests
  • Changing thumbnail size settings updates the size of the thumbnail
  • Changing preview type between Compact, Bezelled and Custom shows the correct preview type
  • Changing custom preview settings shows the correct settings
  • Launching with settings version 1.0 upgrades settings to version 1.1, with "Bezelled" as the default style and the "Custom" settings preconfigured to match "Bezelled"
• Lifecycle tests
  • Starting PowerToys Runner launches MouseJumpUI.exe when enabled, and not when disabled
  • Enabling / disabling Mouse Jump in settings starts / stops MouseJumpUI.exe
  • Exiting PowerToys Runner stops MouseJumpUI.exe
  • Killing runner exe via Task Manager stops MouseJumpUI.exe
  • Stopping Visual Studio local debug run stops MouseJumpUI.exe
    • note - runner needs to be in non-admin mode otherwise Visual Studio debugger disconnects at launch
  • Hotkey and size settings are automatically reloaded when config file is modified from Settings UI
  • Hotkey and size settings are automatically reloaded when config file is modified manually (e.g. in notepad) while runner and MouseJumpUI.exe are running
• Internal Test Suite
  • Enable Mouse Jump. Then:
  • Press the activation shortcut and verify the screens preview appears.
  • Change activation shortcut and verify that new shortcut triggers Mouse Jump.
  • Click around the screen preview and ensure that mouse cursor jumped to clicked location.
  • Reorder screens in Display settings and confirm that Mouse Jump reflects the change and still works correctly.
  • Change scaling of screens and confirm that Mouse Jump still works correctly.
  • Unplug additional monitors and confirm that Mouse Jump still works correctly.
  • Disable Mouse Jump and verify that the module is not activated when you press the activation shortcut.

[mikeclayton]

I think this PR is ready for review now - I still need to do the full set of regression tests but the happy path works fine.

There's some notes for reviewers in the original post at the top.

[jaimecbernardo]

Hi, just merged main to check with .NET 9 :) I'll review this PR soon.

[jaimecbernardo]

Windows.UI.Xaml.Printing doesn't seem to be used anywhere, but it's giving an analyzer error. Removing it.

[jaimecbernardo]

LGTM! Not sure about having Settings Lib now depend on MouseJump Common, but I think it should be pretty fine and not blocking on it.
Now the default has bezels, which I guess will be a fun way for users to find out this new feature :) But it's pretty easy to just go into Settings and switch it back to compact. Pretty OK with that too.
Tested it and tested upgrade, it's looking good.
Thank you for the contribution!

[mikeclayton]

I guess there's an overhead in that any future changes to MouseJump.Common will require at least superficial testing of the Settings UI now, but it was the only way I could come up with to get the graphical preview working, and that felt like it was a useful addition to the settings controls (although I guess you could change a setting, activate mouse jump to see the effect, then rinse and repeat, and maybe that would have been enough :-)...)