[MouseUtils] Implement MouseScrollRemap for horizontal scrolling (Fixes #44137)

[navuxneeth]

Summary of the Pull Request

This PR implements a new PowerToys module, MouseScrollRemap, which addresses the inconsistency in horizontal scrolling behavior between different applications.

Many applications (Chrome, JetBrains, GIMP) use Shift + MouseWheel for horizontal scrolling, while Microsoft Office applications (Word, Excel) require Shift + Ctrl + MouseWheel. This module introduces a global utility that intercepts Shift + MouseWheel and injects the necessary Ctrl key event to ensure consistent horizontal scrolling across the OS, specifically targeting the Office suite behavior.

PR Checklist

• Closes: Shift + mousewheel to horizonal scroll #44137
• Communication: I've discussed this with core contributors already. If the 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
• Dev docs: Added/updated
• New binaries: Added on the required places
  • 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: Documentation added to module folder.

Detailed Description of the Pull Request / Additional comments

Implementation Details:

• Created a new C++ module src/modules/MouseUtils/MouseScrollRemap.
• Implemented a low-level mouse hook that monitors mouse wheel events.
• Logic: When Shift is pressed (and Ctrl is not), the hook intercepts the scroll event and injects a Ctrl key press + Mouse Wheel + Ctrl key release sequence.
• Includes proper ETW telemetry tracing and error handling.
• Integrated into the PowerToys runner module list and solution file.

Security:

• A SECURITY_REVIEW.md has been included in the module folder.
• The hook is designed to be lightweight and only active when the module is enabled.

Validation Steps Performed

⚠️ Note to Maintainers regarding Testing:
Due to current environment limitations, I was unable to compile and run the full PowerToys solution locally to verify the runtime behavior.

However, the code has been implemented following PowerToys coding standards and C++ best practices. I have provided a detailed IMPLEMENTATION_SUMMARY.md in the codebase with a proposed test plan for the maintainer who picks this up.

Proposed Verification Steps:

1. Build solution with Visual Studio 2022.
2. Enable "MouseScrollRemap" in PowerToys settings.
3. Open Microsoft Excel or Word.
4. Hold Shift and scroll the mouse wheel (ensure the sheet scrolls horizontally).
5. Verify that standard Shift + Scroll behavior in Chrome is not negatively impacted.

[microsoft-github-policy-service]

@navuxneeth please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.

@microsoft-github-policy-service agree [company="{your company}"]

Options:

• (default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.

@microsoft-github-policy-service agree

• (when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.

@microsoft-github-policy-service agree company="Microsoft"

Contributor License Agreement

Contribution License Agreement

This Contribution License Agreement (“Agreement”) is agreed to by the party signing below (“You”),
and conveys certain license rights to Microsoft Corporation and its affiliates (“Microsoft”) for Your
contributions to Microsoft open source projects. This Agreement is effective as of the latest signature
date below.

1. Definitions.
   “Code” means the computer software code, whether in human-readable or machine-executable form,
   that is delivered by You to Microsoft under this Agreement.
   “Project” means any of the projects owned or managed by Microsoft and offered under a license
   approved by the Open Source Initiative (www.opensource.org).
   “Submit” is the act of uploading, submitting, transmitting, or distributing code or other content to any
   Project, including but not limited to communication on electronic mailing lists, source code control
   systems, and issue tracking systems that are managed by, or on behalf of, the Project for the purpose of
   discussing and improving that Project, but excluding communication that is conspicuously marked or
   otherwise designated in writing by You as “Not a Submission.”
   “Submission” means the Code and any other copyrightable material Submitted by You, including any
   associated comments and documentation.
2. Your Submission. You must agree to the terms of this Agreement before making a Submission to any
   Project. This Agreement covers any and all Submissions that You, now or in the future (except as
   described in Section 4 below), Submit to any Project.
3. Originality of Work. You represent that each of Your Submissions is entirely Your original work.
   Should You wish to Submit materials that are not Your original work, You may Submit them separately
   to the Project if You (a) retain all copyright and license information that was in the materials as You
   received them, (b) in the description accompanying Your Submission, include the phrase “Submission
   containing materials of a third party:” followed by the names of the third party and any licenses or other
   restrictions of which You are aware, and (c) follow any other instructions in the Project’s written
   guidelines concerning Submissions.
4. Your Employer. References to “employer” in this Agreement include Your employer or anyone else
   for whom You are acting in making Your Submission, e.g. as a contractor, vendor, or agent. If Your
   Submission is made in the course of Your work for an employer or Your employer has intellectual
   property rights in Your Submission by contract or applicable law, You must secure permission from Your
   employer to make the Submission before signing this Agreement. In that case, the term “You” in this
   Agreement will refer to You and the employer collectively. If You change employers in the future and
   desire to Submit additional Submissions for the new employer, then You agree to sign a new Agreement
   and secure permission from the new employer before Submitting those Submissions.
5. Licenses.

• Copyright License. You grant Microsoft, and those who receive the Submission directly or
  indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license in the
  Submission to reproduce, prepare derivative works of, publicly display, publicly perform, and distribute
  the Submission and such derivative works, and to sublicense any or all of the foregoing rights to third
  parties.
• Patent License. You grant Microsoft, and those who receive the Submission directly or
  indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license under
  Your patent claims that are necessarily infringed by the Submission or the combination of the
  Submission with the Project to which it was Submitted to make, have made, use, offer to sell, sell and
  import or otherwise dispose of the Submission alone or with the Project.
• Other Rights Reserved. Each party reserves all rights not expressly granted in this Agreement.
  No additional licenses or rights whatsoever (including, without limitation, any implied licenses) are
  granted by implication, exhaustion, estoppel or otherwise.

6. Representations and Warranties. You represent that You are legally entitled to grant the above
   licenses. You represent that each of Your Submissions is entirely Your original work (except as You may
   have disclosed under Section 3). You represent that You have secured permission from Your employer to
   make the Submission in cases where Your Submission is made in the course of Your work for Your
   employer or Your employer has intellectual property rights in Your Submission by contract or applicable
   law. If You are signing this Agreement on behalf of Your employer, You represent and warrant that You
   have the necessary authority to bind the listed employer to the obligations contained in this Agreement.
   You are not expected to provide support for Your Submission, unless You choose to do so. UNLESS
   REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING, AND EXCEPT FOR THE WARRANTIES
   EXPRESSLY STATED IN SECTIONS 3, 4, AND 6, THE SUBMISSION PROVIDED UNDER THIS AGREEMENT IS
   PROVIDED WITHOUT WARRANTY OF ANY KIND, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY OF
   NONINFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
7. Notice to Microsoft. You agree to notify Microsoft in writing of any facts or circumstances of which
   You later become aware that would make Your representations in this Agreement inaccurate in any
   respect.
8. Information about Submissions. You agree that contributions to Projects and information about
   contributions may be maintained indefinitely and disclosed publicly, including Your name and other
   information that You submit with Your Submission.
9. Governing Law/Jurisdiction. This Agreement is governed by the laws of the State of Washington, and
   the parties consent to exclusive jurisdiction and venue in the federal courts sitting in King County,
   Washington, unless no federal subject matter jurisdiction exists, in which case the parties consent to
   exclusive jurisdiction and venue in the Superior Court of King County, Washington. The parties waive all
   defenses of lack of personal jurisdiction and forum non-conveniens.
10. Entire Agreement/Assignment. This Agreement is the entire agreement between the parties, and
    supersedes any and all prior agreements, understandings or communications, written or oral, between
    the parties relating to the subject matter hereof. This Agreement may be assigned by Microsoft.

[Copilot]

Pull request overview

This PR implements a new PowerToys module called MouseScrollRemap that provides consistent horizontal scrolling behavior across applications by remapping Shift + MouseWheel to Shift + Ctrl + MouseWheel. Additionally, it adds a "Reset to Defaults" feature to the PowerToys settings UI that allows users to restore all settings to their default values.

Key Changes

• New C++ module implementing a low-level mouse hook to intercept scroll events when Shift is pressed (without Ctrl) and inject the Ctrl key to ensure Office-style horizontal scrolling works system-wide
• Settings UI enhancements with a "Reset to Defaults" button that deletes all settings files and restarts PowerToys
• Integration of the new module into the PowerToys runner, solution file, and documentation

Reviewed changes

Copilot reviewed 23 out of 23 changed files in this pull request and generated 4 comments.

Show a summary per file

File	Description
src/modules/MouseUtils/MouseScrollRemap/*	New module implementation with mouse hook, telemetry, resources, and project configuration
src/runner/main.cpp	Added MouseScrollRemap DLL to the module loading list
src/common/logger/logger_settings.h	Added logger name for the new module
src/settings-ui/Settings.UI/ViewModels/GeneralViewModel.cs	Added Reset to Defaults button handler
src/settings-ui/Settings.UI.Library/SettingsBackupAndRestoreUtils.cs	Implemented reset functionality to delete settings files
src/settings-ui/Settings.UI/Strings/en-us/Resources.resw	Added localization strings for reset feature
src/settings-ui/Settings.UI/SettingsXAML/Views/GeneralPage.xaml	Added Reset to Defaults button to UI
doc/devdocs/modules/mouseutils/readme.md	Updated documentation to include the new module
PowerToys.slnx	Added MouseScrollRemap project to solution
IMPLEMENTATION_SUMMARY.md	Comprehensive implementation documentation and testing guide

Comments suppressed due to low confidence (1)

src/settings-ui/Settings.UI.Library/SettingsBackupAndRestoreUtils.cs:1

• The doc comment is incomplete and imprecise. It should fully describe what the method does (deletes settings files to restore defaults) rather than describing it as 'mostly a wrapper' which is confusing since it's calling an instance method of the same class.

// Copyright (c) Microsoft Corporation

[Copilot]

The logger is initialized in the constructor which could be called multiple times if the module is created multiple times. Consider moving logger initialization to DLL_PROCESS_ATTACH in DllMain to ensure it's only initialized once per process.

[Copilot]

GetAsyncKeyState can return stale state if called from a hook callback. Consider using GetKeyState instead, which returns the key state at the time the message was posted to the message queue, providing more accurate results for hook procedures.

Suggested change

	bool shiftPressed = (GetAsyncKeyState(VK_SHIFT) & 0x8000) != 0;
	bool ctrlPressed = (GetAsyncKeyState(VK_CONTROL) & 0x8000) != 0;
	bool shiftPressed = (GetKeyState(VK_SHIFT) & 0x8000) != 0;
	bool ctrlPressed = (GetKeyState(VK_CONTROL) & 0x8000) != 0;

[Copilot]

Consider setting dwExtraInfo to a unique marker value (e.g., using GetMessageExtraInfo() or a custom constant) to distinguish injected events from real user input. This allows the hook to ignore its own injected events and prevents potential infinite loops.

[Copilot]

The build command references .\tools\build\build.ps1 from within the MouseScrollRemap directory, but this script likely doesn't exist at that path. The build commands should be corrected to reflect the actual PowerToys build process.

Suggested change

	cd src\modules\MouseUtils\MouseScrollRemap
	.\tools\build\build.ps1
	# Build just the MouseScrollRemap project:
	.\tools\build\build.ps1 -projects src\modules\MouseUtils\MouseScrollRemap\MouseScrollRemap.vcxproj

[github-actions]

@check-spelling-bot Report

🔴 Please review

See the 📂 files view, the 📜action log, or 📝 job summary for details.

Unrecognized words (3)

MOUSESCROLLREMAP
MSSR
RSSM

These words are not needed and should be removed

CLITo CVS Notavailable toolgood

To accept these unrecognized words as correct and remove the previously acknowledged and now absent words, you could run the following commands

... in a clone of the git@github.com:navuxneeth/PowerToys.git repository
on the main branch (ℹ️ how do I use this?):

curl -s -S -L 'https://raw.githubusercontent.com/check-spelling/check-spelling/c635c2f3f714eec2fcf27b643a1919b9a811ef2e/apply.pl' |
perl - 'https://github.com/microsoft/PowerToys/actions/runs/20017574962/attempts/1' &&
git commit -m 'Update check-spelling metadata'

If the flagged items are 🤯 false positives

If items relate to a ...

• binary file (or some other file you wouldn't want to check at all).

  Please add a file path to the excludes.txt file matching the containing file.

  File paths are Perl 5 Regular Expressions - you can test yours before committing to verify it will match your files.

  ^ refers to the file's path from the root of the repository, so ^README\.md$ would exclude README.md (on whichever branch you're using).

• well-formed pattern.

  If you can write a pattern that would match it,
  try adding it to the patterns.txt file.

  Patterns are Perl 5 Regular Expressions - you can test yours before committing to verify it will match your lines.

  Note that patterns can't match multiline strings.

[Copilot]

Pull request overview

Copilot reviewed 23 out of 23 changed files in this pull request and generated 5 comments.

[Copilot]

MODULE_NAME should be declared before its first usage on line 21, or LoggerHelpers::init_logger should use a string literal instead.

[Copilot]

GetKeyState checks the key state when the message was retrieved from the message queue, not the current state. Use GetAsyncKeyState for real-time key state checking in a hook procedure, as documented in the Windows API. The README mentions GetAsyncKeyState but the code uses GetKeyState.

Suggested change

	bool shiftPressed = (GetKeyState(VK_SHIFT) & 0x8000) != 0;
	bool ctrlPressed = (GetKeyState(VK_CONTROL) & 0x8000) != 0;
	bool shiftPressed = (GetAsyncKeyState(VK_SHIFT) & 0x8000) != 0;
	bool ctrlPressed = (GetAsyncKeyState(VK_CONTROL) & 0x8000) != 0;

[Copilot]

Documentation states GetAsyncKeyState is used for key detection, but the actual implementation in dllmain.cpp uses GetKeyState. Update documentation to match implementation or fix the implementation to use GetAsyncKeyState.

Suggested change

	- **Key Detection**: Uses GetAsyncKeyState to check for Shift and Ctrl keys
	- **Key Detection**: Uses GetKeyState to check for Shift and Ctrl keys

[Copilot]

Security review mentions GetAsyncKeyState but the implementation uses GetKeyState. This documentation should be updated to reflect the actual API being used.

Suggested change

	- GetAsyncKeyState used appropriately for modifier key detection
	- GetKeyState used appropriately for modifier key detection

[Copilot]

Documentation incorrectly states GetAsyncKeyState is used for modifier key detection. The implementation uses GetKeyState. Update documentation to match the actual implementation.

Suggested change

	3. **Modifier Key Check**: Uses GetAsyncKeyState to detect if Shift is pressed but Ctrl is not
	3. **Modifier Key Check**: Uses GetKeyState to detect if Shift is pressed but Ctrl is not

[zadjii-msft]

@navuxneeth Have you compiled and tested this?

[navuxneeth]

@navuxneeth Have you compiled and tested this?

Hey @zadjii-msft, I am currently testing and reworking on the files. I will post another PR for review once I'm done.

[DHowett]

@navuxneeth Have you compiled and tested this?

Hey @zadjii-msft, I am currently testing and reworking on the files. I will post another PR for review once I'm done.

You can update this pull request without making another one :)