* Removing Read Only
Based off the comments and how the app is being see in the early reports, this check box will just add confusion, so I've pulled it from the UX and screenshots.
* Update MainWindow.xaml
Fixing tab order
* Add per user installer
* Separate upgrade codes for per machine and per user installation
Move per machine check to bootstrapper
Move all defines to common.wxs
Fix CI
* Update installer/PowerToysSetup/generateFileList.ps1
Co-authored-by: Jeremy Sinclair <4016293+snickler@users.noreply.github.com>
* Update installer/PowerToysSetup/generateAllFileComponents.ps1
Co-authored-by: Jeremy Sinclair <4016293+snickler@users.noreply.github.com>
* Update installer/PowerToysSetup/generateFileList.ps1
Co-authored-by: Jeremy Sinclair <4016293+snickler@users.noreply.github.com>
* expect.txt
* Revert "Update installer/PowerToysSetup/generateFileList.ps1"
This reverts commit 34545dab9c.
* Update release CI to build both installers
* Revert bundle name change
It messes up app ID for per-user installation which ends up breaking winget update
of the per-user PT
* spellcheck
* Fix bad merge
* Add RegistryPreview
* Include backup_restore_settings.json
* Revert testing endpoint change
* Add per-machine/per-user installation GPOs
* Update doc/gpo/README.md
* Update doc/gpo/README.md
* spellcheck
* Remove disable per-machine policy
* Update doc/gpo/README.md
Co-authored-by: Heiko <61519853+htcfreek@users.noreply.github.com>
---------
Co-authored-by: Jeremy Sinclair <4016293+snickler@users.noreply.github.com>
Co-authored-by: Heiko <61519853+htcfreek@users.noreply.github.com>
* Add per user installer
* Separate upgrade codes for per machine and per user installation
Move per machine check to bootstrapper
Move all defines to common.wxs
Fix CI
* Update installer/PowerToysSetup/generateFileList.ps1
Co-authored-by: Jeremy Sinclair <4016293+snickler@users.noreply.github.com>
* Update installer/PowerToysSetup/generateAllFileComponents.ps1
Co-authored-by: Jeremy Sinclair <4016293+snickler@users.noreply.github.com>
* Update installer/PowerToysSetup/generateFileList.ps1
Co-authored-by: Jeremy Sinclair <4016293+snickler@users.noreply.github.com>
* expect.txt
* Revert "Update installer/PowerToysSetup/generateFileList.ps1"
This reverts commit 34545dab9c.
* Update release CI to build both installers
* Revert bundle name change
It messes up app ID for per-user installation which ends up breaking winget update
of the per-user PT
* spellcheck
* Fix bad merge
* Add RegistryPreview
* Include backup_restore_settings.json
* Revert testing endpoint change
---------
Co-authored-by: Jeremy Sinclair <4016293+snickler@users.noreply.github.com>
* enable the functionality to have filename-compatible date & time
* fix PowerToys.sln
* fix DateTime format
* remove unrelated code
* modify date time format
* fix tests
* fix hours to 24h format and modify tests to cover the case better. Simplify tests slightly
* Initial src for Registry Preview
Initial collection of files
* Update MainWindow.Utilities.cs
fixing a few spelling items
* Update expect.txt
* Update App.xaml.cs
* Update MainWindow.Events.cs
* Update MainWindow.Utilities.cs
* Update MainWindow.xaml.cs
* Update expect.txt
* Update MainWindow.Events.cs
* Rename AddPreviewtoRegfile.reg to AddPreviewToRegfile.reg
* Rename RemovePreviewtoRegfile.reg to RemovePreviewToRegfile.reg
* Update Resources.resw
* Update MainWindow.xaml
* Turns on self-contained mode
Updates the csproj file to compile the app as self-contained .
Includes fixes for code that expected the app to be in an ApplicationContainer.
Updates WindowsAppSDK from 1.1.5 to 1.2.230118.102.
* Updated to align with StyleCop errors
Multiple changes across the codebase that now aligns with StyleCop guidelines.
Tested again after the changes, to make sure no new bugs crept in.
* Added comments for spell-checker
Unclear if this side step should be done or not, but the kxz comes from a GUID and the other three names are constants.
* Adding code-custom.dic
Comments didn't work; trying a dic file
* Added four new terms to expects.txt file
Cleaning up attempt to update the spell-checker with dic file and moved it to expects.txt file
* Adding one more string
Adding one more string for Spell-Check
* Adding back egfile
Seems this is needed.
* Correcting a variable name
Seems one of the variable names that changed globally got missed in a XAML file.
* Update project to be more PowerToys friendly
Tweaking names and output file name to fit better with PowerToys.
* First pass at integration into Settings and Launcher
This PR is not as large as it seems:
- RegistryPreview's source moved around to a "better" directory that makes it look like the whole app changed. It didn't. In fact, I opened it in Beyond Compare and there's not much difference in the RegistryPreview app.
- Added RegistryPreviewExt that produces a DLL that the Launcher can run the EXE
- Changes to Runner calls the Ext DLL rather than the app
- Settings UI got a bunch of changes to enable the Settings page for enable/disable across ViewModels, Views, and string tables.
Still todo:
- Add "Preview" to .REG files, when the app is enable (and remove it when disabled)
- Update the thumbnail-screenshot in the Settings page
- Add support for OOBE
* Update expect.txt
Added REGISTRYPREVIEWEXT for recent changes and corrected an alphabetic sorting error.
* Updating project file for Release mode
Build failed due to a bad Includes path in Release mode.
* Adds REG registration but breaks settings
This update will update the HKCU branch of the Registry for REG files: if the app in PowerToys is enabled, it adds a Preview item to the context menu of REG files and disabling in PowerToys removes the menu item.
While working on this, I noticed that the application settings were broken, after moving to a self-contained EXE: there must have been old settings from past builds, when it was still using containers and family names.
Added TODO's to add a new way to save settings, likely as JSON.
* Re-enabled app settings
Moved from using ApplicationDataContainer for app settings and now use simple JSON.
Also cleaned up handling the scenario where the Launcher send in the PID from PowerToys' main thread.
Fixed past spelling errors as well.
* Update RegistryPreview.png
Captured new screenshot.
* Integration into OOBE
Integrates new page for Registry Preview into OOBE process.
* Removing old comment and unneeded calls
Two bits of source removed as they aren't needed any longer
Removing a chunk of old commented out code that doesn't make sense anymore.
* Merging file from upstream
Updating some files due to three merge conflicts from upstream changes and a couple of other changes to keep up.
* Update .gitignore
Adding two vcxproj files that have local updates for atls.lib locations.
* Update Resources.resw
Fixing a typo that involved a missing closing tag.
* Fix analyzer warnings
* Fix CI build
* Fix ARM64 build
Project file cleanup
* Add to installer
* expect.txt
* Remove unneeded dll
* Update MainWindow.xaml.cs
Added check for current Theme and adjust TextBox Foreground accordingly.
* Update expect.txt
Cleaning up merge cruft.
* Revert wrong .gitignore changes
* Fix ARM installer
* Update Brushes for textBox to use Theme based versions
Finally figured out how to use the built-in, Theme-aware Brushes for the font colors in the onscreen textBox. Also have it aligning the font color for the hover state.
* Align configuration in PowerToys.sln
* [installer] Add missing files
* Fix bad merge
* Fixes for stefansjfw's review
Includes:
- two new strings for UX localization
- adds compatibility section for Windows 10
- fix to only track successful activations
- Removes two REG files that were there for examples
* Fixes from review from htcfreek
Updates:
- Fixed an issue where TextBox_TextChanged was firing when you simply opened a file.
- Added clamp to prevent files larger than 10MB from being opened.
- Added support in the UX to show Keys and Values that are deleted via the file
- Added support to specially handle Keys that start with - and Values that have =- in them (delete scenario)
- Changed AppBarButton icon for Edit from Rename to NewWindow
* Create deleted-folder32.png
* Added Registry Preview to GPO
* Update expect.txt
Updating spellchecker works
* Updating Size/Move code for better results
- Moved the size/move to the MainWindow layer
- Cleaned up the JSON settings handling to avoid an access denied on first run
* Improving text handling
Changed how special characters are parse, which helps with live entry.
* Updates to parsing and other fixes
- Renamed the value PNG for parity
- Added new error image
- Added check that values have " at start and finish.
- Added support for a new "ERROR" type for Values
- Fixed support for @ versus "@" in values
- Fixed bug where Save wasn't activating in all scernarios
* Fix signing and versioning
* Update src/settings-ui/Settings.UI/ViewModels/RegistryPreviewViewModel.cs
Co-authored-by: Heiko <61519853+htcfreek@users.noreply.github.com>
* Apply suggestions from code review
Adds Launch button to the settings page.
Co-authored-by: Heiko <61519853+htcfreek@users.noreply.github.com>
* Update Resources.resw
Adding strings for new launch button
* Adding new version for GPO
Moving to 0.69.0
* More parsing bug fixes
- Changes to look for [- instead of -[ for syntax deleting keys (fix for developer's mental hiccup)
- Moved [- to top of the decision making stack, as it needs to come before [
- Added new StripEscapedCharacters function for both sides of a Value line
- Fixed crashing bug for scenario where no Keys are parsed before a Value
* Bug fixes from most recent review.
- Dictionary will now be case insensitive when searching for keys
- Added tool tips (and strings) to the images of the Keys and Values
- Updated delete handling for Keys, so that only the leaf-most node gets marked as deleted; also stops the top most roots from being marked deleted.
* Tweaking for @=-
Forces the UX to take @=- and treat it as @="" since that's what Registry Editor would do.
* Removing unused usings
* Updates app description
* Update src/gpo/assets/PowerToys.admx
Co-authored-by: Heiko <61519853+htcfreek@users.noreply.github.com>
* cleanup proj file
launch process only if module is enabled
add process to bugreport process list
* Add context menu icon
* Update src/modules/registrypreview/RegistryPreviewUI/MainWindow.Utilities.cs
Co-authored-by: Heiko <61519853+htcfreek@users.noreply.github.com>
* Use modulesRegistry.h to apply/unapply registry changes
* Tweaked window settings
Moved the loading of the settings a little later in the initialization code, which gives more time for things to initialize.
* Update registry.h
Moving the definition out of the detail namespace to the registry name space to fix a compilation issue in RegistryPreviewExt.
* Unapply on creation
If module is disabled in settings.json, on startup reg entries should be unnaplied.
TODO: read m_enabled from settings file on creation
* Removing size/move main window
Added a TODO comment that responds to the size/position settings that are being saved out in the JSON blob on close as it doesn't always work on every PC, as the MainWindow initializes at different times.
* Change to always keep Save As active
No reason for this to be disabled, honestly.
---------
Co-authored-by: Clint Rutkas <clint@rutkas.com>
Co-authored-by: Stefan Markovic <stefan@janeasystems.com>
Co-authored-by: Heiko <61519853+htcfreek@users.noreply.github.com>
Co-authored-by: Stefan Markovic <57057282+stefansjfw@users.noreply.github.com>
* Add info that PowerToys run might get no focus when "Centralized keyboard shortcut" is used
* Fix spelling
* Update src/settings-ui/Settings.UI/Strings/en-us/Resources.resw
* Fix the issue of not being able to select an image for VCM
Camera mute while PowerToys is running elevated.
* change the buffer size for Path and filename
* move DLL import to native methods file
* Adding comment to rember to move back to WinUI3
when it is fixed
* making Dll Import methods internal
* changes from comments
* fix new c# errors
* Remove async
* [PTRun]Asynchronously load image and thumbnails
* Bring back check for Adobe PDF generated thumbnails
---------
Co-authored-by: Stefan Markovic <stefan@janeasystems.com>
* Fix ColorPicker sampling colour from the grid
Addresses #13831. The sampled pixel is now completely avoided by the grid.
Also, this should address the timing issue from the sampling being done
every 10ms, which overlaps strangely with monitor refresh rates at 16.6ms,
13.3ms, etc.
* Forgot extra library
* Revert rounding in GetPixelColor
* Ensure EnumDisplaySettingsW returns true
Assigning refreshRate only if EnumDisplaySettingsW returns true,
otherwise defaulting to 60.0Hz.
* Run spellchecker
* Spellcheck again
---------
Co-authored-by: Stefan Markovic <stefan@janeasystems.com>
* Check if the result from find item returns a valid item
and repopulate ExplorerItems()
* Call all the clean and populate methods only
when showRenamed is checked.
* Initial scaffolding for expiration configuration
* Simplifying the code and adding support for expiration events
* Bit more cleanup
* Initial support for expirable keep-awake
* Update some of the threading logic
* Logging and timing consistency
* Initial UI scaffolding
* Fix pathing issue for the icon when using config file
* Add missing definitions
* Update with basic interface
* Cleanup redundant calls
* Update name per convention
* Simplify declaration
* Proper binding to secondary Time property
* Cleanup the terminology use
* Standardize naming conventions.
* More Awake cleanup
* Ability to update the UI when the tray icon updates
* Small tweaks before ViewModel refactor
* Refactor the view model logic
* Some consistency fixes
* Remove the build props change
* Add settings scaffolding when a file does not exist
* Update expect.txt
* Fix typos
* Update build in logs
* Updating based on discussion in #24183.
This specifically addresses the fact that the `ExpirationDateTime` property was incorrectly auto-initialized to `DateTime.MinValue` when it should've been set to `DateTimeOffset.MinValue` to be consistent with the underlying type and assumptions around date/time.
---------
Co-authored-by: Clint Rutkas <clint@rutkas.com>
* Turn on warning 26497
This function function-name could be marked constexpr if compile-time evaluation is desired.
* C++20 has constexpr swap
* as constexpr is not only for compile time,
make all functions that can be constexpr constexpr
* constexpr functions are implicity inline
* Init
* Fix running settings
* UI design
* Left click trigger
Wire up colorpicker and pt run
* Wire up others
* Update FlyoutWindow.xaml.cs
* Removed comments
* Update FlyoutWindow.xaml
* More work
* Open Settings page
* More UI work
* Resolve conflicts
* [General] SystemTray Flyout: Add update on tray items' visibility when module gets enabled/disabled
Also remove context menu opening on tray icon.
* Adding app list
* Adding more buttons, resolving conflicts
* [General] Flyout: improving opening, closing flyout/settings window. Implementing basic bahaviour on enabling/disabling modules.
* [General] FlyoutWindow: proceed with implementation. GPO works. Main functionallity works (launching and enabling apps).
* [general] flyout: fix exit button
* [general] flyout: implement double click handling
* Localization
* [Generel] Flyout: Re-implement flyout launching, add workaround: disable flyout hiding in case the user switches on modules on the all apps page
+ minor changes
* [general] flyout: restore the context menu when right clicking on system tray icon
* Fix spellchecker
* [installer] fixing missing dll files + suppress error on not signed script
* Fix spell checker
* Fix flyout not focusing when activated
* Refresh Settings UI enabled state when flyout changes
* fix spellcheck
* Remove VCM from the list
* [General] flyout: fix settings window opening. Switch to general page only if there is no page opened
* [general] flyout: add launching hosts app
* Fix CI build
* adding check on elevation when launching hosts
* Use localization strings that already exist
* Remove dll not present in arm64 build
* Adding GPO policy check for the launcher page items
* fix hosts launching
* Add telemetry
* Also hide from all apps list when gpo is force enabling
* fix spellchecker
* Improve focus issues
* Fix flickering Bitmap Icons
* Fix telemetry error
* Fix telemetry call
* Fix wrong comment
---------
Co-authored-by: Stefan Markovic <stefan@janeasystems.com>
Co-authored-by: Laszlo Nemeth <laszlo.nemeth.hu@gmail.com>
Co-authored-by: Jaime Bernardo <jaime@janeasystems.com>
* Update parseRuntimes to use separate JSON for .NET Runtime / WPF
* Update parseRuntimes script to filter duplicate dlls from WPF Runtime List
* Fix spelling
* Override dlls
---------
Co-authored-by: Stefan Markovic <stefan@janeasystems.com>
* Added PowerShell script for parsing .NET Runtimes from deps.json
* Removed static list set of .NET Runtime and WPF file list
* Updated DepsFilesLists to write output. Moved to CustomActions directory
* Added space between runtime files variables
* Fix Parameter and Set-Content invocation
* Added PreBuild event to call parseRuntimes script
* Update spelling
* Removed runtime files from Product.wxs
* Updated script to add support for Product.wxs
* Modify process to create copies of unmodified files and restore them on post build.
* Fix spacing
* Fix spelling
* Updated script to create new Guid for Dotnet component
* Fix invalid regex
* Remove reverting Product.wxs in Custom Actions project
* Add Post Build Action in Installer to revert Product.wxs
* Set Post Build Event to run always on Installer
* Fix path to Product.wxs in Post Build Event
* Final fix to Product.wxs path
* Switch to use powershell.exe and read from ColorPicker directory.
* wip: fix release pipeline
* remove conditions for build events in PowerToysInstaller.wixproj
* System.Text.Json.dll
* System.CodeDom.dll
* System.Management.dll
* WindowsBase.dll
* Other
Co-authored-by: Jeremy Sinclair <4016293+snickler@users.noreply.github.com>
* Added PowerShell script for parsing .NET Runtimes from deps.json
* Removed static list set of .NET Runtime and WPF file list
* Updated DepsFilesLists to write output. Moved to CustomActions directory
* Added space between runtime files variables
* Fix Parameter and Set-Content invocation
* Added PreBuild event to call parseRuntimes script
* Update spelling
* Removed runtime files from Product.wxs
* Updated script to add support for Product.wxs
* Modify process to create copies of unmodified files and restore them on post build.
* Fix spacing
* Fix spelling
* Updated script to create new Guid for Dotnet component
* Fix invalid regex
* Remove reverting Product.wxs in Custom Actions project
* Add Post Build Action in Installer to revert Product.wxs
* Set Post Build Event to run always on Installer
* Fix path to Product.wxs in Post Build Event
* Final fix to Product.wxs path
* Switch to use powershell.exe and read from ColorPicker directory.
* wip: fix release pipeline
* remove conditions for build events in PowerToysInstaller.wixproj
* Create verifyNoticeMdAgainstNugetPackages.ps1
* Update build-powertoys-steps.yml
* Update verifyNoticeMdAgainstNugetPackages.ps1
* Update verifyNoticeMdAgainstNugetPackages.ps1
* Update build-powertoys-steps.yml
* Update build-powertoys-steps.yml
* Update NOTICE.md
* Update NOTICE.md
* Update NOTICE.md
* Update verifyNoticeMdAgainstNugetPackages.ps1
* Update verifyNoticeMdAgainstNugetPackages.ps1
* adding back in the Community Toolkit items
weird, some how there was a checkin with this being removed
* Update .pipelines/verifyNoticeMdAgainstNugetPackages.ps1
Co-authored-by: Jeremy Sinclair <4016293+snickler@users.noreply.github.com>
* Update .pipelines/verifyNoticeMdAgainstNugetPackages.ps1
Co-authored-by: Jeremy Sinclair <4016293+snickler@users.noreply.github.com>
* Update .pipelines/verifyNoticeMdAgainstNugetPackages.ps1
Co-authored-by: Jeremy Sinclair <4016293+snickler@users.noreply.github.com>
* Update .pipelines/verifyNoticeMdAgainstNugetPackages.ps1
Co-authored-by: Jeremy Sinclair <4016293+snickler@users.noreply.github.com>
* shifting the restore for setup back to where it was plus moving the verification to end.
* moved wrong powershell, fliping back
Co-authored-by: Jeremy Sinclair <4016293+snickler@users.noreply.github.com>
* [Quick Accent] add toggle switch to sort characters by usage frequency
* [Quick Accent] if enabled, then sort by frequency for all toolbar triggers
* [Quick Accent] add "start selection from the left" toggle switch
* [Quick Accent] fix error SA1000: The keyword 'new' should not be followed by a space
* Fix C# analyzer build error
* [TextExtractor] Extend settings with preferred language
* TextExtractor simplifying code, adding update languages on dropdown opening
* fix typo
* TextExtractor fixing bug with order of languages
- Previously there was a mixture of `1.` `1.` `1.` ... and `1.` `2.` `3.` ... indexing in the readme doc which is changed to a uniform use of `1.` `1.` `1.` ....
- There were errors in numbering at 2 places which get fixed by this.
* [ColorPicker] Restructure to have color names localized
* [ColorPicker] Restrucure code to have localised color names
* Fix analyzer errors
* [ColorPicker] add comments
* Remove unused Newtonsoft.Json package references
Replace with System.Text.Json in Settings test
* spellcheck
* Remove obsolete test
* Revert settings part
* Revert "Revert settings part"
This reverts commit ad2934ce0b.
* Increase JS heap size in CI
* Custom color format tweaks
* Delete vs. remove
* Update expect.txt
* [ColorPicker]Support BGR and RGB decimal value formats (#22771)
* ColorPicker add both decimal value formats
* ColorPicker, custom format dialog, resizing columns
* Custom color format tweaks
* Delete vs. remove
* Update expect.txt
* Fix rebase
* Fix error
* [Quick Accent] fix showing toolbar in the corner position
* [Quick Accent] set horizontal allignment according to toolbar position
* [Quick Accent] fix spelling mistake
C++ code analysis is a heavy process, which we are running in the PR CIs already, so code that gets into main should be checked already.
This PR conditionally removes C++ code analysis from the release pipelines. This saves 10-15 minutes in build time.
## Validation Steps Performed
Verified the release CI shaved some time off.
* ColorPicker fix format name duplicates
* ColorPicker: extend settings-loading with security code which skips color formats with empty name or duplicate names
* Spell checker fix, typo, sorry
* fix error blanks in japanese OCR
Kanji ,Hiragana, Katakana, Hankaku-Katakana do not need blank. (not only the range of CJKUnifiedIdeographs). Maybe there are more symbols that don't require spaces like \u3001 \u3002. But give it to ocr engine to improve may be a better choice ?
* Update ImageMethods.cs
fixing spelling
* Update expect.txt
adding in Hankaku
* Update ImageMethods.cs
* [PTRun] Support drag&drop to other application for files in result list
* [PTRun] use file/folder thumbnail as drag image
* (fix spellcheck)
* [PTRun] use _mouseDownResultViewModel.Image to generate the drag image
* fix spelling + refactoring
* ColorPicker fixing 'old' formats still represented in the old pre-defined format in color picker module.
* Fixing color picker tests, adding format strings
* ColorPicker fixing problem settings not sent to CP module (when newly created formats change)
* ColorPicker fixing problem Move Up button diabled for the 2nd element of the color formats list after creating a new color format.
* [Quick Accent] fix showing selector window
* Update layout before using size to calculate position
* Correct offset issues due to margin
* Up the offset to 24, as the margin value removed
* [ColorPicker] Development: custom color formats, first steps
* ColorPicker development of custom format handling.
* Custom color format developmnet.
Added common helper class for format string
Fixed settings loading
Added numbering if default name exists (My format (1))
* Custom color format implementation.
Extended the colorPicker settings with the format string
Updated the color to string conversion
* Custom color format in color picker, development.
Adding edit, delete buttons. Implement functionality
Re-arranging settings panel (newly created formats at the top)
Implementing details (valid parameters, more format elements, more types)
* Minor commit
* Development color picker custom formats. "Last" steps.
Replacing hard coded english strings with resources, polishing.
* Adding help to the format edit dialog.
* Undoing changes unwillingly commited in Host module
* Fixing bug unable to delete a custom format after renaming it - use the colorformat object as reference (and not the name)
Modifying the default custom formula
Removing unnecessary using directives
* Udating the default user defined color format
* Removing unnecessary using directive
* ColorPicker Implementing custom color formats: adding custom formats to the default format selection (dropdown box).
* Fix binding of name and example
* Custom color formats, implemented steps:
vorwarts compatibility loading settings.
Fixed UI as requested (removed one settings panel, added button to the first panel)
* Minor change in the UI: description modified
* ColorPicker Custom Color Formats develepoment.
Added conversion from old predefined formats to customizable formats.
Extended default settings (in case settings file is deleted/corrupted).
Minor fixes.
* Fixing color format parameters.
Implementing 3 different Saturation calculations, 2 Hue calculations and 2 Lightness calculations (depending color format)
* Color Picker: New/Edit Color format. Fixing bug when cancelling addition/edit
* ColorPicker. Updating help section, available parameters
* Fix spellchecker
* Remove the MinWidth so that scrollviewers can be drawn
* ColorPicker bugfix: Not allowing to delete the last color format.
* Adding unicode names and adjusting UI (WIP)
* Added changing letter names
* Add optioins to hide description (WIP)
* WIP
* Change to binding property
* Adress PR comments
* Set TextBlock in border
* * Added to settings
* Fixed string showing/not showing one time after switching character
* Removed unneccessairy command in SettingsService.cs
* Moved showdescription enum to settings.ui
* Adding Fluent design :)
* Fix merge errors
* Center list
* Fixed code not working. Accepted some code style changes.
* Merge main in branch #2
* [Quick Accent] support unicode description for UTF-16 surrogate pairs
* [Quick Accent] fix check-spelling-bot errors
* [check-spelling] accept LANGID as correct word
* [Quick Accent] fix delay when calling ShowToolbar for the first time
* [Quick Accent] use toggle switch to turn off/on Unicode description
* [Quick Accent] fix after merge
* [Quick Accent] add UnicodeInformation.dll to installer
Co-authored-by: Niels Laute <niels.laute@live.nl>
* Update projects to .NET 7
* Updated packages to 7.0-rc1
* [ColorPicker] Wrap WM_KEYUP param in unchecked context
* [PTRun][OneNote] Added a NoWarn to CS8981
* [MeasureTool] Wrap buffer in wstring_view in SetClipBoardToText
* Target .NET 7 for PowerToys.Interop
* Update publish profiles
* Removed System.Text.Json.dll from Product.wxs since it's included in .NET 7
* Use .NET 7 in CI
* Removed individual CodeAnalysis package from projects
* Updated CodeAnalysis package in Directory.Build.props
* Updated NuGet packages to latest 7.0 rc2
* Fix merge mistake with Settings.UI.Library project
* Updated installer with .NET 7 RC2 install
* [GPOWrapper] Updated GPOWrapperProjection to .NET 7
* [FileLockSmith] Updated to .NET 7
* [FileLocksmith] Update Interop to .NET 7
* Upgrade .NET 7 specific libraries to GA version
* [PowerToysSetup] Updated .NET 7 urls to GA
* [CI] removed .NET 7 SDK preview version from UseDotNet task
* [PowerToysSetup] Update HasDotnet variable name
* [PowerToysInterop] Downgrade target back to .NET 6
* [FileLockSmith] Downgrade Interop library back to .NET 6
* Revert "[FileLockSmith] Downgrade Interop library back to .NET 6"
This reverts commit 356ad048e3.
* Revert "[PowerToysInterop] Downgrade target back to .NET 6"
This reverts commit 74dbcfdefe.
* [Analyzers][CPP] Disable warning for 4679 caused by .NET 7 in C++/CLI
* [CI] Set maximum cpu count to 2 for PowerToys.sln build
* [CI] Set maximumCpuCount to false in hopes of arm64 working
* Changed .NET 7 runtime display name
* [ci] Use .net 7 sdk
* [release] Move NuGet feed from CDPx to DART
Since the release pipeline is run in the DART Azure DevOps project, we
no longer need to authenticate against it. The build agent will be
running with a token that allows access.
* restore nuget.config
* We should still authenticate against this org, not a specific feed
* rename the feed
* whoa whoa whoa okay
* [ci]Conditionally add labs package except in Dart (#22294)
* Propagate Jaime's change
Co-authored-by: Jaime Bernardo <jaime@janeasystems.com>
6031 - Return value ignored: 'called-function' could return unexpected value
26451 - Arithmetic overflow: Using operator 'operator' on a size-a byte value and then casting the result to a size-b byte value. Cast the value to the wider type before calling operator 'operator' to avoid overflow (io.2)
28182 - Dereferencing NULL pointer.
* correct the uid
* Remove periods and generalize "Appearance & behavior" uid
Descriptions don't need a period, unless they're full sentences.
* simplify bold text to interactive elements
the 3 changes from bold to code are for readability
* rev feet
* -1 ing
* [QuickAccent] Add catalan
* Add missing l·l symbol
and improve order
* Fix build error
* Remove trailing white space
* [QuickAccent] put Catalan language in alphabet order (#22228)
Co-authored-by: CodingNeko <codingneko@gmail.com>
* Implement the delayed rendering
* Impelement settings UI
* Rename
* Set the minimum of ShortcutGuide_PressTimeForTaskbarIconShortcuts to 100ms
* Separate the animations of the global windows shortcuts and the taskbar icon shortcuts
* Amend
* Handle the case when the shortcut guide is not activated by win key long press
* Remove .vscode
* Keep the user's original setting of the win key press time
* Revert the default press time to 900 ms
* Restore default as 900
* add croatian, netherlands, swedish & welsh
* Rename Netherlands to Dutch
* Rename Netherlands to Dutch
* Change order of Dutch
* Put in place the good iso code for Welsh & Swedish
* Add .log support to Monaco preview handler
* Revert "Add .log support to Monaco preview handler"
This reverts commit 94b6219250.
* Add .log support to Monaco preview handler
* [ci]Conditionally turn off multi tasking for arm64
* Use var expression in variables instead
* Yet another try
* Fix release CI as well
* Use proper variables on matrix
* Try non-runtime expressions for release CI
* Remove debug prints
* Analyzers CPP
Changing the warning level from 3 to 4.
change some project files to make them use the warning config in cpp props file.
* Analyzers C++ turn on warning 4706
Change Cpp.Build.props file to enable 4706
fix BugReportTool code to get rid of 4706
* Turn on warning 4100 and fix the code
* Follow c++ core guidelines
* Adapting to PR comments
* Analyzers CPP
Changing the warning level from 3 to 4.
change some project files to make them use the warning config in cpp props file.
* Analyzers C++ turn on warning 4706
Change Cpp.Build.props file to enable 4706
fix BugReportTool code to get rid of 4706
* disable 4706 for external code
* [FileLocksmith]Query system processes if elevated
* Show warning if user is a system user
* Make text in the file list selectable
* Update src/modules/FileLocksmith/FileLocksmithLibInterop/NtdllExtensions.cpp
Co-authored-by: Andrey Nekrasov <yuyoyuppe@users.noreply.github.com>
* Trim \0 no longer required
* Correct elevation detection logic
* Use theme approppriate colors
Co-authored-by: Andrey Nekrasov <yuyoyuppe@users.noreply.github.com>
* Adding icon to project
* Adding icon to Settings
* Reference the right file
* Fix icon on Windows 10
* Add new Icon files to the installer
* Fix installer.
* rename Layout -> LayoutData
* simplify zone
* split ZoneSet: Layout
* refactoring
* split ZoneSet: LayoutWindows
* update trace
* split ZoneSet: remove ZoneSet
* fix initialization
* split unit tests
* remove unused
* warning
* nullptr check
* use current rect
* update work area tests
* use current rect
* simplify
* more meaningful name
* dismiss
* safety checks
* resolve conflicts
* reassign windows after switching vd
* avoid double-processing for window on switching vd
* extend windows fix
* check if window is on current desktop before cycling
* separated extend
* not reinit layout windows
* Imported offline solution
* Make solution compile
* Add Windows sample, doesn't work?
* Added new project to implement the dll
* Remove unneeded header
* Implemented IUnknown part of ExplorerCommand
* Implemented IExplorerCommand methods
* Implemented ClassFactory
* Implemented DLL register/unregister
* Implemented other DLL exports, not working?
* Implemented IShellExtInit inferface
* Implemented IContextMenu, it works!
* Implement command data fetching
* Make sample project compile on VS 2022
* Add plan
* Implement Lib as separate project
* Implemented IPC, not tested
* Console UI project skeleton
* Implemented basic console UI
* Implemented piping, there are bugs
* Prototype works
* Remove old project
* Added GUI project skeleton
* Mitigate issue with WinUI3
* Added a control for displaying results
* Add button
* Implement core functions in lib project
* Call new library function from console main
* Implement showing results
* Improve UI
* Implemented subdirectory search
* Remove useless code
* Set window size
* UI adjustments
* Implement killing process
* Rename variable
* Add lib project to main solution
* Add Ext and GUI projects to solution
* Tweak packages for GUI project
* Add a settings page
* Add a few resource strings
* Add one more resources string
* VS keeps trying to correct this
* Add references to File Locksmith in /,github
* Implement some parts of FileLocksmithModule
* Change output directory
* Change target name and add to runner
* Add logger
* Started implementing settings backend
* Fix log folder
* Settings work
* Add some basic tracing
* Attempt at adding resources
* Remove junk files
* Added missing defines
* Replaced some constants with resources
Something's not working
* Move resources to the Ext project
* Remove experiment
* Add binaries for signing
* Improve tracing
* Remove old Settings calls
* Show something when there are no results
* Change window title
* Move computation to another thread, improve UX
* Increase font size for default text
* Remove entries for killed processes
* Show user name
* Remove nonrecursive implementation
* Implement back end for getting file names
* Show list of files, UI tweaks
* Remove useless includes
* Implement back end for getting full process path
* Dark title bar on dark themes
* Using Expander, other UI adjustments
* Show "No results" after killing all processes
* Show progress ring
* Update configuration mapping
* Revert "Update configuration mapping"
This reverts commit d8e13206f3c7de3c6dbf880299bfff3bf9f27a37.
* Fixed solution configuration, ARM64 should build
* Backend for refreshing
* Variable window size
* Add refresh button
* New WinUI3 C# project for FL
* Started porting functionality
* Add Interop project
* Move IPC to Ext project
* Ported native functions to Interop
* Ported finding processes
* Ported most of Main Window functionality
* Display paths of files
* Implement killing processes
* Use resource string for "End Task"
* Remove entries for terminated processes
* Show User name
* Set default window size
* Make the new UI the default
* Reading paths from stdin, completed port to C#
* Fix small bug
* Moving to MVVM
* Adding Labs
* Merge branch 'ivan/file-locksmith' of https://github.com/microsoft/PowerToys into ivan/file-locksmith
Removing one parent commit for cleaner history
Co-Authored-By: Niels Laute <niels.laute@live.nl>
* Reintroducing features
* Moving UI strings to resources file
* Restored functionality
* Add missing dlls
* Add FIle Locksmith to publish.cmd
* Rebase fixes
* Try updating nuget.config
* Fix copy-paste blunder
* Add File Locksmith UI for publishing
* Add .pubxml file in FileLocksmith
* Change build output folder
* Fix installer build issues
Remove old projects from solution so MSBuild doesn't build them.
Downgrade target framework to what most other projects are using.
Fix publishing profile and project runtimes.
Remove unused CsWinRT references.
* [CI] Add clear to nuget packages
* Fix module reference counting
* Fix nuget for release CI
* Fix version and signing
* Fix path for resources
* Fix incorrect results when running 2 instances
* Fix default nuget source
* Windows 10 icon and fallback for UI
* Code clean-up and spaces instead of tabs
* Add gif showcasing FL
* Add screenshot of File Locksmith for Settings
* Add new files to the installer
* Add OOBE page
* Showing selected paths in the header
* Tweak path list
* Added new, wider gif
* Add GPO
* Add some logs
* [CI]Get CommunityToolkit.Labs from BigPark feed
* [CI]Use azure package feed for Nuget in release
* [CI]Another try for the labs source
* Revert changes to feed
* Use RestoreAdditionalProjectSources
* Add tooltip to file list
* Change tooltip to not trim the lines
* Add Tips and tricks section mentioning elevated
* Add some more logs messages.
* Grammar fix
* Add to bug report tool
* Fix UI virtualization not working
* Disable virtualization to avoid crashes
* Get better virtualization
* Add dialog instead of tooltip to show list of items
* No results refresh icon is now a button too
* Use managed methods for handling processes
* Remove registry code from Ext.
* Support drives too
Co-authored-by: Niels Laute <niels.laute@live.nl>
Co-authored-by: Jaime Bernardo <jaime@janeasystems.com>
* Add GPOWrapper headers and C++/WinRT library
* Check GPO before starting utilities
* Show message on GPO having disabled preview panes.
* Don't generate thumbnails if GPO disabled
* Fix FancyZonesEditor unable to recognize GPOWrapper
* Move settings view models to the settings project
* Use GPO to block enabling utilities in Settings
* Hide context menu entries when gpo disables utilities
* Apply gpo policies when enabling PowerToys on runner
* Add version and metadata to dll
* Add GPOWrapper to the installer
* Fix MSBuild errors on WPF apps by using Projection
* Signing
* Add gpo files and publish them
* Add GPO policies to the bug report tool
* Add some documentation for using GPO
* Mention support to actual lowest supported version of Windows
* Move PowerToys to the root of administrative templates tree
* Save policies on Software\Policies\PowerToys
* Support both machine and user scopes
* Fix documentation to reference computer and user scopes
* Mention incompatibility with outlook in gpo
* Set a better folder structure for gpo assets
* Move PDF Handler warning to the description
* Update doc/gpo/README.md
Co-authored-by: Heiko <61519853+htcfreek@users.noreply.github.com>
* Add actual minimum version of PowerToys to gpo files
* Fix identation
* Remove GPOWrapper Readme
* Add Active Directory instructions to doc
Co-authored-by: Heiko <61519853+htcfreek@users.noreply.github.com>
* [QuickAccent] Added Portuguese (BR) language
* Fix- Correct indentation
* Fix - Added proper indentation to EOF
* Removed "(BR)" from text
* chore: Changed index switch to array
* Correct German and French order
Using Cpp.Build.props to setup C++ code analysis as default.
Starting with a ruleset based on Microsoft Recomended Native rules. But changing all to info. Future pull request should change a rulr from info to warning and fix the code.
* [OOBE]Fix not shortcut not updating
Fix for issue #20953.
Activation key update in the OOBE window
when the user changes it in the settings window.
Add settings repository reference to the ViewModel
constructor to use the repository settings object
(and not create a second instance of it).
* Fix for issue #20953.
Unit test fixed.
* add selection of country langages
* Add Greek and Iceland countries
* Update src/modules/poweraccent/PowerAccent.Core/PowerAccent.Core.csproj
* fix ß in all section
* remove greek
* improve UI
* langage to language
* remove GR reference
* change 'All' to 'All available'
* adding Romanian and Hungarian
* Missing characters
* Add Italian
* Fix translation key
Remove GameMode activation
* Fix PR build issues
* Callback to get if a letter is part of the language
* Add additional dlls to installer
* Fix new dlls signing
* Fix spelling
* Add description to language selection
Co-authored-by: Damien LEROY <dleroy@veepee.com>
* Wrap Quick Accent toolbar selection
Wraps _selectionIndex at beginning and end of range.
* Holding Shift + Space moves _selectedIndex backwards
Moves toolbar selection from right to left when Shift key is held.
* Fix formatting and typos
* Change EOL of files to LF
Changes PowerAccent.cs and WindowFunctions.cs back from CRLF to LF
* Rename IsCapitalState() to IsCapsLockState()
* Correct Logical Mistake (&& -> ||)
* Removed backward movement when holding Shift
* [ContextMenu Packages] Prefix identity and app id with Microsoft.PowerToys
* TEST: Set packages versions
* Fix packages version format
* Update display name
* Improve the icon shown for app execution aliases.
* Reverse validation check.
Resolve issue with null paths
* Improve to utilise app execution alias reparse point.
* Improve to utilise app execution alias reparse point.
Co-authored-by: Mike Barker <mibarker@microsoft.com>
* Removed prefix
Quick deletion. Quick run in VS gave no problems.
* Removed prefix
Quick deletion. Quick run in VS gave no problems.
* update for new files
* Remove using muxc includes
* [Awake] Don't use Process.Exit and move to CsWin32
* [PowerLauncher] Remove unused API
* [ColorPicker] Use cancellable NativeEventWaiter + cleanup using
* [TextExtractor] Don't use Environment.Exit
* [MeasureTool] Don't use Environment.Exit(0);
* [FZE] don't use Environment.Exit and fix WaitForPowerToysRunner
* [Screen Ruler] add 7% opacity to tooltip background
* [Screen Ruler] restrict mouse cursor to monitor while in bounds mode
* [Screen Ruler] Do not preview overlay ui on all virtual desktops (Win + tab)
* [Screen Ruler] add hotkeys for toolbar #20345
* [Screen Ruler] Make single snapshot capture mode a default and update warning
* [Screen Ruler] Fix touch input in bounds mode #20286
* [Screen Ruler] activate window and set HWND_TOPMOST flag again after initialization
* [Screen Ruler] simplify lines calculation
* [Screen Ruler] Add inches and centimeters support
* [Chore] prefer x64 toolset to avoid hitting C1076
* [Screen Ruler] Allow making screenshots in non-continuous mode
* [Screen Ruler] Use single d3d device for all ops
* [Screen Ruler] remove gpu mutex and clean up screen capturing
* [Screen Ruler] handle and log DXGI initialization failure
* [Screen Ruler] Add unhandled exception handler
* [Screen Ruler] comment out Units of Measure setting
* [Screen Ruler] introduce a separate device dedicated for capturing
As position is being set according to toolbar width&height (depends on num of
characters), on first toolbar-show size of the toolbar is wrong (list items are not set yet).
Therefore, first set characters and then position.
* [MeasureTool] initial commit
* [chore] clean up needless WindowsTargetPlatformVersion overrides from projects
* [MeasureTool] initial implementation
* Fix build errors
* Update vsconfig for needed Windows 10 SDK versions
* fix spellchecker
* another spellcheck fix
* more spellcheck errors
* Fix measurement being off by 1 on both ends
* UI fixes
* Add feet to crosses
* Remove anti-aliasing, as it's creating artifacts
* Use pixel tolerance from settings
* Tooltip updates
* Restore antialiasing to draw the tooltip
* remove comment for spell check
* Updated icons
* Icon updates
* Improve measurement accuracy and display
* Fix spellchecker
* Add less precise drawing on continuous warning
* Add setting for turning cross feet on
* Swap LMB/RMB for interaction
* Uncheck active tool's RadioButton when it exits
* activation hotkey toggles UI instead of just launching it
* track runner process and exit when it exits
* add proj ref
* toolbar is interactive during measurements
* always open toolbar on the main display
* refactor colors
* refactor edge detection & overlay ui
* refactor overlay ui even more
* simplify state structs
* multimonitor preparation: eliminate global state
* prepare for merge
* spelling
* proper thread termination + minor fixes
* multimonitor: launch tools on all monitors
* multimonitor support: track cursor position
* spell
* fix powertoys!
* ScreenSize -> Box
* add shadow effect for textbox
* spell
* fix debug mode
* dynamic text box size based on text layout metrics
* add mouse wheel to adjust pixel tolerance + per channel detection algorithm setting
* spelling
* fix per channel distance calculations
* update installer deps + spelling
* tool activation telemetry
* update assets and try to fix build
* use × instead of x
* allow multiple measurements with bounds tool with shift-click
* move #define DEBUG_OVERLAY in an appropriate space
* spell-checked
* update issue template + refactor text box drawing
* implement custom renderer and make × semiopaque
* spelling
* pass dpiScale to x renderer
* add sse2neon license
* update OOBE
* move license to NOTICE
* appropriate module preview image
* localization for AutomationPeer
* increase default pixel tolerance from 5 to 30
* add PowerToys.MeasureToolUI.exe to bugreport
* explicitly set texture dims
* clarify continuous capture description
* fix a real spelling error!
* cleanup
* clean up x2
* debug texture
* fix texture access
* fix saveasbitmap
* improve sum of all channel diffs method score calc
* optimize
* ContinuousCapture is enabled by default to avoid confusion
* build fix
* draw captured screen in a non continuous mode
* cast a spell...
* merge fix
* disable stroboscopic effect
* split global/perScreen measure state and minor improvements
* spelling
* fix comment
* primary monitor debug also active for the bounds tool
* dpi from rt for custom renderer
* add comment
* fix off by 1
* make backround convertion success for non continuous mode non-essential
* fix spelling
* overlay window covers taskbar
* fix CI
* revert taskbar covering
* fix CI
* fix ci again
* fix 2
* fix ci
* CI fix
* fix arm ci
* cleanup cursor convertion between coordinate spaces
* fix spelling
* Fix signing
* Fix MeasureToolUI version
* Fix core version
* fix race condition in system internals which happens during concurrent d3d/d2d resource creation
Co-authored-by: Jaime Bernardo <jaime@janeasystems.com>
Co-authored-by: Niels Laute <niels.laute@live.nl>
* Init commit
* Fix unintended GUID change of Microsoft.PowerToys.Run.Plugin.TimeZone.UnitTests
* Region and click word working
* Code style
* Close even when there is no result from the OCR
* Fix spelling concerns, and make overlay black to match snipping tool
* increase opacity of overlay to match snipping tool
* Code Style and cleanup
* Code style
* Create Logos and hook them into the project file
* Make the PowerOCR VCXProj more like Awake VCXProj
* Rename MainWindow to OCROverlay
* Add WindowUtilities and WindowForms
* Remove fsg to fix spelling error
* launch OCR Overlay on every screen
* Add PowerOCR to Runner Main.cpp
* Add PowerOCR Settings and Properties
* Add PowerOcrViewModel
* Fix wrong setting reference in PowerOcrSettingsVM
* Try to clean up the Cpp project for PowerOCR
* Went to ARM64 was x64 thanks @snickler
* Clean up PowerOCR C++ Proj with file refs
* Rewrite C++ dllmain comparing to awake
* Changes for spelling issues. The rest will stay
* Create PowerOcr Settings Page and add to settings shell
* Fix PowerOcr Settings
* Fix multi-monitor scaling issue
* Add close all overlays when escaping
* Update src/runner/main.cpp to call correct Power OCR dll
Co-authored-by: Stefan Markovic <57057282+stefansjfw@users.noreply.github.com>
* Update expect.txt
* Add many files from Color Picker for hotkey activation
* Organize project into helper folder
* Use new hotkey activation and keep process alive
* Fix bug where scalebmp wasn't working
* Add The file headers and dispose app.xaml.cs
* Code style changes
* Fix bug where PowerOCR was toggling Awake
* Unsubscribe from keyboard events making they don't fire twice
* Add SndPowerOcrSetting and add to SettingsVM
* Trying to make the runner close PowerOCR when runner closes
* Fix app_name
* Update spellcheck expect
* use mutex on PowerOCR app to keep to single instance
* Rebuild the module interface using ColorPicker as a template.
Process still stays alive.
* Fix project names of the module interface
* Put app startup args back to 0 like color picker
* Runner now finds and enables/disables PowerOCR
* remove unneeded item groups from settings proj, per stefansjfw
* Add PowerOCR Screenshots
* Revert changed project GUID
* Add OOBE content for PowerOCR
* Keep cursor on one screen since the OCR window does not span screens.
* reload settings when activation key is pressed
* New screenshots and OOBE text
* Add PowerOCR as a case in the settings App.xaml.cs OnLaunched
* Settings and OOBE Text Changes
* Using using on bitmaps and change OCR overlay to stay open if no result
* Keyboard activation is handled is true
* Remove unused start PowerOCR OOBE Method
* [PowerOCR]Add some telemetry
* Add some logging
* Don't recreate the OCR overlay Windows more times
* Add to BugReportTool to get event viewer errors
* Fix wrong comment
* Fix another comment
* Add files to installer
* Add to signing
* Don't take Esc away from other apps
* Default to Win Shift R
* Use low level keyboard hook from runner
* Remove esc from local low level keyboard hook
* Fix some nits
* Default to Win Shift T
* Progress!
* Progress...
* POC level.
* Added ability to delete from history using IPublicAPI
* Some sorting, works in some cases.
* Rename "Run History" back to just "History".
* Updated item from review.
* Slight change to PowerLauncher ref, set Copy Local = False
* Fixed missing history items if added to history without search term.
* Added placeholder unit test project
* Updates for new History plugin.
* Update Product.wxs, removed useless Unit Test project
* Removed actual files for "Microsoft.PowerToys.Run.Plugin.History.UnitTests"
* Added history.md, updated ESRPSigning_core.json
* Changes for review
* Removed now global CodeAnalysis/stylecop
* Made file too big string variable
* Performance improvements
* Add progress bar to indicate loading
* Added Logging
* Added name to log files
* Push
* Updated expect.txt
* Push
* * Fixes small bug I sometimes encountered by unloading the application
* Fixes bug where sometimes the loading bar kept stuck (on "file is too big" screen
* Update expect.txt
* Resolved review comments
Added LogTrace() function
* Unifying tasks
* Removed unneccesary log message
* * Added margin to loading bar and text.
* Changed color of background to monaco dark skin color
* Centred loading bar
* Changed logger path
* Changed log path
* Fixed align of loading label
* Fix label size and position
Co-authored-by: Stefan Markovic <stefan@janeasystems.com>
* [PT Run] Fix web link with ports support (#14260)
* URL in the format of `domain:port` now directs to default browser
* Add tests to verify web link with ports scenario
* Fix test case and scenario where mismatching schema and port for IPv6 does not result in correct output
* [PT Run][Tests] Change and add more UriParser Tests
* Specifically of note is line 56, where [IPv6]:80 diverts to https instead of http.
* [PT Run][Tests] Add UriParser tests
* Add more tests targeting port handling
* [PT Run] Fix http handling
* This also fixes oddity with IPv4 and IPv6 handling
* [PT Run] Add second results depending on condition
* Test: update all test to reflect updated functions & add a little more tests
* Update function to show two results when URI is in the format of `domain:port` (situation where it can also be `schema:path`)
* Update regex style to follow previous code
* [PT Run] Change tests and filter localhost from certain results
* Add tests for 127.0.0.1, localhost, and ::1
* Move test around into more logical arrangement
* Filter localhost out from showing double results
* [PT Run] Fix spelling on comments
* [PT Run] Add some words to expect.txt
* [PT Toys] Clarify comment regarding [::]
Co-authored-by: Heiko <61519853+htcfreek@users.noreply.github.com>
* [PT Run] Remove tests regarding tel protocol
* [PT Run] Clarify UriParser parameter
* [PT Run] Add UriParser tests for tel protocol
* Current code has a regression bug where tel:xxxx, if xxxx is more than 65536 it will break. Will fix in follow up commit.
* [PT Run] Refactor ExtendedUriParser and its tests
* Remove `isWebUri` from ExtendedUriParser, keeping only webUri and systemUri
* Tel protocol regression bug still exists
* [PT Run] Fix wrong icon when webUri result
* [PT Run] Fix regression bug for tel protocol
* Tel protocol will sometimes bug out when tel:xxxx if xxxxx is more than 65535, as UriBuilder will throw error thinking the port number has been exceeded
* [PT Toy] Fix tel test
* [PT Run] Changes to tests
* Add test for application uri to include ports, for all non-protocol, http and https variants
* Rearrange some more test to make more logical sense, and add comments
* [PT Run] Simplify code
* Move webUri and systemUri to be global, as per htcfreek's recommendation
* Add comment to empty catch
* Change null to default
* [PT Toy] Update test name
Co-authored-by: Heiko <61519853+htcfreek@users.noreply.github.com>
* [PT Toy] Change result prompt when empty string
* [PT Toy] Fix typo in comment
* [PT Toy] Simplify line
* [PT Toy] Change result prompt when empty string
* Deselect previous selected item because it might not be valid.
* fast execute non-delayed queries
* Speling fixxes.
* Fixed _isTextSetProgrammatically check for when PTRSearchQueryFastResultsWithDelay = false
* Resoved some comments.
* Added partial delay for fast plugins
* Updates settings UI for second throttle value. Changed text.
* 'Verbiage' update
* [ci]Fail for binaries without a version
* Add version to AlwaysOnTop dll
* Add version to AlwaysOnTop executable
* Add a version to Awake module
* Add version to FancyZones module dll
* Add version to PowerRenameUI executable
* Add version to VideoConferenceMute module
* Add version to the Bug Report Tool
* Add version to Styles Report Tools
* Add version to Webcam Report Tool
* Add version to PowerToysSetupCustomActions
* fix spellcheck
* Update tools/WebcamReportTool/resource.h
* create common localization class
* add loc name to prog plugin
* fixes
* Tool tip fixes and comments
* cleanup and highlight fix
* change
* Improvements
* Add GetLocalizedPath()
* smal code improvements
* Change to allow new settings for results tuning.
* Change to allow new settings for results tuning.
* Added WeightBoost
* Fixed null-ref crash in QueryResults
* Change based on stefansjfw review. Remove PowerLauncher_PluginWeightBoost.Content
* Fixed another of my dumb null-refs...
* Updated some text
* Moved global sort order and set enable/disabled as needed.
* Fixed enabled-state of "Global sort order score modifier" setting.
* moved monitors identifying
* changed device id
* get wmi info
* convert old data
* save/load applied layouts
* changed monitor identification
* id comparison
* save/load app zone history
* moved com and security init
* update ids in editor
* lib fix
* updated tests
* changed comparison
* tests
* updated id comparison
* updated log
* moved definition
* spell check
* resolve conflicts
* refactoring
* update serial numbers if possible
* C++ impl of immersive dark mode
* Stop using the hardcoded value.
* Conjured up theme listener based on registry.
* Update MainWindow.xaml.cpp
* Update expect.txt
* Moved themehelpers to the common themes lib.
* Ported theme helpers back to .NET
* Update expect.txt
* Updated C# Theme Listening logic to mimic the one from Windows Community Toolkit.
* Replaced unmanaged code for RegisterForImmersiveDarkMode with unmanaged ThemeListener class.
* Fix upstream changes
* Update ThemeListener.h
* Update ThemeListener.h
* Proper formatting
* Added handler to Keyboard Manager.
* Update EditKeyboardWindow.cpp
* Added dwmapi.lib to runner, removed condition from additional dependencies.
* Update PowerRenameUI.vcxproj
* Added new deps for ManagedCommon to Product.wxs
* Crude attempts and understanding installer
* Removed Microsoft.Win32.Registry.dll from product.wxs.
* Updated dictionary
* Renamed ThemeListener class file for consistency, removed unused CheckImmersiveDarkMode in theme_helpers.
* Update Themes.vcxproj
* Update theme_listener.cpp
* Removed SupportsImmersiveDarkMode version check
* Removed SupportsImmersiveDarkMode version check
* Whoops
* Update expect.txt
* Adding OneNote plugin for PowerToys Run
* Updating to 3.0.1 dependency, updating md, spellcheck, ready for PR
* Updating spelling and using localized string
* Adding OneNote link to readme
* Adding OneNote requirement to description
* removing 'open' from description
* Updating interop version, PR feedback
* Adding query caching and delayedExecution to PT Run OneNote plugin
* Adding binaries to signing, and updating doc
* Adding dependency nuget package binaries to installer
* PR feedback and .editorconfig fix to ignore IDE rules that conflict with repo styling
* Fixing spelling
* Make sure we run CG component detection on main
I believe that there is a hidden "default branch" setting in Azure
DevOps, and ours is set to "master". CG only attempts to automatically
inject to builds off the default branch... and because we're a GitHub
repo running builds in AzDO we _can't change what the default branch
is_. Oops.
Copied from microsoft/terminal#e0bd76b30
* spellbot got mad at me
* [FileExplorer Add-ons][SVG preview] Swap order of default and svg namespace if default comes first
Inkscape v1.1 swapped order of default and svg namespaces in svg file (default first, svg after).
That resulted in parser being unable to parse it correctly and instead of svg, text was previewed.
MS Edge and Firefox also couldn't preview svg files with mentioned order of namespaces definitions.
* expect.txt
* Update comment
* Minor fixes
* Use full namespace definition instead of prefix
* Adding OneNote plugin for PowerToys Run
* Updating to 3.0.1 dependency, updating md, spellcheck, ready for PR
* Updating spelling and using localized string
* Adding OneNote link to readme
* Adding OneNote requirement to description
* removing 'open' from description
* Updating interop version, PR feedback
* removed IWorkArea interface
* split work area initialization
* changed rect type in zoneset
* tests
upd work area tests
removed obsolete, update others
updated work area tests
* get current vd windows
* update windows positions
* removed unused flag
* moved update window positions to work area
* check monitor
* refactoring
* [Installer]Ship Windows App SDK as self-contained
* Include windows app sdk localization files
* fix spellcheck
* Upgrade Win3.14 version
* Add RunWixToolsOutOfProc to try fixing wix hang
* fix spellcheck
* Try to get more information from wix build
* Remove unneeded flags
* Fix spellchecker
* Add version check exception for dll with 1.0.0.0
* Move to WinAppSDK-1.1.0
* expect.txt
* Revert "[Settings]Don't launch if explorer is running elevated"
This reverts commit c485da2816.
* Make copyright header analyze suppression module scope
* Move to WinAppSDK-1.1.0
* expect.txt
* Revert "[Settings]Don't launch if explorer is running elevated"
This reverts commit c485da2816.
* Make copyright header analyze suppression module scope
* Update ResizeOperation.cs
Add a new boolean to check if the image was resized, skip modifying the metadata if the image was not modified.
* Simplify code to prevent un-needed metadata work when the image isn't changed
Simplify code to prevent un-needed metadata work when the image isn't changed. Thanks Crutkas for the guidance.
* Add small delay to the search query before displaying results
* Reduce user input throttle to 150ms and fix issue with autocomplete text updating
* Add System.Reactive.dll to Launcher installer
* [ARM64]Build pipelines
* Fix localization in pipelines (no arm64 al.exe)
* Use lowercase arm64 for CI
* Build installer to arm64 folder and arm64 name
* Don't run arm64 tests, as there's no agent for it
* Fix pipeline conditions
* Divide symbol files by platform
* If SVG file is bigger than 2MB save it as html page and navigate WebView2 to it
Reason: WebView2.NavigateToString() has 2MB string limitation
* Cleanup and add limitation link to comment
* Lower the limit after testing it
* [ARM64] Cleanup PowerToys solution configuration
* [ARM64] Add Bootstrapper support
known issues:
- wix doesn't have arm platform -> using x86 instead, resulting in wrong default installation dir and inability to detect 605
- current winappsdk 1.0.3 installer is corrupted -> contains x64 packages
- we're still using hardcoded vcredist for some modules
* Remove duplicate Stylecop PackageReference
* [ARM64] Cleanup StylesReportTool configuration
* [ARM64] fix configurations for bootstrapper
* fixes
* [ARM64] VCM fix
* [ARM64] Fix LinkIncremental conditional in StylesReportTool
* fix#2
* perfect forwarding
* [ARM64] Switch to call vformat to compile with later MSVC toolkits
* Updated expect
Co-authored-by: Jeremy Sinclair <4016293+snickler@users.noreply.github.com>
* Migrate PowerRename to Unpackaged WinUI3
* [ARM64] PowerRename (#18002)
* Migrate PowerRename to Unpackaged WinUI3
* Removed Project Config and update PlatformToolset to v143
* Updated solution config
* Migrate PowerRename to Unpackaged WinUI3
* Fixed configs changed from ARM64 build
* Left one project out of fix
Co-authored-by: Stefan Markovic <stefan@janeasystems.com>
Co-authored-by: Stefan Markovic <57057282+stefansjfw@users.noreply.github.com>
* Minor fixes
* Remove PowerRenameUILib from signing list - doesn't exist anymore
* Remove PowerRenameUILib from move_uwp_resources.ps1
* Bring back old dir name to see if localization is preserved
Remove move_uwp_resources.ps1 - not needed anymore
* Remove UWP localization docs part
* Fix minor UI quirk
Co-authored-by: Jeremy Sinclair <4016293+snickler@users.noreply.github.com>
* search for contains too
* fix startup types & new filter
* fix spelling
* small fixes
* fix spacing
* Improve order and layout
* clean up
* switch to nullable int32
* Move Preview strings
Use as short (yet descriptive) a text as possible - at least for the Headers. The rest should be in Descriptions.
* Rewrite pointers for thumbnails
I made them `...ToggleSwitch_Thumbnail_extension` to be consistent with the `_Preview` pointers, and to represent UI hierarchy.
* sloppy typo
* Added a few example extensions
And a few tiny things.
* dots
* G-code spelling
* Update expect.txt
* Fix misplaced tag + icons
e914 = "Printer3D"
* Fixing error
Must've been line 634
* fix
Co-authored-by: Heiko <61519853+htcfreek@users.noreply.github.com>
* etc to ellipsis
Small thing, but I see the translation value
Co-authored-by: Heiko <61519853+htcfreek@users.noreply.github.com>
Co-authored-by: Heiko <61519853+htcfreek@users.noreply.github.com>
* CIEXYZ values should be labeled in upper case "XYZ" instead of "xyz"
* CIEXYZ values should be labeled in upper case "XYZ" instead of "xyz"
Updated example in settings UI
* Make launcher detect portable installations of VS Code in system PATH
This should fix#13362
* Move closing parenthesis
* remove trailing whitespace characters
* [Settings]Upgrade to WinAppSdk 1.0.3
* [Settings]Use the correct runtime identifier
* [Settings]Include native dlls after proper publish
* Update docs as well
* Removed x64 specific conditions
* Added RuntimeIdentifiers and ensured Platforms aligned
* Removed x64 specific configuration and normalized PropertyGroup configuration
* Removed Platform conditions from ItemDefinition and Property Group
* Adding Project Configurations to PowerToys.Interop
* Updated solution config for common projects
* [PT Run] UnitConverter float number precision is not enough
Introduced rounding to significant digits, not to digits after decimal separator
Added conversion to string to fix last digit errors
* [PT Run] UnitConverter float number precision is not enough
spell check fixes
* [PT Run] UnitConverter float number precision is not enough
renamed test method to HandleNanometerToKilometer
* [PT Run] UnitConverter float number precision is not enough
result copied to clipboard will not have unit, just a number
* Move MarkdownPreviewHandler from WebBrowser to WebView2
* Disable context menu
Open links in default browser
* Update expect.txt
* Move SvgPreviewHandler from WebBrowser to WebView2
* Migrate SvgThumbnailProvider from WebBrowser to WebView2
* Migrate CustomControlTest to WebView2
Remove WebBrowser related stuff
* Update tests
* Revert GetThumbnail return value
Disable javascript dialogs in WebView2 for Svg thumbnail and preview
* expect.txt
* Increase timeout for Markdown tests
* Add sleeps
* Add zero check
* Web search does not use my default browser #16549
updated DefaultBrowserInfo logic to get program location from shell open command not icon location
* Refactored DefaultBrowserInfo to start default browser with arguments specified in shell/open/command value for the browser.
Added fallback to Microsoft Edge if no browser information available.
#16549 Web search does not use my default browser
* fixed comment
#16549 Web search does not use my default browser
* removed resolution from device id
* update applied layouts device id
* app zone history device id updated
* moved old device id parsing
* updated tests
* remove resolution in the editor
* remove resolution from device id generation
* update editor params
* Added ARM64 Platform to Directory.Build.props
* Added ARM64 project configuration for Cpp.Build.props
* Added ARM64 configuration to solution. Keeping at x64 for now
* [FZEditor]Add narrator info to thumb buttons
* [FZEditor]Narrator information about the zones
* [FZEditor]Allow text to be focused for narrator
* Address PR feedback
* Make sure the *signed* MSI makes it into the bundle
* And don't let Bootstrapper force-build MSI
* Revert "And don't let Bootstrapper force-build MSI"
This reverts commit 77cea11008.
* try this wacky hacky sacky thing
* Revert "Revert "And don't let Bootstrapper force-build MSI""
This reverts commit 7d25009932.
* Revert "try this wacky hacky sacky thing"
This reverts commit 0fea6df635.
* ah the things i hate
* [PTRun][Program]Fix bug when renaming url shortcut
* Try to use the old full path for old app removal
* Guard against links to nowhere
* Fix test to have link point to existing location
* Update src/modules/launcher/Plugins/Microsoft.Plugin.Program/Programs/Win32Program.cs
Co-authored-by: Heiko <61519853+htcfreek@users.noreply.github.com>
* Fix nit.
Co-authored-by: Heiko <61519853+htcfreek@users.noreply.github.com>
* Fix the path to the icon
* Need the reverse when not working in isolation
* Updating some tray behaviors
* Making sure we have constants separately, and a filter
* Update tray logic
* Remove unnecessary menus
* Cleaning up how exit is done.
* Adding handling for tray commands
* Update with settings for dynamic times
* Proper reaction to timed keep-awake from the tray
* Proper handling for timed keep-awake from the tray
* Making sure that code analysis works correctly
* Making sure that errors are set in native calls
* Making sure the right icon path is used after testing
* Proper disposal of the context menu
* Fix tray designation
* Update with latest information on changes to the builds
* Update with guidance on files
* Update changelog doc
* Fix project file
* Remove `VTABLE`
* Increase precision of CIEXYZ conversion matrix
The output has 4 decimal places, so the conversion matrix should be more than 6 digits to avoid round-off errors.
* Match unit tests and docs with new CIEXYZ conversion matrix
* Remove negative sign from zeros
I generated the unit test results from other color-management systems.
It seems that they sometimes output negative zeros for very small values.
Let's just remove the negative signs for aesthetic.
* Fix spelling mistakes in ColorConverterTest.cs
* Explain how to obtain CIEXYZ unit test reference values
* Explain the CIELAB output is D65 adapted version
* Add words related to CIEXYZ conversion to spellcheck bypass list
* [VCM] Track newly added microphones when [All] is selected in the settings
* [VCM] handle case when no mics are left
* fixup: fix crashes onNotify
* fixup: fix build
* Add common csproj/vcxproj settings to Directory.Build.props
* Set TreatWarningsAsErrors to true for all c# projects
* Minor fixes in unit test projects where Analyzers where not enabled before
* Clean up Directory.Build.props
* Remove properties from ImageResizer csprojs files
* [Community.PowerToys.Run.Plugin.VSCodeWorkspaces] Enable analyzer and fix warnings
* fix CA1824: Mark assemblies with NeutralResourcesLanguageAttribute
* Register .markdown with the correct handler
* Fix spelling
* Move file name extensions from "expect.txt" to "excludes.txt"
* Revert "Move file name extensions from "expect.txt" to "excludes.txt""
This reverts commit 710d5a4968.
I must have misunderstood the instructions.
* Revert "Register .markdown with the correct handler"
This reverts commit 5c37b009f3.
* Work in progress
* Code ready for testing
* Update excludes.txt
* Update excludes.txt
* Update modulesRegistry.h
* Update modulesRegistry.h
For the want of an exclamation mark, a kingdom is lost!
* Update modulesRegistry.h
* Work on modulesRegistry.h per code review in 16180
Removed all previous exclusions from Monaco preview handler. Added a new exclusion: SVGZ. It's a binary file that Monaco cannot, in any meaningful way, read.
* Update expect.txt
* Update accessory files
* Disable machine-wide checks for performance reasons
* [FancyZones] Set correct corner preference when snapping windows on Windows 11
* Changed magic numbers to use enum values.
* Added missing words to spell check list.
* Changed note: to todo: for future visibility
* Changed note: to todo: for future visibility
* Import vdh from poc
* last changes
* push changes
* small change
* add error handling to vdh
* last changes
* make spellchecker happy
* last changes
* last changes
* spell check
* fix settings defaults
* Improve WindowWalkerSettings class
* add comment
* New settings and improvements
* new features
* subtitle and tool tip
* spell fixes
* small fixes
* fixes
* Explorer info
* spell fixes
* fixes and CloseWindow feature
* last changes
* first part of implementing KillProcess
* killProcess Part 2 & Fixes
* text fix and installer
* update access modifiers
* some fixes
* update dev docs
* fix dev docs
* dev doc change
* dev docs: add missed infos
* dev docs: add link
* Update src/modules/launcher/Plugins/Microsoft.Plugin.WindowWalker/Components/WindowWalkerSettings.cs
* fix build
* resolve feedback
* fix settings
* add tests
* ColorPicker: Enable analyzer and fix warnings
* Suppress CA1711:Identifiers should not have incorrect suffix
Renaming everything would be a lot of work. It does not do any harm if an EventHandler delegate ends with the suffix EventHandler.
Besides this, the Rule causes some false postives
* CA1838:Avoid 'StringBuilder' parameters for P/Invokes
We are not concerned about the performance impact of marshaling a StringBuilder
* resolve pr comments
* Initial commit - simple idea for a time zone plugin
* Translations, better search results, copy to clipboard, cleanup
* fix typo
* Add shortcut search and prepare JSON for later usage
* Fix typo
* Use timezone Data only from JSON
* Exclude json file from spell checker
* fix wrong dst
* Improved results (title, subtitle, tooltip) and fix namespace/class problem
* Always show full offset (-##:## and +##:##)
* Add and show timezone names (first pass)
* Fix typos
* fix build
* JSON: fix wrong minus sign and put extra country info the end
* Improved Subtitle for many matched countries and allow full offset search (+ and -)
* Allow more than one names for time zones and remove leftover
* Add military time zone names, and fix name result
* Only use one JSON entry for one time zone
* Use TimeSpan for offset, use build-in calculation for time in time zone
* add descriptions for JSON schema
* Fix typos
* Split out names in separate properties
* Add many time names, time zone names and shortcuts
* Add additional options and most code documentation
* Fix unreadable TimeSpans in JSON and rename helper class
* Fix not allowed commas in JSON file
* Cut to long time and time zone names in title
* Fix missing results for names and offsets
* Better result and show only one result when offset are identical (respect daylight saving time)
* Show generic name fot time zones without names
* Typo fixes
* Fix not working serach by shortcuts
* Fix german resx file -> english resx file
* Translate all names and countires
* Fix not working context menu
* Typo fixes, fix wrong shortcut in names, comments, few better variable names
* New symbols - thx to niels9001
* Search by shortcuts for time names
* update schema
* Add more time zone names and shortcuts (second pass), make spell checker happy
* Reduce matching checks
* Show shortcuts in tool-tips, avoid string converting
* Show only names that match the query
* Make all translatable (Part 1)
* Make all translatable (part 2 of 2)
* XML Doc
* Fix plugin name (type)
* Fix Typos
* Add TimeZone Plugint to WXS
* Add TimeZone plugin to sign pipeline
* Add Documentation
* Remove double spell entries
* Remove TODO leftovers
* Fix for results with no countries
* Fix typos
* fix typos
* Fix broken siolution after rebase
* Update target framework to make build happy
* fix wrong guid count in WXS
* fix wrong output folder (setup wasn’t found files)
* Address feedback from @jsoref - fix spell check
* typo fix - one leftover in expect.txt
* Switch to .NET6 and update dokumentation
* Address feedbacks, and fix search bug
* fix installer build error
* fix spellchecker
* Address feedback from @htcfreek
Co-authored-by: Sekan, Tobias <tobias.sekan@axp-consulting.de>
* [Oobe]Add a What's New page
* Show What's New when version changes
* Add link to GitHub
* Use generic icon for now
* Get only the latest 5 releases
* fix spellchecker
* rename last_version_run.json
* Remove UserControl_Loaded
* Remove installer hash from the release notes
* constexpr some strings
* Add check your internet connection message
* Update nuget packages
* try to fix build (Microsoft.UI.Xaml)
* Removed dlls because there are not needed anymore
* Add binaries System.Text.Json.dll (5x) to wxs file
* Downgrade System.IO.Abstractions.* due to breaking changes
* Update Microsoft.NET.Test.Sdk
* Revert MSTest.* to 2.2.3
* Removed Search Interop tlb package. Added minimal Search API Com implementation
* Added CSearchManagerImp
* Updated Main with proper reference to CSearchManagerImp. Switched WindowsIndexerTest to use Indexer.Interop classes
* Updated with proper SearchAPI Interop implementation
* Deleted initial CSearchManager file that didn't work
* Updated namespaces to match folder structure
* Removed the interfaces and classes not being used from SearchAPI. Added suppressions
* Updated spell check. Renamed CSearch call back to original
* Fix spell check
* Switched back to original class name for Search Manager in tests
* Removed Microsoft.Search.Interop.dll from setup
* Removed Microsoft.Search.Interop package from PowerLauncher and signing scripts
* remove unnecessary sdk
* add .vsconfig to sln, remove dead link
* spell check
* Update WindowsTargetPlatformMinVersion to 18362 (Minimum required version in README.md)
* Some code cleanup
* Making sure that the native wrapper lives in Awake.Core
* Adding power state logging, as well as termination entries.
* Better logging.
* Typos and logging improvements
* Remove dependency
* [PT Run] Refactoring: combined all NativeMethods.cs files for plugins into Wox.Plugin/Common/Win32/
* Fixed spell check
* [PT Run] Changed NativeMethods.Helpers to Win32Helpers (seperate class) to not conflict with Microsoft.PowerToys.Settings.UI.Library.Helpers
* [PT Run] Renamed Constants.cs to ConstantsAndStructs.cs and moved all of them from NativeMethods.cs
* [PT Run] Merged ConstantsAndStructs.cs into NativeMethods.cs and renamed Constants to Win32Constants to avoid conflicting
* [PT Run] Added missing summaries + fixed missed refactored method
* [PT Run] Use using directive instead of alias + updated method call for .Net 6
* [PT Run] Fixed missed using alias + spell check
* Update release.yml
* Update ColorPickerUI.csproj
* Update release.yml
adding in .net6 sdk and moving stuff sooner
* Update release.yml
* Update release.yml
* fixing test
* Forcing vs17 and adding in .net 6 sdk
* forcing pool
* fixing issues in each pipeline
* moving release .net up
* fixing diff on agent version for nuget installer
* Removing system.text.json.dll as included now
* getting unit tests it looks like to work
* updating everythign to .net 6 minus wxs for runtime
* unit test still have
* getting 6.0 stuff up and going. Terminal Unit tests have file max length issue ....
* found i think the last .net 5 issue
* looks like i wasn't aggressive enough with the 6.0 upgrade
* Getting stuff .net 6 buildable again
* tweaking with new stuff for installer
* Update newly added merged projects to .net 6
* Fix HeatDirectory bug on VS 2022
* Settings still needs JSON dependency
* Revert "getting 6.0 stuff up and going. Terminal Unit tests have file max length issue ...."
This reverts commit b9cb4586dc.
* Update sln version
* supress obsolete warning, since this is not a new development
* Partially Revert "Getting stuff .net 6 buildable again"
This reverts commit 42b4201c6b.
* supress another obsolete warning, since this is not a new development
* Reduce the unit test project name to avoid MAX PATH in CI
* Upgrade project's toolset in the main solution
* Some TODOs to review HttpClient usage
* Upgrade project toolsets from other solutions
* Install .net 6 instead of .net 5
* Fix issue when disabling PowerToys Run on .net framework 6
* Update docs for Visual Studio 2022
* PR comments: manually upgrade missing VS 2019 references
* Discard no discard values to solve compiler warnings
Co-authored-by: Jaime Bernardo <jaime@janeasystems.com>
label:Description of the new feature / enhancement
placeholder:|
What is the expected behavior of the proposed feature?
placeholder:What is the expected behavior of the proposed feature?
validations:
required:true
- type:textarea
attributes:
label:Scenario when this would be used?
placeholder:|
What is the scenario this would be used? Why is this important to your workflow as a power user?
attributes:
label:Scenario when this would be used?
placeholder:What is the scenario this would be used? Why is this important to your workflow as a power user?
validations:
required:true
- type:textarea
attributes:
attributes:
label:Supporting information
placeholder:|
Having additional evidence, data, tweets, blog posts, research, ... anything is extremely helpful. This information provides context to the scenario that may otherwise be lost.
placeholder:"Having additional evidence, data, tweets, blog posts, research, ... anything is extremely helpful. This information provides context to the scenario that may otherwise be lost."
[allow.txt](allow.txt) | Add words to the dictionary | one word per line (only letters and `'`s allowed) | [allow](https://github.com/check-spelling/check-spelling/wiki/Configuration#allow)
[reject.txt](reject.txt) | Remove words from the dictionary (after allow) | grep pattern matching whole dictionary words | [reject](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-reject)
[only.txt](only.txt) | Only check matching files (applied after excludes) | perl regular expression | [only](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-only)
[patterns.txt](patterns.txt) | Patterns to ignore from checked lines | perl regular expression (order matters, first match wins) | [patterns](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-patterns)
[candidate.patterns](candidate.patterns) | Patterns that might be worth adding to [patterns.txt](patterns.txt) | perl regular expression with optional comment block introductions (all matches will be suggested) | [candidates](https://github.com/check-spelling/check-spelling/wiki/Feature:-Suggest-patterns)
[line_forbidden.patterns](line_forbidden.patterns) | Patterns to flag in checked lines | perl regular expression (order matters, first match wins) | [patterns](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-patterns)
[expect.txt](expect.txt) | Expected words that aren't in the dictionary | one word per line (sorted, alphabetically) | [expect](https://github.com/check-spelling/check-spelling/wiki/Configuration#expect)
[advice.md](advice.md) | Supplement for GitHub comment when unrecognized words are found | GitHub Markdown | [advice](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-advice)
Note: you can replace any of these files with a directory by the same name (minus the suffix)
and then include multiple files inside that directory (with that suffix) to merge multiple files together.
# Update Lorem based on your content (requires `ge` and `w` from https://github.com/jsoref/spelling; and `review` from https://github.com/check-spelling/check-spelling/wiki/Looking-for-items-locally )
"taskName":"Add needs triage label to new issues",
"conditions":{
"operator":"and",
"operands":[
{
"name":"isAction",
"parameters":{
"action":"opened"
}
},
{
"operator":"not",
"operands":[
{
"name":"isPartOfProject",
"parameters":{}
}
]
},
{
"operator":"not",
"operands":[
{
"name":"isAssignedToSomeone",
"parameters":{}
}
]
}
]
},
"actions":[
{
"name":"addLabel",
"parameters":{
"label":"Needs-Triage"
}
}
],
"eventType":"issue",
"eventNames":[
"issues",
"project_card"
]
},
"id":"eUOhvA_62"
},
{
"taskType":"trigger",
"capabilityId":"IssueResponder",
"subCapability":"IssueCommentResponder",
"version":"1.0",
"config":{
"taskName":"Replace needs author feedback label with needs attention label when the author comments on an issue",
"conditions":{
"operator":"and",
"operands":[
{
"name":"isAction",
"parameters":{
"action":"created"
}
},
{
"name":"isActivitySender",
"parameters":{
"user":{
"type":"author"
}
}
},
{
"name":"hasLabel",
"parameters":{
"label":"Needs-Author-Feedback"
}
},
{
"name":"isOpen",
"parameters":{}
}
]
},
"actions":[
{
"name":"addLabel",
"parameters":{
"label":"Needs-Triage"
}
},
{
"name":"removeLabel",
"parameters":{
"label":"Needs-Author-Feedback"
}
},
{
"name":"addLabel",
"parameters":{
"label":"Needs-Team-Response"
}
}
],
"eventType":"issue",
"eventNames":[
"issue_comment"
]
},
"id":"kgfxdBIu_9"
},
{
"taskType":"trigger",
"capabilityId":"IssueResponder",
"subCapability":"IssuesOnlyResponder",
"version":"1.0",
"config":{
"taskName":"Remove no recent activity label from issues",
"conditions":{
"operator":"and",
"operands":[
{
"operator":"not",
"operands":[
{
"name":"isAction",
"parameters":{
"action":"closed"
}
}
]
},
{
"name":"hasLabel",
"parameters":{
"label":"Status-No recent activity"
}
}
]
},
"actions":[
{
"name":"removeLabel",
"parameters":{
"label":"Status-No recent activity"
}
}
],
"eventType":"issue",
"eventNames":[
"issues",
"project_card"
]
},
"id":"eR-TaGJJzW",
"disabled":false
},
{
"taskType":"trigger",
"capabilityId":"IssueResponder",
"subCapability":"IssueCommentResponder",
"version":"1.0",
"config":{
"taskName":"Remove no recent activity label when an issue is commented on",
"conditions":{
"operator":"and",
"operands":[
{
"name":"hasLabel",
"parameters":{
"label":"Status-No recent activity"
}
}
]
},
"actions":[
{
"name":"removeLabel",
"parameters":{
"label":"Status-No recent activity"
}
}
],
"eventType":"issue",
"eventNames":[
"issue_comment"
]
},
"id":"tXKeoDht_g",
"disabled":false
},
{
"taskType":"scheduled",
"capabilityId":"ScheduledSearch",
"subCapability":"ScheduledSearch",
"version":"1.1",
"config":{
"taskName":"Close stale issues",
"frequency":[
{
"weekDay":0,
"hours":[
1,
7,
13,
19
]
},
{
"weekDay":1,
"hours":[
1,
7,
13,
19
]
},
{
"weekDay":2,
"hours":[
1,
7,
13,
19
]
},
{
"weekDay":3,
"hours":[
1,
7,
13,
19
]
},
{
"weekDay":4,
"hours":[
1,
7,
13,
19
]
},
{
"weekDay":5,
"hours":[
1,
7,
13,
19
]
},
{
"weekDay":6,
"hours":[
1,
7,
13,
19
]
}
],
"searchTerms":[
{
"name":"isIssue",
"parameters":{}
},
{
"name":"isOpen",
"parameters":{}
},
{
"name":"hasLabel",
"parameters":{
"label":"Needs-Author-Feedback"
}
},
{
"name":"hasLabel",
"parameters":{
"label":"Status-No recent activity"
}
},
{
"name":"noActivitySince",
"parameters":{
"days":5
}
}
],
"actions":[
{
"name":"closeIssue",
"parameters":{}
}
]
},
"id":"8yr-nVZj9k",
"disabled":false
},
{
"taskType":"scheduled",
"capabilityId":"ScheduledSearch",
"subCapability":"ScheduledSearch",
"version":"1.1",
"config":{
"taskName":"Add no recent activity label to issues",
"frequency":[
{
"weekDay":0,
"hours":[
2,
8,
14,
20
]
},
{
"weekDay":1,
"hours":[
2,
8,
14,
20
]
},
{
"weekDay":2,
"hours":[
2,
8,
14,
20
]
},
{
"weekDay":3,
"hours":[
2,
8,
14,
20
]
},
{
"weekDay":4,
"hours":[
2,
8,
14,
20
]
},
{
"weekDay":5,
"hours":[
2,
8,
14,
20
]
},
{
"weekDay":6,
"hours":[
2,
8,
14,
20
]
}
],
"searchTerms":[
{
"name":"isIssue",
"parameters":{}
},
{
"name":"isOpen",
"parameters":{}
},
{
"name":"hasLabel",
"parameters":{
"label":"Needs-Author-Feedback"
}
},
{
"name":"noActivitySince",
"parameters":{
"days":5
}
},
{
"name":"noLabel",
"parameters":{
"label":"Status-No recent activity"
}
}
],
"actions":[
{
"name":"addLabel",
"parameters":{
"label":"Status-No recent activity"
}
},
{
"name":"addReply",
"parameters":{
"comment":"This issue has been automatically marked as stale because it has been marked as requiring author feedback but has not had any activity for **5 days**. It will be closed if no further activity occurs **within 5 days of this comment**."
}
}
]
},
"id":"DAhxoYjVcq",
"disabled":false
},
{
"taskType":"scheduled",
"capabilityId":"ScheduledSearch",
"subCapability":"ScheduledSearch",
"version":"1.1",
"config":{
"taskName":"Close duplicate issues",
"frequency":[
{
"weekDay":0,
"hours":[
3,
9,
15,
21
]
},
{
"weekDay":1,
"hours":[
3,
9,
15,
21
]
},
{
"weekDay":2,
"hours":[
3,
9,
15,
21
]
},
{
"weekDay":3,
"hours":[
3,
9,
15,
21
]
},
{
"weekDay":4,
"hours":[
3,
9,
15,
21
]
},
{
"weekDay":5,
"hours":[
3,
9,
15,
21
]
},
{
"weekDay":6,
"hours":[
3,
9,
15,
21
]
}
],
"searchTerms":[
{
"name":"isIssue",
"parameters":{}
},
{
"name":"isOpen",
"parameters":{}
},
{
"name":"hasLabel",
"parameters":{
"label":"Resolution-Duplicate"
}
},
{
"name":"noActivitySince",
"parameters":{
"days":1
}
}
],
"actions":[
{
"name":"addReply",
"parameters":{
"comment":"This issue has been marked as duplicate and has not had any activity for **1 day**. It will be closed for housekeeping purposes."
}
},
{
"name":"closeIssue",
"parameters":{}
}
]
},
"id":"xGhARy1H0w"
},
{
"taskType":"trigger",
"capabilityId":"InPrLabel",
"subCapability":"InPrLabel",
"version":"1.0",
"config":{
"taskName":"Add 'In-PR' label on issue when an open pull request is targeting it",
"inPrLabelText":"Status: In PR",
"fixedLabelText":"Status: Fixed",
"fixedLabelEnabled":true,
"label_fixed":"Resolution-Fix-Committed",
"label_inPr":"In progress"
},
"id":"Rn1tANe62T"
},
{
"taskType":"trigger",
"capabilityId":"EmailCleanser",
"subCapability":"EmailCleanser",
"version":"1.0",
"id":"X0O-6aZ1v3_DAmhUIcNb2",
"config":{
"taskName":"Clean the email stuff"
}
},
{
"taskType":"trigger",
"capabilityId":"IssueResponder",
"subCapability":"IssueCommentResponder",
"version":"1.0",
"id":"VyV9JJSA8SbOyeWEwjyfL",
"config":{
"conditions":{
"operator":"and",
"operands":[
{
"name":"commentContains",
"parameters":{
"commentPattern":"\\/(bugreport|reportbug)",
"isRegex":true
}
},
{
"operator":"or",
"operands":[
{
"name":"activitySenderHasAssociation",
"parameters":{
"permissions":"admin",
"association":"MEMBER"
}
},
{
"name":"activitySenderHasAssociation",
"parameters":{
"association":"OWNER"
}
},
{
"name":"activitySenderHasAssociation",
"parameters":{
"association":"COLLABORATOR"
}
}
]
}
]
},
"eventType":"issue",
"eventNames":[
"issue_comment"
],
"taskName":"Ask for bug report zip file",
"actions":[
{
"name":"removeLabel",
"parameters":{
"label":"Needs-Triage"
}
},
{
"name":"addLabel",
"parameters":{
"label":"Needs-Author-Feedback"
}
},
{
"name":"addReply",
"parameters":{
"comment":"Hi there!<br/><br/>We need a bit more information to really debug this issue. Can you add a \"Report Bug\" zip file here? You right click on our system tray icon and just go to report bug. Then drag the zipfile from your desktop onto the GitHub comment box in this issue. Thanks! <br/>"
}
},
{
"name":"removeLabel",
"parameters":{
"label":"Needs-Team-Response"
}
}
]
}
},
{
"taskType":"trigger",
"capabilityId":"IssueResponder",
"subCapability":"IssueCommentResponder",
"version":"1.0",
"id":"bvMkigH2HPgUniYFCNco9",
"config":{
"conditions":{
"operator":"and",
"operands":[
{
"name":"commentContains",
"parameters":{
"isRegex":true,
"commentPattern":"\\/feedback[H|h]ub"
}
},
{
"operator":"or",
"operands":[
{
"name":"activitySenderHasAssociation",
"parameters":{
"association":"OWNER"
}
},
{
"name":"activitySenderHasAssociation",
"parameters":{
"association":"MEMBER"
}
},
{
"name":"activitySenderHasAssociation",
"parameters":{
"association":"COLLABORATOR"
}
}
]
}
]
},
"eventType":"issue",
"eventNames":[
"issue_comment"
],
"taskName":"Helper to mark as feedback hub",
"actions":[
{
"name":"addReply",
"parameters":{
"comment":"Hi! We've identified this issue that best is suited for Windows Feedback Hub. To do this on Windows, WinKey+F will bring it up!"
"comment":"Hi! We've identified this issue as a duplicate of another one that already exists on this Issue Tracker. This specific instance is being closed in favor of tracking the concern over on the referenced thread. Thanks for your report!"
}
},
{
"name":"closeIssue",
"parameters":{}
},
{
"name":"removeLabel",
"parameters":{
"label":"Needs-Triage"
}
},
{
"name":"removeLabel",
"parameters":{
"label":"Needs-Team-Response"
}
},
{
"name":"addLabel",
"parameters":{
"label":"Resolution-Duplicate"
}
}
]
}
},
{
"taskType":"trigger",
"capabilityId":"IssueResponder",
"subCapability":"IssueCommentResponder",
"version":"1.0",
"id":"mgZxIoqeF7GWUo7-tZF56",
"config":{
"conditions":{
"operator":"and",
"operands":[
{
"name":"commentContains",
"parameters":{
"commentPattern":"\\/needinfo",
"isRegex":true
}
},
{
"operator":"or",
"operands":[
{
"name":"activitySenderHasAssociation",
"parameters":{
"association":"OWNER"
}
},
{
"name":"activitySenderHasAssociation",
"parameters":{
"association":"MEMBER"
}
},
{
"name":"activitySenderHasAssociation",
"parameters":{
"association":"COLLABORATOR"
}
}
]
}
]
},
"eventType":"issue",
"eventNames":[
"issue_comment"
],
"actions":[
{
"name":"removeLabel",
"parameters":{
"label":"Needs-Triage"
}
},
{
"name":"removeLabel",
"parameters":{
"label":"Needs-Team-Response"
}
},
{
"name":"addLabel",
"parameters":{
"label":"Needs-Author-Feedback"
}
}
],
"taskName":"Author Response needed"
}
},
{
"taskType":"trigger",
"capabilityId":"IssueResponder",
"subCapability":"IssueCommentResponder",
"version":"1.0",
"id":"mgZxIoqeF7GWUo7-t3773",
"config":{
"conditions":{
"operator":"and",
"operands":[
{
"name":"commentContains",
"parameters":{
"commentPattern":"\\/loc\\b",
"isRegex":true
}
},
{
"operator":"or",
"operands":[
{
"name":"activitySenderHasAssociation",
"parameters":{
"association":"OWNER"
}
},
{
"name":"activitySenderHasAssociation",
"parameters":{
"association":"MEMBER"
}
}
]
}
]
},
"eventType":"issue",
"eventNames":[
"issue_comment"
],
"actions":[
{
"name":"removeLabel",
"parameters":{
"label":"Needs-Triage"
}
},
{
"name":"addLabel",
"parameters":{
"label":"Loc-Sent To Team"
}
},
{
"name":"addReply",
"parameters":{
"comment":"Hi! Thanks for making us aware of the problem. We raised the issue with our internal localization team. This issue should be fixed hopefully in the next version of PowerToys."
}
}
],
"taskName":"Filed ADO item with Localization team"
<!-- Enter a brief description/summary of your PR here. What does it fix/what does it change/how was it tested (even manually, if necessary)? -->
## Summary of the Pull Request
**What is this about:**
<!-- Please review the items on the PR checklist before submitting-->
## PR Checklist
**What is included in the PR:**
**How does someone test / validate:**
## Quality Checklist
- [ ]**Linked issue:**#xxx
- [ ]**Communication:** I've discussed this with core contributors in the issue.
- [ ]**Closes:**#xxx
- [ ]**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
- [ ]**Installer:** Added/updated and all pass
- [ ]**Localization:** All end user facing strings can be localized
- [ ]**Docs:** Added/updated
- [ ]**Binaries:** Any new files are added to WXS / YML
- [ ]No new binaries
- [ ] [YML for signing](https://github.com/microsoft/PowerToys/blob/main/.pipelines/pipeline.user.windows.yml#L68) for new binaries
- [ ] [WXS for installer](https://github.com/microsoft/PowerToys/blob/main/installer/PowerToysSetup/Product.wxs) for new binaries
- [ ]**Dev docs:** Added/updated
- [ ]**New binaries:** Added on the required places
- [ ][JSON for signing](https://github.com/microsoft/PowerToys/blob/main/.pipelines/ESRPSigning_core.json) for new binaries
- [ ] [WXS for installer](https://github.com/microsoft/PowerToys/blob/main/installer/PowerToysSetup/Product.wxs) for new binaries and localization folder
- [ ] [YML for CI pipeline](https://github.com/microsoft/PowerToys/blob/main/.pipelines/ci/templates/build-powertoys-steps.yml) for new test projects
- [ ] [YML for signed pipeline](https://github.com/microsoft/PowerToys/blob/main/.pipelines/release.yml)
- [ ]**Documentation updated:** If checked, please file a pull request on [our docs repo](https://github.com/MicrosoftDocs/windows-uwp/tree/docs/hub/powertoys) and link it here: #xxx
<!-- Provide a more detailed description of the PR, other things fixed or any additional comments/features here -->
## Detailed Description of the Pull Request / Additional comments
<!-- Describe how you validated the behavior. Add automated tests wherever possible, but list manual validation steps taken as well -->
## Validation Steps Performed
## Contributor License Agreement (CLA)
A CLA must be signed. If not, go over [here](https://cla.opensource.microsoft.com/microsoft/PowerToys) and sign the CLA.
ConnectedServiceName:'Terminal/Console/WinAppDriver Team Code Signing Connection'
FolderPath:'$(BuildPlatform)/$(BuildConfiguration)'# Video conf uses x86 and x64. This path will also work for PowerToysSetupCustomActions which is in a different root dir
FolderPath:'$(BuildPlatform)/$(BuildConfiguration)'# Video conf uses x86 and x64.
ConnectedServiceName:'Terminal/Console/WinAppDriver Team Code Signing Connection'
FolderPath:'x86/$(BuildConfiguration)'# Video conf uses x86 and x64. This path will also work for PowerToysSetupCustomActions which is in a different root dir
FolderPath:'x86/$(BuildConfiguration)'# Video conf uses x86 and x64.
Aaron has helped triaging, discussing, and creating a substantial number of issues and contributed features/fixes as well as work on an upcoming utility.
Aaron has helped triaging, discussing, and creating a substantial number of issues and contributed features/fixes. Aaron was the primary person for helping build the File Explorer preview pane handler for developer files.
### [@martinchrzan](https://github.com/martinchrzan/) - Martin Chrzan
Niels has helped drive large sums of our update toward a new [consistent and modern UX](https://github.com/microsoft/PowerToys/issues/891). This includes the [launcher work](https://github.com/microsoft/PowerToys/issues/44), color picker UX update and [icon design](https://github.com/microsoft/PowerToys/issues/1118).
Tobias Sekan has helped out contributing features to PowerToys Run such as Settings plugin, Registry plugin
@@ -53,6 +62,9 @@ Their fork of Wox was the base of PowerToys Run.
Initial base of jjw24's fork, which makes it the base of PowerToys Run.
### [Text-Grab](https://github.com/TheJoeFin/Text-Grab) - Joseph Finney
Joe helped develop and contribute to the Text Extractor utility. It is directly based on his Text Grab application.
## Microsoft community members
We would like to also directly call out some extremely helpful Microsoft employees that have directly contributed to PowerToys. This isn't their day job and was work they did out of passion. We want to say thank you and recognize your work.
@@ -71,15 +83,15 @@ Image Resizer is from Brice.
### [@chrdavis](https://github.com/chrdavis/) - Chris Davis
PowerRename is from Chris's SmartRename and icon rendering for SVGs in File Explorer
PowerRename is from Chris's SmartRename and icon rendering for SVGs in File Explorer.
### [@dend](https://github.com/dend/) - Den Delimarsky
PowerToys Awake is a tool to keep your computer awake.
### [@martinchrzan](https://github.com/martinchrzan/) - Martin Chrzan
Niels has helped drive large sums of our update toward a new [consistent and modern UX](https://github.com/microsoft/PowerToys/issues/891). This includes the [launcher work](https://github.com/microsoft/PowerToys/issues/44), color picker UX update and [icon design](https://github.com/microsoft/PowerToys/issues/1118).
### [@oldnewthing](https://github.com/oldnewthing) - Raymond Chen
@@ -88,3 +100,15 @@ Find My Mouse is based on Raymond Chen's SuperSonar.
### Microsoft InVEST team
This amazing team helped PowerToys develop PowerToys Run and Keyboard manager as well as update our Settings to v2. @alekhyareddy28, @arjunbalgovind, @jyuwono@laviusmotileng-ms, @ryanbodrug-microsoft, @saahmedm, @somil55, @traies, @udit3333
## PowerToys core team
- [@crutkas](https://github.com/crutkas/) - Clint Rutkas - Lead
@@ -33,6 +33,10 @@ Upvote the original issue by clicking its [+😊] button and hitting 👍 (+1) i
Please comment on an issue to let us know you're interested in working on something before you start the work. Not only does this avoid multiple people unexpectedly working on the same thing at the same time but it enables us to make sure everyone is clear on what should be done to implement any new functionality. It's less work for everyone, in the long run, to establish this up front.
### Localization issues
Please file localization issues, so our internal localization team can identify and fix them. However we currently don't accept community Pull Requests fixing localization issues. Localization is handled by the internal Microsoft team only.
### To Spec or not to Spec
A key point is for everyone to understand the approach that will be taken. We want to be sure if anyone does work, we will accept it in. Items that are larger in scope we'll want some type of spec to understand what is being planned and have a discussion. Specs help collaborators discuss different approaches to solve a problem, describe how the feature will behave, how the feature will impact the user, what happens if something goes wrong, etc. Driving towards agreement in a spec, before any code is written, often results in simpler code, and less wasted effort in the long run.
@@ -53,7 +57,7 @@ Follow the [development guidelines](https://github.com/microsoft/PowerToys/blob/
### Naming of features and functionality
Naming should be descriptive and straight forward. We want names to be clear about functionality and usefulness moving forward.
Naming should be descriptive and straight forward. We want names to be clear about functionality and usefulness moving forward.
### How can I become a collaborator on the PowerToys team
| x64 | [](https://dev.azure.com/ms/PowerToys/_build/latest?definitionId=219&branchName=main) | [](https://dev.azure.com/ms/PowerToys/_build/latest?definitionId=219&branchName=stable) | [](https://dev.azure.com/microsoft/Dart/_build/latest?definitionId=76541&branchName=main) |
| ARM64 | Currently investigating | [Issue #490](https://github.com/microsoft/PowerToys/issues/490) | |
| x64 | [](https://dev.azure.com/ms/PowerToys/_build/latest?definitionId=219&branchName=main&jobName=Build%20x64%20Release) | [](https://dev.azure.com/ms/PowerToys/_build/latest?definitionId=219&branchName=stable) | [](https://dev.azure.com/microsoft/Dart/_build/latest?definitionId=76541&branchName=main) |
| ARM64 | [](https://dev.azure.com/ms/PowerToys/_build/latest?definitionId=219&branchName=main) | [](https://dev.azure.com/ms/PowerToys/_build/latest?definitionId=219&branchName=stable) | [](https://dev.azure.com/microsoft/Dart/_build/latest?definitionId=76541&branchName=main) |
## About
Microsoft PowerToys is a set of utilities for power users to tune and streamline their Windows experience for greater productivity. For more info on [PowerToys overviews and how to use the utilities][usingPowerToys-docs-link], or any other tools and resources for [Windows development environments](https://docs.microsoft.com/windows/dev-environment/overview), head over to [docs.microsoft.com][usingPowerToys-docs-link]!
Microsoft PowerToys is a set of utilities for power users to tune and streamline their Windows experience for greater productivity. For more info on [PowerToys overviews and how to use the utilities][usingPowerToys-docs-link], or any other tools and resources for [Windows development environments](https://learn.microsoft.com/windows/dev-environment/overview), head over to [learn.microsoft.com][usingPowerToys-docs-link]!
- Windows 11 or Windows 10 v1903 (18362) or newer.
-[.NET Core 3.1.22 Desktop Runtime](https://dotnet.microsoft.com/download/dotnet/thank-you/runtime-desktop-3.1.22-windows-x64-installer) or a newer 3.1.x runtime. The installer will handle this if not present.
- Windows 11 or Windows 10 version 2004 (code name 20H1 / build number 19041) or newer.
-Our installer will install the following items:
- [Microsoft Edge WebView2 Runtime](https://go.microsoft.com/fwlink/p/?LinkId=2124703) bootstrapper. This will install the latest version.
### Via GitHub with EXE [Recommended]
[Microsoft PowerToys GitHub releases page][github-release-link], click on `Assets` at the bottom to show the files available in the release and then click on `PowerToysSetup-0.53.3-x64.exe` to download the PowerToys installer.
Go to [Microsoft PowerToys GitHub releases page][github-release-link], click on `Assets` at the bottom to show the files available in the release. Please use the appropriate PowerToys installer that matches your machine's architecture. For most, it is `x64`.
Install from the [Microsoft Store's PowerToys page][microsoft-store-link]. You must be using the [new Microsoft Store](https://blogs.windows.com/windowsExperience/2021/06/24/building-a-new-open-microsoft-store-on-windows-11/) which will be available for both Windows 11 and Windows 10.
Install from the [Microsoft Store's PowerToys page][microsoft-store-link]. You must be using the [new Microsoft Store](https://blogs.windows.com/windowsExperience/2021/06/24/building-a-new-open-microsoft-store-on-windows-11/) which is available for both Windows 11 and Windows 10.
### Via WinGet (Preview)
### Via WinGet
Download PowerToys from [WinGet][winget-link]. To install PowerToys, run the following command from the command line / PowerShell:
There are [community driven install methods](./doc/unofficialInstallMethods.md) such as Chocolatey and Scoop. If these are your preferred install solutions, this will have the install instructions.
There are [community driven install methods](./doc/unofficialInstallMethods.md) such as Chocolatey and Scoop. If these are your preferred install solutions, you can find the install instructions there.
## Contributing
@@ -66,102 +72,110 @@ For guidance on developing for PowerToys, please read the [developer docs](/doc/
Our [prioritized roadmap][roadmap] of features and utilities that the core team is focusing on.
#### 0.53 - December 2021 Update
### 0.68 - February 2023 Update
We hope everyone has had a wonderful December 2021. The PowerToys community has been busy with a bunch of improvements. We're still working on improving the installer but this should drastically improve things. 3 things you will want to check out are G-code support in file explorer preview pane and thumbnails, the new web search plugin from PowerToys Run via <kbd>??</kbd> action phrase, and the new Always on Top utility via <kbd>Win</kbd>+<kbd>Ctrl</kbd>+<kbd>T</kbd>.
In this release, we focused on releasing new features, stability and improvements.
[@Aaron-Junker](https://github.com/Aaron-Junker) also has done some great progress on [implementing developer file preview pane](https://github.com/microsoft/PowerToys/issues/1527) via the Monaco engine from Visual Studio Code.
**Highlights**
#### Things to be aware of
-The new installer currently has a visual quirk when upgrade if you have a custom install path. It will show the default install path but it will actually overwrite the current location. We are investigating how to fix this.
- New utility: Paste as Plain Text allows pasting the text contents of your clipboard without formatting. Note: the formatted text in the clipboard is replaced with the unformatted text. Thanks [@carlos-zamora](https://github.com/carlos-zamora)!
-New utility: Mouse Jump allows to quickly move the mouse pointer long distances on a single screen or across multiple screens. Thanks [@mikeclayton](https://github.com/mikeclayton)!
- Add new GPO policies for automatic update downloads and update toast notifications. Thanks [@htcfreek](https://github.com/htcfreek)!
- Support MSC and CPL files in "Run command" results of PowerToys Run Program plugin. Thanks [@htcfreek](https://github.com/htcfreek)!
- Add support for log2 and log10 in PowerToys Run Calculator plugin. Thanks [@RickLuiken](https://github.com/RickLuiken)!
- Added experimentation to PowerToys first run experience. There are current page which says "welcome" and a variant with direct instructions on how to use some of the utilities. We want to see if directly showing how to use PowerToys leads to more people using the features :)
#### Always on Top
- Welcome to the family! With a quick <kbd>Win</kbd>+<kbd>Ctrl</kbd>+<kbd>T</kbd>, the window in focus is toggled to be on top. Toggle again, and it reverts back to normal.
### General
#### ColorPicker
-HEX input improvements for adjust color menu including support for hex code without hashtag and short hex code like #CF0. Thanks @htcfreek!
-Better bottom right screen detection for overlay
- Improve metered network detection in runner. Thanks [@davidegiacometti](https://github.com/davidegiacometti)!
-Update PowerToys logo used by installer. Thanks [@ChaseKnowlden](https://github.com/ChaseKnowlden1)!
-Add new GPO policies for automatic update downloads and update toast notifications. Thanks [@htcfreek](https://github.com/htcfreek)!
- Update copyright year to 2023. Thanks [@ChaseKnowlden](https://github.com/ChaseKnowlden)!
#### FancyZones
- Increased negative space margin
- Fix for not snapping child windows
- Fix for clearing keyboard focus on editor launch
- Fix to improve overlays to reduce brightness and hide numbers. Thanks @davidegiacometti
### FancyZones
#### File Explorer
-Added G-code support for thumbnails and preview pane. Thanks @pedrolamas
- Refactored and improved code quality.
-Fix crashing on moving window between monitors with Win + arrows. (This was a hotfix for 0.67)
- Fix issue causing window attributes to not be reset properly. (This was a hotfix for 0.67)
- Fix issue causing window to not be adjusted when layout is changed. (This was a hotfix for 0.67)
- Fix issue causing window not to be unsnapped on drag started. (This was a hotfix for 0.67)
- Fix issue causing layouts not to be applied to new virtual desktops. (This was a hotfix for 0.67)
- Fix issues causing windows not to be restored correctly to their last known zone.
#### Image Resizer
- Fixed regression from Metadata tag removal of ColorSpace. Thanks @CleanCodeDeveloper
### File explorer add-ons
#### PowerRename
-Row highlighting + preview support now implemented. Thanks @niels9001
- Fixed AltGR input issue
- Improved folder renaming support
- Opens on active monitor
- Add Developer files previewer option to set max file size and fix styling issue. Thanks [@Aaron-Junker](https://github.com/Aaron-Junker)!
-Improve Developer files previewer exception handling and printing of error messages.
- Fix crash when generating PDF and Gcode file thumbnails. (This was a hotfix for 0.67)
#### PowerToys Run
- Web searching has been added! `?? What is the answer to life` will go to your favorite search engine via your browser. You can change the default action key too! Thanks @cyberrex5 for primary implementation and @franky920920 and @htcfreek for supporting
- VS Code workspace improvements. Thanks @ricardosantos9521
- Binary and Hex number support. Thanks @gsuberland
- Ability to use factorials in calculations
- PT Run will not show in Window Walker results anymore. Thanks @davidegiacometti
- Fix log / ln calculations
- Fix to make previous results clear
- Fix to detect symlinks and prevent recursive loops
- Better detection for if a packaged app can be elevated
- Improve crash resiliency for Program plugin. Thanks @davidegiacometti
- Improved Windows setting results. Thanks @htcfreek
- Fixed a bug where some similar activation phrases aren't working as expected. Thanks @htcfreek and @cyberrex5.
### Hosts file editor
#### Video conference mute
-Disabled by default as this requires elevation to register the virtual camera.
- Changed (default) hotkey for mute camera & microphone from <kbd>Win</kbd>+<kbd>N</kbd> to <kbd>Win</kbd>+<kbd>Shift</kbd>+<kbd>Q</kbd> to not conflict with a Windows 11 keyboard shortcut
- Improved mutex support to prevent multiple PT Run instances from running
- Fix typo in Keyboard Manager Editor. Thanks [@ChristianLW](https://github.com/ChristianLW)!
#### Installer
- **NOTE:** The new installer currently has a visual quirk when upgrade if you have a custom install path. It will show the default install path but it will actually overwrite the current location. We are investigating how to fix this.
- Large progress toward user based installing vs machine wide. Upgrade scenario still needs additional work.
- Removed custom bootstrapper and now are using a WiX bundle.
- Removed unused image assets that were still being shipped. Thanks @niels9001
### Mouse Utils
#### ARM64 support
-Setting WinUI3 proof-of-concept and validate we do need at least one more feature, elevation support from WinUI 3 unpackaged applications.
- Resolve grammatical error in Mouse Highlighter description. Thanks [@WordlessSafe1](https://github.com/WordlessSafe1)!
-New utility: Mouse Jump allows to quickly move the mouse pointer long distances on single or across screens. Thanks [@mikeclayton](https://github.com/mikeclayton)!
#### Dev improvements
- New YAML based pipeline for building our signed installer. This will allow us to consolidate our CI to use same file. This was critical for us to unblock ARM64 and .NET 6 migration.
- Our submodules will no longer auto fetch to prevent locking issues. If you want a refresher on how to do this, head to [our dev docs](https://github.com/microsoft/PowerToys/tree/main/doc/devdocs#get-submodules-to-compile)
- Localization system shifted to Touchdown from CDPx. This should remove many of the loc issues.
- Consolidated a lot of the naming of EXEs and DLLs along with projects
- Update to spell checker. Thanks @jsoref
- /dup response has been added
- /reportbug /bugreport will ask for a "report bug" zip
### Paste as Plain Text
#### Community contributions
- New utility: Paste as Plain Text allows pasting the text contents of your clipboard without formatting. Note: the formatted text in the clipboard is replaced with the unformatted text. Thanks [@carlos-zamora](https://github.com/carlos-zamora)!
We'd like to directly mention certain contributors (in alphabetical order) for their continued community support this month and helping directly make PowerToys a better piece of software.
- Show Steam (steam://open/) shortcuts in the Program plugin.
- Localize paths of Program plugin results. Thanks [@htcfreek](https://github.com/htcfreek)!
- Improved stability of the code used to get the localized names and paths. Thanks [@htcfreek](https://github.com/htcfreek)!
- Support MSC and CPL files in "Run command" results of Program plugin. Thanks [@htcfreek](https://github.com/htcfreek)!
- Added missing MSC and CPL settings to the results of Windows Settings plugin. Thanks [@htcfreek](https://github.com/htcfreek)!
- System plugin: Setting for separate "Open/Empty Recycle bin" results or single result with context menu. (This was implemented based on user feedback for a change in the last build.) Thanks [@htcfreek](https://github.com/htcfreek)!
- Add support for log2 and log10 in Calculator plugin. Thanks [@RickLuiken](https://github.com/RickLuiken)!
- Removed the TimeZone plugin.
- Fix the crash when loading thumbnail for PDF files. (This was a hotfix for 0.67)
#### What is being planned for v0.55
### Shortcut Guide
For [v0.55][github-next-release-work], we'll work on adding more stability in with VCM and getting dev file preview pane added in so we get 150 file types :)
- Added: Dismiss Shortcut Guide with mouse click. Thanks [@davidegiacometti](https://github.com/davidegiacometti)!
- We are working to heavily reduce / remove the UAC prompt over the next few releases on install. This is a big shift so it is spanning multiple releases so we can isolate issues if they do occur. Work is tracked in [#10126](https://github.com/microsoft/PowerToys/issues/10126)
- Getting the dev file preview pane work integrated. (Monaco Editor)
- Separate PowerToys installer logs and MSI logs to different files.
- Added new GPO rules to the reporting tool.
- Move PowerToys registry entries back to HKLM to fix context menu entries not working on some configurations. (This was a hotfix for 0.67)
#### What is being planned for version 0.69
For [v0.69][github-next-release-work], we'll work on below:
- Allow installing without UAC.
- New utility: [PowerToys Peek](https://github.com/microsoft/PowerToys/issues/80)
- Stability / bug fixes
## PowerToys Community
The PowerToys team is extremely grateful to have the [support of an amazing active community][community-link]. The work you do is incredibly important. PowerToys wouldn’t be nearly what it is today without your help filing bugs, updating documentation, guiding the design, or writing features. We want to say thank you and take time to recognize your work.
The PowerToys team is extremely grateful to have the [support of an amazing active community][community-link]. The work you do is incredibly important. PowerToys wouldn’t be nearly what it is today without your help filing bugs, updating documentation, guiding the design, or writing features. We want to say thank you and take time to recognize your work. Month over month, you directly help make PowerToys a better piece of software.
## Code of Conduct
@@ -184,5 +198,5 @@ The application logs basic telemetry. Our Telemetry Data page (Coming Soon) has
For more info on [PowerToys overviews and how to use the utilities][usingPowerToys-docs-link], or any other tools and resources for [Windows development environments](https://docs.microsoft.com/windows/dev-environment/overview), head over to [docs.microsoft.com][usingPowerToys-docs-link]!
For more info on [PowerToys overviews and how to use the utilities][usingPowerToys-docs-link], or any other tools and resources for [Windows development environments](https://learn.microsoft.com/windows/dev-environment/overview), head over to [learn.microsoft.com][usingPowerToys-docs-link]!
Note: since _background activation_ implies that your toast handler will be invoked in a separate process, you can't share data directly from within a handler and your PT process. Also, since PT is currently a Desktop Bridge app, _foreground activation_ is [handled the same as background](https://docs.microsoft.com/en-US/windows/uwp/design/shell/tiles-and-notifications/send-local-toast-desktop-cpp-wrl#foreground-vs-background-activation), therefore we don't make a dedicated API for it. You can read more on the rationale of the current design [here](https://github.com/microsoft/PowerToys/pull/1178#issue-368768337).
Note: since _background activation_ implies that your toast handler will be invoked in a separate process, you can't share data directly from within a handler and your PT process. Also, since PT is currently a Desktop Bridge app, _foreground activation_ is [handled the same as background](https://learn.microsoft.com/windows/uwp/design/shell/tiles-and-notifications/send-local-toast-desktop-cpp-wrl#foreground-vs-background-activation), therefore we don't make a dedicated API for it. You can read more on the rationale of the current design [here](https://github.com/microsoft/PowerToys/pull/1178#issue-368768337).
As of the v0.66 of PowerToys, core runtime dlls are being shipped self-contained as a part of PowerToys. During the installation process, hard-links are being created for every module that needs any of these shared libraries.
## Why do this work?
Our main motivations for doing are the following:
1. Be able to install PowerToys without UAC elevation
2. PowerToys has a reduced disk space when components are shared.
3. Reduce additional downloads for dependencies
## Current self-contained runtimes
These dll's are installed in `<PowerToysInstallDir>/dll/<Item>` folder structure.
- [Microsoft Visual C++ Runtime](https://learn.microsoft.com/cpp/windows/latest-supported-vc-redist?view=msvc-170)
## So why does PowerToys have a larger footprint now?
Before the hard-link work was done, each of these runtimes had to be installed, so there were more items being installed outside just the PowerToys install directory. This space would not have been accounted.
File Explorer treats hard-links the same as "original"/regular files/directories (https://learn.microsoft.com/troubleshoot/windows-server/backup-and-storage/disk-space-problems-on-ntfs-volumes#other-ntfs-features-that-may-cause-file-allocation-confusion), not as links. This results in File Explorer reporting size of PowerToys installation directory bigger than it is (more than 2GB).
## How much space is actually being used
As of v0.66 of PowerToys, the installed footprint is ~660MB.
When we were prototyping and validating, here was our running table of results and why we took the route we did.
| Moment | Installer size | App size | Installation dir size | Real size | Deps downloaded and installed during PT install | Total (installer size + real size + deps downloaded and installed during PT install) |
Real disk usage of PowerToys is shown by inspecting disk usage after installing PowerToys. Used space is now 695MB, comparing to ~35MB used space for empty disk gives us the size of ~660MB for PowerToys installation dir.
Running these commands for PowerToys v0.66 shows that size of regular files is way less than size of hard-links pointing to some of those regular files because PowerShell (same as File Explorer) also takes the size of hard-links as of regular files.
@@ -25,17 +25,6 @@ The process and variables that can be tweaked on the pipeline are described in m
The localized resource dlls for C# projects are added to the MSI only for build on the pipeline. This is done by checking if the [`IsPipeline` variable is defined](https://github.com/microsoft/PowerToys/blob/f92bd6ffd38014c228544bb8d68d0937ce4c2b6d/installer/PowerToysSetup/Product.wxs#L804-L805), which gets defined before building the installer on the pipeline [here](https://github.com/microsoft/PowerToys/blob/f92bd6ffd38014c228544bb8d68d0937ce4c2b6d/.pipelines/build-installer.cmd#L4). This is done because the localized resx files are only present on the pipeline, and not having this check would result in the installer project failing to build locally.
### UWP Special case
C# projects normally expect localized resource files with the language id in the file name as Resources.`langId`.resx, where `langId` is generally a two character code except for language with specific variants (like zh-Hans or pt-BR):
For example, `path\Resources.resx` for English and `path\Resources.fr.resx` for French.
UWP differs from this as it expects the resources to have the same Resources.resw file name, but they should be present in language specific folders, with the full language ID (such as fr-fr, zh-hans, pt-br, etc.)
For example, `path\en-us\Resources.resw` for English and `path\fr-fr\Resources.resw` for French.
Since the pipeline generates it in this format, [a script is run](https://github.com/microsoft/PowerToys/blob/86d77103e9c69686c297490acb04775d43ef8b76/.pipelines/build-localization.cmd#L29-L31) to move these resw files to the correct format expected by all UWP projects. Currently the only UWP project is [Settings.UI](https://github.com/microsoft/PowerToys/tree/main/src/core/Settings.UI). The script used for moving the resources can be [found here](https://github.com/microsoft/PowerToys/blob/main/tools/localization/move_uwp_resources.ps1). The equivalent full language IDs for each shortened language ID obtained from the pipeline has been hardcoded in the script.
## Enabling localization on a new project
To enable localization on a new project, the first step is to create a file `LocProject.json` in the project root.
@@ -61,7 +50,7 @@ The rest of the steps depend on the project type and are covered in the sections
### C++
C++ projects do not support `resx` files, and instead use `rc` files along with `resource.h` files. The CDPX pipeline however doesn't support localizing `rc` files and the other alternative they support is directly translating the resources from the binary which makes it harder to maintain resources. To avoid this, a custom script has been added which expects a resx file and converts the entries to an rc file with a string table and adds resource declarations to a resource.h file so that the resources can be compiled with the C++ project.
If you already have a .rc file, copy the string table to a separate txt file and run the [convert-stringtable-to-resx.ps1](https://github.com/microsoft/PowerToys/blob/main/tools/build/convert-stringtable-to-resx.ps1) script on it. This script is not very robust to input, and requires the data in a specific format, where `IDS_ResName L"ResourceValue"` and any number of spaces can be present in between. The script converts this file to the format expected by [`resgen`](https://docs.microsoft.com/en-us/dotnet/framework/tools/resgen-exe-resource-file-generator#Convert), which will convert it to resx. The resource names are changed from all uppercase to title case, and the `IDS_` prefix is removed. Escape characters might have to be manually replaced, for example .rc files would have escaped double quotes as `""`, so this should be replaced with just `"` before converting to the resx files.
If you already have a .rc file, copy the string table to a separate txt file and run the [convert-stringtable-to-resx.ps1](https://github.com/microsoft/PowerToys/blob/main/tools/build/convert-stringtable-to-resx.ps1) script on it. This script is not very robust to input, and requires the data in a specific format, where `IDS_ResName L"ResourceValue"` and any number of spaces can be present in between. The script converts this file to the format expected by [`resgen`](https://learn.microsoft.com/dotnet/framework/tools/resgen-exe-resource-file-generator#Convert), which will convert it to resx. The resource names are changed from all uppercase to title case, and the `IDS_` prefix is removed. Escape characters might have to be manually replaced, for example .rc files would have escaped double quotes as `""`, so this should be replaced with just `"` before converting to the resx files.
After generating the resx file, rename the existing rc and h files to ProjName.base.rc and resource.base.h. In the rc file remove the string table which is to be localized and in the .h file remove all `#define`s corresponding to localized resources. In the vcxproj of the C++ project, add the following build event:
```
@@ -70,7 +59,7 @@ After generating the resx file, rename the existing rc and h files to ProjName.b
</Target>
```
This event runs a script which generates a resource.h and ProjName.rc in the `Generated Files` folder using the strings in all the resx files along with the existing information in resource.base.h and ProjName.base.rc. The script can be found [here](https://github.com/microsoft/PowerToys/blob/main/tools/build/convert-resx-to-rc.ps1). The script uses [`resgen`](https://docs.microsoft.com/en-us/dotnet/framework/tools/resgen-exe-resource-file-generator#Convert) to convert the resx file to a string table expected in the .rc file format. When the resources are added to the rc file the `IDS_` prefix is added and resource names are in upper case (as it was originally). Any occurrences of `"` in the string resource is escaped as `""` to prevent build errors. The string tables are added to the rc file in the following format:
This event runs a script which generates a resource.h and ProjName.rc in the `Generated Files` folder using the strings in all the resx files along with the existing information in resource.base.h and ProjName.base.rc. The script can be found [here](https://github.com/microsoft/PowerToys/blob/main/tools/build/convert-resx-to-rc.ps1). The script uses [`resgen`](https://learn.microsoft.com/dotnet/framework/tools/resgen-exe-resource-file-generator#Convert) to convert the resx file to a string table expected in the .rc file format. When the resources are added to the rc file the `IDS_` prefix is added and resource names are in upper case (as it was originally). Any occurrences of `"` in the string resource is escaped as `""` to prevent build errors. The string tables are added to the rc file in the following format:
@@ -99,7 +88,7 @@ Since C# projects natively support `resx` files, the only step required here is
**Note:** Building with localized resources may cause a build warning `Referenced assembly 'mscorlib.dll' targets a different processor` which is a VS bug. More details can be found [here](https://github.com/microsoft/PowerToys/issues/7269).
**Note:** If a project needs to be migrated from XAML resources to resx, the easiest way to convert the resources would be to change to format to `=` separates resources by either manually (by Ctrl+H on a text editor), or by a script, and then running [`resgen`](https://docs.microsoft.com/en-us/dotnet/framework/tools/resgen-exe-resource-file-generator#Convert) on `Developer Command Prompt for VS` to convert it to resx format.
**Note:** If a project needs to be migrated from XAML resources to resx, the easiest way to convert the resources would be to change to format to `=` separates resources by either manually (by Ctrl+H on a text editor), or by a script, and then running [`resgen`](https://learn.microsoft.com/dotnet/framework/tools/resgen-exe-resource-file-generator#Convert) on `Developer Command Prompt for VS` to convert it to resx format.
We use the awesome [spdlog](https://github.com/gabime/spdlog) library for logging as a git submodule under the `deps` directory. To use it in your project, just include [spdlog.props](../../deps/spdlog.props) in a .vcxproj like this:
Logging plays an important part in determining bugs in our code. It provides context for the developers about where and when errors occur.
## Where are the logs saved
* Most of the logs are saved under `%LOCALAPPDATA%/Microsoft/PowerToys`.
* For low-privilege processes (like preview handlers) the logs are saved under `%USERPROFILE%/AppData/LocalLow/Microsoft/PowerToys`.
Logs are normally in a subfolder with the module name as title.
The [BugReportTool](/tools/BugReportTool) will take logs from both locations when executed.
## Using a logger in a project
### Spdlog
In C++ projects we use the awesome [spdlog](https://github.com/gabime/spdlog) library for logging as a git submodule under the `deps` directory. To use it in your project, just include [spdlog.props](/deps/spdlog.props) in a .vcxproj like this:
```xml
<ImportProject="..\..\..\deps\spdlog.props"/>
```
It'll add the required include dirs and link the library binary itself.
### PowerToys Logger in ManagedCommon
For C# projects there is a static logger class in Managed Common called `Logger`.
To use it, add a project reference to `ManagedCommon` and add the following line of code to all the files using the logger:
```Csharp
usingManagedCommon;
```
In the `Main` function (or a function with a similar meaning (like `App` in a `App.xaml.cs` file)) you have to call `InitializeLogger` and specify the location where the logs will be saved (always use a path scheme similar to this example):
@@ -23,7 +23,7 @@ This file contains documentation for all the methods involved in key/shortcut re
## HandleShortcutRemapEvent
[This method](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/dll/KeyboardEventHandlers.cpp#L178-L739) is used for handling the shortcut to shortcut and shortcut to key remapping logic. The general logic is as follows:
- Check if any shortcut remap is currently invoked. This is required to ensure that two remaps don't occur simultaneously at a time, and we send key up events for the shortcuts only if they are actually invoked and not for artificial key up events. In addition to that, while a remap is in the middle of execution, the keyboard state will not match the physical keys, so we do not want a remap <kbd>Ctrl+A</kbd> to <kbd>Ctrl+V</kbd> to also trigger the remap from <kbd>Ctrl+V</kbd> to <kbd>Alt+V</kbd> on pressing <kbd>Ctrl+A</kbd> on the keyboard.
- Get the remap table as per the the `activatedApp` argument (i.e. if it is empty, we get the global shortcut remap table and otherwise we get the corresponding app-specific shortcut remap table).
- Get the remap table as per the `activatedApp` argument (i.e. if it is empty, we get the global shortcut remap table and otherwise we get the corresponding app-specific shortcut remap table).
- Iterate over the list of remaps in descending order of number of keys in the shortcut. This is required **for shortcut to key remaps** to ensure that if a user has both <kbd>Ctrl+A</kbd> and <kbd>Ctrl+Shift+A</kbd> remapped to some keys, and the user presses <kbd>Ctrl+Shift+A</kbd>, then we prefer the <kbd>Ctrl+Shift+A</kbd> remap. This logic would not be required if there were only shortcut to shortcut remaps, as they are invoked only on exact match.
- If any shortcut was found to be invoked (from the first step), then we skip till we find the matching shortcut remap. If not we check if the modifiers of the original shortcut are pressed down. If they are, we check if the current key event is a key down event and it matches the action key of the original shortcut. For shortcut to shortcut and for disabling a shortcut [we have an additional step](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/dll/KeyboardEventHandlers.cpp#L208-L212) where we check if any other key is pressed apart from the original shortcut. This is required because for these two features we allow the remaps only if those exact keys are pressed. The method used for this is described in detail [here](keyboardmanagercommon.md#IsKeyboardStateClearExceptShortcut). If a win key was pressed, we store whether it was the left or the right one, in order to determine which key to set for remaps from/to the common Win key code which we added. This is so that pressing and releasing Left Win key results in that Win key getting modified and not the Right Win key.
- If the remap is to a key, we send a dummy key event followed by releasing the original shortcut's modifiers and setting the target key (or doing nothing if it is remapped to disable) and we suppress the event.
@@ -66,15 +66,15 @@ This file contains documentation for all the methods involved in key/shortcut re
[This method](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/dll/KeyboardEventHandlers.cpp#L126-L176) was added to support a feature for converting the behavior of a key from behaving like a toggle (like Caps Lock/Num Lock) to a modifier (like Ctrl), such that when you hold Caps Lock it would behave as if Caps Lock was active, and when it was not pressed Caps Lock would be off. For Caps Lock this would be similar to behaving like Shift, but for Num Lock there is no existing key which can substitute for this. This was added while testing out remapping for the KBM PoC, but wasn't added as a feature since it wasn't a priority.
## Tests
In order to test the remapping logic, a mocked keyboard input handler had to be created because otherwise the tests would process and send actual key events. For this the [`InputInterface`](https://github.com/microsoft/PowerToys/blob/main/src/modules/keyboardmanager/common/InputInterface.h) was made, and in production code the methods are implemented using [`SendInput`](https://docs.microsoft.com/en-us/windows/win32/api/winuser/nf-winuser-sendinput) and [`GetAsyncKeyState`](https://docs.microsoft.com/en-us/windows/win32/api/winuser/nf-winuser-getasynckeystate). In addition to this, [`GetCurrentApplication`](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/common/Helpers.cpp#L226-L268) had to be mocked so that app-specific remapping can be tested.
In order to test the remapping logic, a mocked keyboard input handler had to be created because otherwise the tests would process and send actual key events. For this the [`InputInterface`](https://github.com/microsoft/PowerToys/blob/main/src/modules/keyboardmanager/common/InputInterface.h) was made, and in production code the methods are implemented using [`SendInput`](https://learn.microsoft.com/windows/win32/api/winuser/nf-winuser-sendinput) and [`GetAsyncKeyState`](https://learn.microsoft.com/windows/win32/api/winuser/nf-winuser-getasynckeystate). In addition to this, [`GetCurrentApplication`](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/common/Helpers.cpp#L226-L268) had to be mocked so that app-specific remapping can be tested.
### MockedInput
The [`MockedInput`](https://github.com/microsoft/PowerToys/blob/main/src/modules/keyboardmanager/test/MockedInput.h) class uses a 256 size `bool` vector to store the key state for each key code. Identifying the foreground process is mocked by simply setting and getting a string value for the name of the current process.
[To mock the `SendInput` method](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/test/MockedInput.cpp#L10-L110), the steps for processing the input are as follows. This implementation is based on public documentation for SendInput and the behavior of key messages and keyboard hooks:
- Iterate over all the inputs in the INPUT array argument
- If the event is a key up event, then it is considered [`WM_SYSKEYUP`](https://docs.microsoft.com/en-us/windows/win32/inputdev/wm-syskeyup) if Alt is held down, otherwise it is `WM_KEYUP`.
- If the event is a key down event, then it is considered [`WM_SYSKEYDOWN`](https://docs.microsoft.com/en-us/windows/win32/inputdev/wm-syskeydown) if either Alt is held down or if it is F10, otherwise it is `WM_KEYDOWN`.
- If the event is a key up event, then it is considered [`WM_SYSKEYUP`](https://learn.microsoft.com/windows/win32/inputdev/wm-syskeyup) if Alt is held down, otherwise it is `WM_KEYUP`.
- If the event is a key down event, then it is considered [`WM_SYSKEYDOWN`](https://learn.microsoft.com/windows/win32/inputdev/wm-syskeydown) if either Alt is held down or if it is F10, otherwise it is `WM_KEYDOWN`.
- An optional function which can be set on the `MockedInput` handler can be used to test for the number of times a key event is received by the system with a particular condition using [`sendVirtualInputCallCondition`](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/test/MockedInput.cpp#L48-L52).
- The hook logic for a low level hook which returns 0 or 1 can be set on the `MockedInput` handler such that it behaves like a low level hook would behave with actual keyboard input. If the method returns 1, then the keyboard state is not updated, and if it returns 0 the corresponding key event is used to update the key state. This works in the recursive way as well similar to low level hooks, as `SendVirtualInput` can be called from within the hook, thus simulating identical behavior to calling `SendInput` in a low level hook (as soon as SendInput is called, the low level hook is called for the new input event, and only after those are processed it returns back to the current event, check this [blog](https://devblogs.microsoft.com/oldnewthing/20140213-00/?p=1773) for more details).
- For updating the keyboard state, KEYUP messages result in the state for that key code being set to false, and KEYDOWN result in the state for that key code being set to true.
The `KeyboardManager` module has [3 main class members](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/dll/dllmain.cpp#L54-L61):
@@ -27,7 +30,7 @@ The `KeyboardManager` module has [3 main class members](https://github.com/micro
- An object of type `KeyboardManagerState`. This object contains all the data related to remappings and is also used in the sense of a View Model as it used to communicate common data that is shared between the KBM UI and the backend. This class is described in more detail [here](keyboardmanagercommon.md#keyboardmanagerstate).
## Enable/Disable
On enabling KBM, the low level keyboard hook is started, and it is unhooked on disable. This is done to allow users to manually restart KBM if some other application which registers a keyboard hook was launched after PowerToys, so that it can be brought back to the highest priority hook (as the last hook to be registered receives the input first as mentioned [here](https://docs.microsoft.com/en-us/windows/win32/winmsg/about-hooks#hook-procedures)).
On enabling KBM, the low level keyboard hook is started, and it is unhooked on disable. This is done to allow users to manually restart KBM if some other application which registers a keyboard hook was launched after PowerToys, so that it can be brought back to the highest priority hook (as the last hook to be registered receives the input first as mentioned [here](https://learn.microsoft.com/windows/win32/winmsg/about-hooks#hook-procedures)).
In addition to stopping the hook, any active KBM UI windows are also closed on disabling. This is done because the KBM UI uses the same keyboard hook for the Type button where you can type a key/shortcut, so if KBM is disabled the windows would not be completely functional.
@@ -96,12 +99,12 @@ KBM uses two sets of settings files.
}
-`originalKeys` stores the key/shortcut which is to be pressed for the remap, and `newKeys` stores the key/shortcut which is to be executed.
- Both contain semi-colon separated virtual key codes. For `remapKeys`, `originalKeys` must have only one key code, whereas for `remapShortcuts` it must have atleast two key codes.
- Both contain semi-colon separated virtual key codes. For `remapKeys`, `originalKeys` must have only one key code, whereas for `remapShortcuts` it must have atleast two key codes.
-`inProcess` sub-key was added in `remapKeys` because there was a possibility of adding the registry based remapping approach (used by [SharpKeys](https://github.com/randyrants/sharpkeys)), so that would be under a separate sub-key while `inProcess` would be for keyboard hook based remaps. This was deprioritized as there weren't enough requests for it.
-`remapShortcuts` is split into `global` and `appSpecific`, where `global` remaps would apply to all applications, whereas `appSpecific` would apply on when the `targetApp` is in focus. `targetApp` must be the process name of the app (with or without it's extension), e.g. `msedge` or `msedge.exe` for Microsoft Edge.
## Loading settings
KBM settings are loaded only on the C++ side only at start up, in the [constructor](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/dll/dllmain.cpp#L67-L68). The settings file may get modified from the KBM UI on applying new remappings, but the the file is not read again. The files are read from the PowerToys Settings process whenever a change is made to the file (using a FileWatcher) or whenever the KBM page is opened. The settings are updated only when the user presses the OK button from either of the Remap Keys or Remap Shortcuts windows. This is described in more detail [here](keyboardmanagerui.md#ok-and-cancel-button).
KBM settings are loaded only on the C++ side only at start up, in the [constructor](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/dll/dllmain.cpp#L67-L68). The settings file may get modified from the KBM UI on applying new remappings, but the file is not read again. The files are read from the PowerToys Settings process whenever a change is made to the file (using a FileWatcher) or whenever the KBM page is opened. The settings are updated only when the user presses the OK button from either of the Remap Keys or Remap Shortcuts windows. This is described in more detail [here](keyboardmanagerui.md#ok-and-cancel-button).
## Low level keyboard hook handler
Since the [`hook_proc`](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/dll/dllmain.cpp#L330-L349) cannot be a member function in the class, this is declared `static` and a `static pointer` to the `KeyboardManager` project is used ([`keyboardmanager_object_ptr`](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/dll/dllmain.cpp#L54-L55)).
@@ -114,10 +117,10 @@ As seen in the code for `hook_proc`, similar to other keyboard hooks in PowerToy
The [`HandleKeyboardHookEvent`](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/dll/dllmain.cpp#L384-L458) is the method which calls the corresponding remapping methods in the required order. The following checks are executed in order:
- **`KeyboardManagerState.AreRemappingsEnabled`:** This returns false while the KBM remap tables are getting updated. If it is in this state, `HandleKeyboardHookEvent` returns `0`, i.e. the key event is not suppressed and is forwarded normally.
- **Check for `KEYBOARDMANAGER_SUPPRESS_FLAG`:** If the key event has the suppress flag, the method returns 1 to suppress the key event.
- **[`KeyboardManagerState.DetectSingleRemapKeyUIBackend`](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/dll/dllmain.cpp#L399-L408):** This method is used for handling hook operations for the single key Type UI in the Remap keys window. If the Remap keys window is open, then `HandleKeyboardHookEvent` returns `0` and the key event is forwarded normally. If the left column Type button is clicked on the Remap keys window and and the window is in focus, then the key event is suppressed and the UI is updated with the latest key from the recent key events. This method is described in more detail [here](keyboardmanagercommon.md#DetectSingleRemapKeyUIBackend-and-DetectShortcutUIBackend).
- **[`KeyboardManagerState.DetectShortcutUIBackend(data, true)`](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/dll/dllmain.cpp#L410-L419):** This method is used for handling hook operations for the shortcut Type UI in the Remap keys window (when `isRemapKey` arg is `true`). If the Remap keys window is open, then `HandleKeyboardHookEvent` returns `0` and the key event is forwarded normally. If the right column Type button is clicked on the Remap keys window and and the window is in focus, then the key event is suppressed and the UI is updated with the shortcut from the recent key events. This method is described in more detail [here](keyboardmanagercommon.md#DetectSingleRemapKeyUIBackend-and-DetectShortcutUIBackend).
- **[`KeyboardManagerState.DetectSingleRemapKeyUIBackend`](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/dll/dllmain.cpp#L399-L408):** This method is used for handling hook operations for the single key Type UI in the Remap keys window. If the Remap keys window is open, then `HandleKeyboardHookEvent` returns `0` and the key event is forwarded normally. If the left column Type button is clicked on the Remap keys window and the window is in focus, then the key event is suppressed and the UI is updated with the latest key from the recent key events. This method is described in more detail [here](keyboardmanagercommon.md#DetectSingleRemapKeyUIBackend-and-DetectShortcutUIBackend).
- **[`KeyboardManagerState.DetectShortcutUIBackend(data, true)`](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/dll/dllmain.cpp#L410-L419):** This method is used for handling hook operations for the shortcut Type UI in the Remap keys window (when `isRemapKey` arg is `true`). If the Remap keys window is open, then `HandleKeyboardHookEvent` returns `0` and the key event is forwarded normally. If the right column Type button is clicked on the Remap keys window and the window is in focus, then the key event is suppressed and the UI is updated with the shortcut from the recent key events. This method is described in more detail [here](keyboardmanagercommon.md#DetectSingleRemapKeyUIBackend-and-DetectShortcutUIBackend).
- **`HandleSingleKeyRemapEvent`:** This method handles the single key remap logic. If a remapping takes place, the key event is suppressed. This method is described in more detail [here](keyboardeventhandlers.md#HandleSingleKeyRemapEvent).
- **[`KeyboardManagerState.DetectShortcutUIBackend(data, false)`](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/dll/dllmain.cpp#L430-L439):** This method is used for handling hook operations for the shortcut Type UI in the Remap shortcuts window (when `isRemapKey` arg is `false`). If the Remap shortcuts window is open, then `HandleKeyboardHookEvent` returns `0` and the key event is forwarded normally. If the Type button is clicked on the Remap shortcuts window and and the window is in focus, then the key event is suppressed and the UI is updated with the shortcut from the recent key events. **Since this is executed after the single key remap method, all single key remappings are applied when the user is on the Remap shortcuts window.**
- **[`KeyboardManagerState.DetectShortcutUIBackend(data, false)`](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/dll/dllmain.cpp#L430-L439):** This method is used for handling hook operations for the shortcut Type UI in the Remap shortcuts window (when `isRemapKey` arg is `false`). If the Remap shortcuts window is open, then `HandleKeyboardHookEvent` returns `0` and the key event is forwarded normally. If the Type button is clicked on the Remap shortcuts window and the window is in focus, then the key event is suppressed and the UI is updated with the shortcut from the recent key events. **Since this is executed after the single key remap method, all single key remappings are applied when the user is on the Remap shortcuts window.**
- **`HandleAppSpecificShortcutRemapEvent`:** This method handles the app-specific shortcut remap logic. If a remapping takes place, the key event is suppressed. This method is described in more detail [here](keyboardeventhandlers.md#HandleAppSpecificShortcutRemapEvent). **Since this is executed after the single key remap method, single key remappings have precedence over shortcut remaps and are correspondingly reflected in shortcut remaps.**
- **`HandleOSLevelShortcutRemapEvent`:** This method handles the global shortcut remap logic. If a remapping takes place, the key event is suppressed. This method is described in more detail [here](keyboardeventhandlers.md#HandleOSLevelShortcutRemapEvent). The app-specific remap method is executed before this because if a shortcut is remapped to different keys/shortcuts for a particular app and globally, the app-specific variant should be preferred if that app is in focus. **Since this is executed after the single key remap method, single key remappings have precedence over shortcut remaps and are correspondingly reflected in shortcut remaps.**
@@ -129,7 +132,7 @@ KBM uses the [`call_custom_action`](https://github.com/microsoft/PowerToys/blob/
## SendInput Special Scenarios
### Extended keys
Certain keys such as the arrow keys, <kbd>right Ctrl/Alt</kbd>, and <kbd>Del/Home/Ins</kbd>, etc need to be sent with the `KEYEVENTF_EXTENDEDKEY` flag because otherwise the NumPad versions get sent, which can cause weird behavior when NumLock is on. The code can be found [here](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/common/Helpers.cpp#L190-L194) and the list of extended keys in code can be found [here](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/common/Helpers.cpp#L73-L98). Docs about extended keys can be found [here](https://docs.microsoft.com/en-us/windows/win32/inputdev/about-keyboard-input#extended-key-flag).
Certain keys such as the arrow keys, <kbd>right Ctrl/Alt</kbd>, and <kbd>Del/Home/Ins</kbd>, etc need to be sent with the `KEYEVENTF_EXTENDEDKEY` flag because otherwise the NumPad versions get sent, which can cause weird behavior when NumLock is on. The code can be found [here](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/common/Helpers.cpp#L190-L194) and the list of extended keys in code can be found [here](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/common/Helpers.cpp#L73-L98). Docs about extended keys can be found [here](https://learn.microsoft.com/windows/win32/inputdev/about-keyboard-input#extended-key-flag).
The weird behavior that is caused by this can be found at these issues:
@@ -173,13 +176,13 @@ For example, while [remapping <kbd>Ctrl</kbd> to <kbd>Caps Lock</kbd>](https://g
While the above work around fixes most of the cases, there are still some scenarios where the modifier can get stuck, mentioned at this [comment](https://github.com/microsoft/PowerToys/issues/3397#issuecomment-663729278), which is why the issue is still open. This occurs if a modifier is pressed after the remap has been invoked before releasing the remapped key and it is a harder scenario to solve which requires refactoring the single key remap code.
### UIPI Issues (not resolved)
`SendInput` does not work directly with certain key codes such as Play/Pause Media, Calculator key, etc as it requires UAC privileges to be injected to the OS and accordingly play the active media app or launch the Calculator app. In order to resolve this the correct approach is that the executable which calls `SendInput` needs to have the [UIAccess flag](https://docs.microsoft.com/en-us/windows/win32/winauto/uiauto-securityoverview) set to true, which will also avoid the requirement of KBM having to run as administrator to intercept key events when an elevated window is in focus. The UIAccess flag has many constraints such as it must be a signed executable and must be located in a protected path like Program Files. Since KBM currently runs out of the runner process, it would make more sense to do this work after KBM is moved to a separate executable, and it could be enabled by a separate toggle in settings only if PowerToys is installed in Program Files. [This comment](https://github.com/microsoft/PowerToys/issues/3192#issuecomment-646323661) has more details on this approach and (this)[https://github.com/microsoft/PowerToys/issues/3255] is the tracking issue.
`SendInput` does not work directly with certain key codes such as Play/Pause Media, Calculator key, etc as it requires UAC privileges to be injected to the OS and accordingly play the active media app or launch the Calculator app. In order to resolve this the correct approach is that the executable which calls `SendInput` needs to have the [UIAccess flag](https://learn.microsoft.com/windows/win32/winauto/uiauto-securityoverview) set to true, which will also avoid the requirement of KBM having to run as administrator to intercept key events when an elevated window is in focus. The UIAccess flag has many constraints such as it must be a signed executable and must be located in a protected path like Program Files. Since KBM currently runs out of the runner process, it would make more sense to do this work after KBM is moved to a separate executable, and it could be enabled by a separate toggle in settings only if PowerToys is installed in Program Files. [This comment](https://github.com/microsoft/PowerToys/issues/3192#issuecomment-646323661) has more details on this approach and (this)[https://github.com/microsoft/PowerToys/issues/3255] is the tracking issue.
## Other remapping approaches
Other approaches for remapping which were deprioritized are:
### Registry approach
This method is used by [SharpKeys](https://github.com/randyrants/sharpkeys) and involves using the [Microsoft Keyboard Scancode mapper registry key](https://github.com/randyrants/sharpkeys) to remap keys based on their scan codes. This has the advantage of being applied in all scenarios and not facing any elevation or UAC issues, however the disadvantages are that for modifying the settings the process must run elevated (as it modifies HKLM registry) and it requires a reboot to get applied. Another issue which is an advantage/disadvantage for users is that the process does not need to be running, so the remaps are applied all the time, including at the password prompt on logging into the user's Windows account, which could get a user stuck if they orphaned a key in their password. This registry doesn't have any support for remapping shortcuts either, so the hook approach was prioritized over this.
This method is used by [SharpKeys](https://github.com/randyrants/sharpkeys) and involves using the [Microsoft Keyboard Scancode mapper registry key](https://github.com/randyrants/sharpkeys) to remap keys based on their scan codes. This has the advantage of being applied in all scenarios and not facing any elevation or UAC issues, however the disadvantages are that for modifying the settings the process must run elevated (as it modifies HKLM registry) and it requires a reboot to get applied. Another issue which is an advantage/disadvantage for users is that the process does not need to be running, so the remaps are applied all the time, including at the password prompt on logging into the user's Windows account, which could get a user stuck if they orphaned a key in their password. This registry doesn't have any support for remapping shortcuts either, so the hook approach was prioritized over this.
### Driver approach
Using a driver approach has the benefit of not depending on precedence orders as KBM could always run before low level hooks, and it also has the benefit of differentiating between different keyboards, allowing [multi keyboard-specific remaps](https://github.com/microsoft/PowerToys/issues/1460). The disadvantages are however that any bug or crash could have system level consequences. [Interception](https://github.com/oblitum/Interception) is an open source driver that could be used for implementing this. The approach was deprioritized due to the potential side effects.
@@ -190,10 +193,4 @@ Keyboard Manager emits the following telemetry events (implemented in [trace.h](
- **`KeyboardManager_KeyRemapCount`:** Logs the number of key to key and key to shortcut remaps (i.e. all the remaps on the Remap a key window). This gets logged on saving new settings in the Remap a key window (emitted [here](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/ui/LoadingAndSavingRemappingHelper.cpp#L159-L163)).
- **`KeyboardManager_OSLevelShortcutRemapCount`:** Logs the number of global shortcut to shortcut and shortcut to key remaps. This gets logged on saving new settings in the Remap a shortcut window (emitted [here](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/ui/LoadingAndSavingRemappingHelper.cpp#L220)).
- **`KeyboardManager_AppSpecificShortcutRemapCount`:** Logs the number of app-specific shortcut to shortcut and shortcut to key remaps. This gets logged on saving new settings in the Remap a shortcut window (emitted [here](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/ui/LoadingAndSavingRemappingHelper.cpp#L221)).
- **`KeyboardManager_KeyToKeyRemapInvoked`:** Logs an event when a key to key remap is invoked (emitted [here](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/dll/KeyboardEventHandlers.cpp#L101-L102)).
- **`KeyboardManager_KeyToShortcutRemapInvoked`:** Logs an event when a key to shortcut remap is invoked (emitted [here](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/dll/KeyboardEventHandlers.cpp#L101-L102)).
- **`KeyboardManager_OSLevelShortcutToShortcutRemapInvoked`:** Logs an event when a global shortcut to shortcut remap is invoked (emitted [here](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/dll/KeyboardEventHandlers.cpp#L320-L321)).
- **`KeyboardManager_OSLevelShortcutToKeyRemapInvoked`:** Logs an event when a global shortcut to key remap is invoked (emitted [here](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/dll/KeyboardEventHandlers.cpp#L320-L321)).
- **`KeyboardManager_AppSpecificShortcutToShortcutRemapInvoked`:** Logs an event when an app-specific shortcut to shortcut remap is invoked (emitted [here](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/dll/KeyboardEventHandlers.cpp#L320-L321)).
- **`KeyboardManager_AppSpecificShortcutToKeyRemapInvoked`:** Logs an event when an app-specific shortcut to key remap is invoked (emitted [here](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/dll/KeyboardEventHandlers.cpp#L320-L321)).
- **`KeyboardManager_Error`:** Logs the occurrence of an error in KBM with the name of the method, error code and the corresponding error message. This is currently used only for logging `SetWindowsHookEx` failures (emitted [here](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/dll/dllmain.cpp#L364-L369)).
@@ -34,7 +34,7 @@ In addition to this, if the user has opened the Type window, and the window is i
The [`SaveConfigToFile`](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/common/KeyboardManagerState.cpp#L500-L607) method is called on clicking the OK button on the EditKeyboardWindow or EditShortcutsWindow. Since PowerToys Settings also reads the config JSON file, [a named mutex is used](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/common/KeyboardManagerState.cpp#L582-L600) before accessing the file, with a 1 second timeout. If the mutex is obtained the settings are written to the default.json file.
### Concurrent Access to remap tables
To prevent the UI thread and low level hook thread from concurrently accessing the remap tables we use an [`atomic bool` variable](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/common/KeyboardManagerState.h#L91-L92), which is set to `true` while the tables are getting updated. When this is `true` the hook will skip all remappings. Use of mutexes in the hook were removed to prevent re-entrant mutex bugs.
To prevent the UI thread and low level hook thread from concurrently accessing the remap tables we use an [`atomic bool` variable](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/common/KeyboardManagerState.h#L91-L92), which is set to `true` while the tables are getting updated. When this is `true` the hook will skip all remappings. Use of mutexes in the hook were removed to prevent reentrant mutex bugs.
## KeyDelay
[This class](https://github.com/microsoft/PowerToys/blob/main/src/modules/keyboardmanager/common/KeyDelay.cpp) implements a queue based approach for processing key events and based on the time difference between key down and key up events [executes separate methods for `ShortPress`, `LongPress` or `LongPressReleased`](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/common/KeyDelay.h#L69-L72). The class is used for the hold Enter/Esc functionality required for making the Type window accessible and prevent keyboard traps (see [this](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/ui/SingleKeyRemapControl.cpp#L273-L292) for an example of it's usage). The `KeyEvents` are added to the queue from the hook thread of KBM, and a separate [`DelayThread`](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/common/KeyDelay.cpp#L142-L166) is used to process the key events by checking the `time` member in the key event. The thresholds for short vs long press and hold wait timeouts are `static` constants, but if the module is extended for other purposes these could be made into arguments.
@@ -28,7 +28,7 @@ The windows are [created as C++ windows](https://github.com/microsoft/PowerToys/
Once the UI controls are created, the parent container is set as the content for the `DesktopWindowXamlSource` and the `XamlBridge.MessageLoop` is executed. Messages are processed by the C++ window handler like [`EditKeyboardWindowProc`](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/ui/EditKeyboardWindow.cpp#L364-L404). The general structure we use for this is, for any `WM_PAINT` or `WM_SIZE` message we resize the Xaml Island window. For `WM_GETMINMAXINFO` we set minimum widths so that the window cannot be resized beyond a minimum height and width. This is done to prevent the WinUI elements from overlapping and getting cropped. If it is neither of these cases we send the message to the [`XamlBridge.MessageHandler`](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/ui/XamlBridge.cpp#L291-L301) which handles Destroy, Activation and Focus. If `WM_NCDESTROY` is received when the `XamlBridge` is `nullptr`, the window thread is terminated.
**Note:**`ContentDialog` in Xaml Islands requires manually settings a `XamlRoot`. This can generally be done by passing the XamlRoot from a component in the main window, such as the button used to open the dialog ([`sender.as<Button>().XamlRoot()`](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/ui/ShortcutControl.cpp#L31-L32)). [These docs]((https://docs.microsoft.com/en-us/uwp/api/windows.ui.xaml.controls.contentdialog#contentdialog-in-appwindow-or-xaml-islands)) have more details about this.
**Note:**`ContentDialog` in Xaml Islands requires manually settings a `XamlRoot`. This can generally be done by passing the XamlRoot from a component in the main window, such as the button used to open the dialog ([`sender.as<Button>().XamlRoot()`](https://github.com/microsoft/PowerToys/blob/b80578b1b9a4b24c9945bddac33c771204280107/src/modules/keyboardmanager/ui/ShortcutControl.cpp#L31-L32)). [These docs]((https://learn.microsoft.com/uwp/api/windows.ui.xaml.controls.contentdialog#contentdialog-in-appwindow-or-xaml-islands)) have more details about this.
### Debugging exceptions in XAML Islands
Sometimes if an exception occurs in XAML Islands, the stack trace may not always point to the correct code causing the exception and instead it will point to the Xaml Island message loop. In these cases the output window in VS will generally show the correct exception.
@@ -105,7 +105,7 @@ Once this second level of validation is done, we proceed with [updating the buff
Unlike the Single Key handler, there is a different set of errors that can occur here which are related to making a selection that is considered as a valid shortcut. The `isHybridControl` argument is used to distinguish between the differing behaviors for the two types of columns (shortcut only or shortcut/key column). The errors that can occur for this handler are:
- Shortcut must start with modifier (selecting A on the first drop for the left column is invalid)
- Shortcut can't have a repeated modifier (Ctrl+Ctrl(left)+A is not a shortcut)
- Shortcut can only have upto 2 modifiers (Ctrl+Shift+Alt is not supported as we have enforced a 3 key constraint (**not a backend limitation, there is [an issue](https://github.com/microsoft/PowerToys/issues/3936) requesting to remove this**))
- Shortcut can only have upto 2 modifiers (Ctrl+Shift+Alt is not supported as we have enforced a 3 key constraint (**not a backend limitation, there is [an issue](https://github.com/microsoft/PowerToys/issues/3936) requesting to remove this**))
- Shortcut must contain an action key (Ctrl+A and change A to None, only for left column)
- Shortcut must have at least two keys (Ctrl+A and change Ctrl to None, only for left column)
- Disable can't be a modifier or action key (Ctrl+Disable is invalid)
- [ ] The plugin is a project under `modules\launcher\Plugins`
- [ ] Microsoft plugin project name pattern: `Microsoft.PowerToys.Run.Plugin.{PluginName}`
- [ ] Community plugin project name pattern: `Community.PowerToys.Run.Plugin.{PluginName}`
- [ ] [`GlobalSuppressions.cs`](/src/codeAnalysis/GlobalSuppressions.cs) and [`StyleCop.json`](/src/codeAnalysis/StyleCop.json) have to be included in the plugin project so it follows PowerToys code guidelines
- [ ] The project file should import `Version.props` and specify `<Version>$(Version).0</Version>`
- [ ] Make sure `*.csproj` specify only x64 platform target
- [ ] The plugin has to contain a `plugin.json` file of the following format in its root folder
| `InputUseEnglishFormat` | `false` | Use English (United States) number format for input | Ignores your system setting and expects numbers in the format '1,000.50' |
| `OutputUseEnglishFormat` | `false` | Use English (United States) number format for output | Ignores your system setting and returns numbers in the format '1000.50' |
* The optional plugin settings are implemented via the [`ISettingProvider`](/src/modules/launcher/Wox.Plugin/ISettingProvider.cs) interface from `Wox.Plugin` project. All available settings for the plugin are defined in the [`Main`](/src/modules/launcher/Plugins/Microsoft.PowerToys.Run.Plugin.Calculator/Main.cs) class of the plugin.
- The [`CalculateHelper.cs`](src/modules/launcher/Plugins/Microsoft.PowerToys.Run.Plugin.Calculator/CalculateHelper.cs) class checks to see if the user entered query is a valid input to the calculator and only if the input is valid does it perform the operation.
- It does so by matching the user query to a valid regex.
- It does so by matching the user query to a valid regex.
- This class also handles some human multiplication expression like `2(1+2)` and `(2+3)(3+4)` in order to be computed by `Mages` lib.
- It does so by matching some regex and inserting `'*'` where appropriate, e.g: `2(1+2) -> 2 * (1+2)`
- It takes into account the combination of numbers (`num`), constants (`const`), functions (`func`) and expressions in parentheses (`(exp)`).
- The blank spaces between them are also considered.
- Some combinations were not handled as they are not common such as `'const num'` or `'func const'`
- The main computation is done in the [`CalculateEngine.cs`](src/modules/launcher/Plugins/Microsoft.PowerToys.Run.Plugin.Calculator/CalculateEngine.cs) file using the `Mages` library.
@@ -18,6 +39,26 @@ var result = CalculateEngine.Interpret(query.Search, CultureInfo.CurrentUICultur
- The class which encapsulates the result of the computation.
- It comprises of the `Result` and `RoundedResult` properties.
We have a [Unit Test project](/src/modules/launcher/Plugins/Microsoft.PowerToys.Run.Plugin.Calculator.UnitTests) that executes various test to ensure that the plugin works as expected.
- The [`BracketHelperTests.cs`](/src/modules/launcher/Plugins/Microsoft.PowerToys.Run.Plugin.Calculator.UnitTests/BracketHelperTests.cs) class contains tests to validate that brackets are handled correctly.
- The [`ExtendedCalculatorParserTests.cs`](/src/modules/launcher/Plugins/Microsoft.PowerToys.Run.Plugin.Calculator.UnitTests/ExtendedCalculatorParserTests.cs) class contains tests to validate that the input is parsed correctly and the result is correct.
- The [`NumberTranslatorTests.cs`](/src/modules/launcher/Plugins/Microsoft.PowerToys.Run.Plugin.Calculator.UnitTests/NumberTranslatorTests.cs) class contains tests to validate that each number is converted correctly based on the defined locals.
- The [`QueryTests.cs`](/src/modules/launcher/Plugins/Microsoft.PowerToys.Run.Plugin.Calculator.UnitTests/QueryTests.cs) class contains tests to validate that the user gets the correct results when searching.
The History Plugin allows users to search or display results they have used (selected).
## How it works
The plugin uses data that was already being captured which is, what results were clicked, and how many times. We do add a little more data to this set now.
When this plugin is queried, it creates results based on this previously selected results data.
In order to make sure selected results in the history are still valid, we re-query the plugin the relevant plug using the PluginManager. If there are no results,
this history item is not included. This usually means that the result is no longer valid. For instance, if a file was deleted, but it's still in the selected history
we don't want to show it as a selectable result.
Because the results from the History Plugin are actually created from calls to the PluginManager, they will be exactly the same is if they did not come from the History Plugin.
## Special notes
While the results returned from the plugin are from the PluginManager, they are sometimes modified before returning. One example is the Calculator plugin.
Since the Calculator plugin operates on the current query input by the user, the results from Calculator plugin don't include that in the title. However, as a history item,
the query is very important. In this case, and maybe others in the future, we modify the tile to also include the search.
### Modified title example:
This is what the Calculator plugin normally might show:
Access to PluginManager was needed to make this plugin work. Because of this a reference to PowerToys.PowerLauncher was needed.
Since History Plugin needs a reference to PowerToys.PowerLauncher, it can not be set as a dependency reference in PowerToys.PowerLauncher project (else a circular reference would exist).
This means that if you build PowerToys.PowerLauncher only it will not build History Plugin. You will need to manually build History Plugin at least once and again manually if you change it.
### Caching
Right now, there is no caching. But since this plugin does cause more queries than expected to many plugins, the `BuildResult` method is likely to be improved with some level of caching.
The OneNote plugin searches your locally synced OneNote notebooks based on the user query.

The code itself is very simple, basically just a call into OneNote interop via the https://github.com/scipbe/ScipBe-Common-Office library.
```csharp
varpages=OneNoteProvider.FindPages(query.Search);
```
The query results will be cached for 1 day, and if cached results are found they'll be returned in the initial `Query()` call, otherwise OneNote itself will be queried in the `delayedExecution:true` overload.
If the user actions on a result, it'll open it in the OneNote app, and restore and/or focus the app as well if necessary.
The plugin attempts to call the library in the constructor, and if it fails with a COMException then it'll note that OneNote isn't available and not attempt to query it again.
```csharp
try
{
_=OneNoteProvider.PageItems.Any();
_oneNoteInstalled=true;
}
catch(COMException)
{
// OneNote isn't installed, plugin won't do anything.
@@ -12,11 +12,11 @@ The registry plugin allows users to search the Windows registry.
The registry contains all settings for the Windows operating system and many settings of the installed (Windows only) programs.
*Note: Linux and macOS program ports typical store the settings in it's own configuration files and not in the Windows registry.*
*Note: Linux and macOS program ports typical store the settings in their own configuration files and not in the Windows registry.*
For more information about the Windows registry, see [the official documentation](https://docs.microsoft.com/en-us/windows/win32/sysinfo/registry).
For more information about the Windows registry, see [the official documentation](https://learn.microsoft.com/windows/win32/sysinfo/registry).
For advanced information about the Windows registry, see [Windows registry information for advanced users](https://docs.microsoft.com/en-us/troubleshoot/windows-server/performance/windows-registry-advanced-users).
For advanced information about the Windows registry, see [Windows registry information for advanced users](https://learn.microsoft.com/troubleshoot/windows-server/performance/windows-registry-advanced-users).
## Score
@@ -69,16 +69,14 @@ The plugin use only these interfaces (all inside the `Main.cs`):
| `Images\reg.light.png` | Symbol for the results for the light theme |
| `Properties\Resources.Designer.resx` | File that contain all translatable keys |
| `Properties\Resources.resx` | File that contain all translatable strings in the neutral language |
| `GlobalSuppressions.cs` | Code suppressions (no real file, linked via *.csproj) |
| `Main.cs` | Main class, the only place that implement the WOX interfaces |
| `plugin.json` | All meta-data for this plugin |
| `StyleCop.json` | Code style (no real file, linked via *.csproj) |
As the name suggests, the Sys Plugin is used to directly run Windows system commands that have been entered by the user as a query. This is done by parsing the entry and validating the command, followed by executing it.
* Shutdown
* Restart
* Sign Out
* Lock
* Sleep
* Hibernate
* Empty Recycle Bin

* Tries to parse the user input and returns a specific Windows system command by using a [`Result`](/src/modules/launcher/Wox.Plugin/Result.cs) list.
* While parsing, the Sys plugin uses [`FuzzyMatch`](/src/modules/launcher/Wox.Infrastructure/StringMatcher.cs) to get characters matching a result in the list.
### Score
* [`CalculateSearchScore`](/src/modules/launcher/Wox.Infrastructure/StringMatcher.cs) A match found near the beginning of a string is scored more than a match found near the end. A match is scored more if the characters in the patterns are closer to each other, while the score is lower if they are more spread out.
As the name suggests, the Windows System Commands Plugin is used to directly run Windows system commands that have been entered by the user as a query. This is done by parsing the entry and validating the command, followed by executing it.
The user can change the behavior of the plugin (language, confirmation dialog, ...) with optional plugin settings.

Available commands:
* Shutdown
* Restart
* Sign Out
* Lock
* Sleep
* Hibernate
* Open / Empty Recycle Bin
* UEFI Firmware Settings (Only available on systems, that boot in UEFI mode.)
* IP / MAC / Address => Show informations about network connections.
## Optional plugin settings
* We have the following settings that the user can configure to change the behavior of the plugin:
| Key | Default value | Name/Description |
|--------------|-----------|------------|
| `ConfirmSystemCommands` | `false` | Show a dialog to confirm system commands |
| `LocalizeSystemCommands` | `true` | Use localized system commands instead of English ones |
| `ReduceNetworkResultScore` | `true` | Reduce the priority of 'IP' and 'MAC' results to improve the order in the global results |
* The optional plugin settings are implemented via the [`ISettingProvider`](/src/modules/launcher/Wox.Plugin/ISettingProvider.cs) interface from `Wox.Plugin` project. All available settings for the plugin are defined in the [`Main`](/src/modules/launcher/Plugins/Microsoft.PowerToys.Run.Plugin.System/Main.cs) class of the plugin.
* Tries to parse the user input and returns a specific Windows system command by using a [`Result`](/src/modules/launcher/Wox.Plugin/Result.cs) list.
* While parsing, the plugin uses [`FuzzyMatch`](/src/modules/launcher/Wox.Infrastructure/StringMatcher.cs) to get characters matching a result in the list.
- The [`Commands`](/src/modules/launcher/Plugins/Microsoft.PowerToys.Run.Plugin.System/Components/Commands.cs) class contains the definition of all available commands/results.
- The [`ResultHelper`](/src/modules/launcher/Plugins/Microsoft.PowerToys.Run.Plugin.System/Components/ResultHelper.cs) class contains methods for working with the results and some of the result features (tool tip, copy to clipboard, execute command).
- **Recycle Bin command:** The context menu action to empty the Recycle Bin is executed as an async task to not block PowerToys Run. (While the task is running the static class variable `executingEmptyRecycleBinTask` is set to true, to block multiple executions at the same time)
- The [`NetworkConnectionProperties`](/src/modules/launcher/Plugins/Microsoft.PowerToys.Run.Plugin.System/Components/NetworkConnectionProperties.cs) class contains methods to get the properties of a network interface/connection.
- An instance of this class collects/provides all required informations about one connection/adapter.
- An instance of the class [`SystemPluginContext`](/src/modules/launcher/Plugins/Microsoft.PowerToys.Run.Plugin.System/Components/SystemPluginContext.cs) contains/defines the context data of a system plugin result. We select the context menu based on the defined properties.
- It is used for the `ContextData` property of the [`Wox.Plugin.Result`](/src/modules/launcher/Wox.Plugin/Result.cs).
### UEFI command
* The UEFI command is only available on systems, that boot in UEFI mode.
* This is validated by checking the result of the method [`GetSystemFirmwareType`](/src/modules/launcher/Wox.Plugin/Common/Win32/Win32Helpers.cs), which uses the native method [`GetFirmwareType`](/src/modules/launcher/Wox.Plugin/Common/Win32/NativeMethods.cs) in `kernel32.dll`.
## Search
### Score
* [`CalculateSearchScore`](/src/modules/launcher/Wox.Infrastructure/StringMatcher.cs) A match found near the beginning of a string is scored more than a match found near the end. A match is scored more if the characters in the patterns are closer to each other, while the score is lower if they are more spread out.
* For network results (IP address and MAC address) the score is reduced by 25 percent.
### Network results on global queries
- The network results (IP and MAC address) are only shown on global queries, if the search term starts with either IP, MAC or Address. (We compare case-insensitive.)
### Returning results
We return the results in two steps:
1. All results which we can create very fast like shutdown or logoff via [`Main.Query(Query query)`](/src/modules/launcher/Plugins/Microsoft.PowerToys.Run.Plugin.System/Main.cs).
2. All results which need some time to create like the network results (IP, MAC) via [`Main.Query(Query query, bool delayedExecution)`](/src/modules/launcher/Plugins/Microsoft.PowerToys.Run.Plugin.System/Main.cs).
We have a [Unit Test project](/src/modules/launcher/Plugins/Microsoft.PowerToys.Run.Plugin.System.UnitTests) that executes various test to ensure that the plugin works as expected.
- The [`ImageTests.cs`](/src/modules/launcher/Plugins/Microsoft.PowerToys.Run.Plugin.System.UnitTests/ImageTests.cs) class contains tests to validate that each result shows the expected and correct image.
- The [`QueryTests.cs`](/src/modules/launcher/Plugins/Microsoft.PowerToys.Run.Plugin.System.UnitTests/QueryTests.cs) class contains tests to validate that the user gets the correct results when searching.
The 'Time and Date' plugin shows the date and time in different formats. For the date and time formats the plugin uses the culture setting in Windows, if the format is not commonly defined. The user can search for the system date/time or a custom date/time. The value of each result can be copied to clipboard.
**Query examples:**
- Format: `time`
- Date/time: `10:30 AM`
- Format and date/time: `Week number::10/10/2022`


## Formats
### Available formats
**Remarks**
- The following formats requires a prefix in the query:
- Unix Timestamp: `u`
- Windows file time: `ft`
- On invalid number inputs we show a warning that tells the user which prefixes are allowed/required.
**List of available formats**
The following formats are currently available:
| Format | Example (Based on default settings) | As result | As input |
| Week of the year (Calendar week, Week number) | 10 | x | |
| Month | March | x | |
| Month of the year | 3 | x | |
| Month and day | March 7 | x | x |
| Year | 2022 | x | |
| Era | AD | x | |
| Era abbreviation | A | x | |
| Month and year | March 2022 | x | x |
| Windows file time (Int64 number) | 637820976123938199 | x | x |
| Universal time format: YYYY-MM-DD hh:mm:ss| 2022-03-05 16:20:12Z | x | x |
| ISO 8601 | 2022-03-05T17:23:04 | x | x |
| ISO 8601 UTC | 2022-03-05T16:23:04 | x | x |
| ISO 8601 with time zone | 2022-03-05T17:23:04+01:00 | x | x |
| ISO 8601 UTC with time zone | 2022-03-05T16:23:04Z | x | x |
| RFC1123 | Sat, 05 Mar 2022 16:23:04 GMT | x | x |
### Add new formats
- To add a new formats you have to add them to the method `GetList()` of the [`AvailableResultsList`](/src/modules/launcher/Plugins/Microsoft.PowerToys.Run.Plugin.TimeDate/Components/AvailableResultsList.cs) class.
- Please add the new formats in the second range. The first one is reserved for the three main formats (Time, Date, Now).
- After adding the new formats you have to update the Unit Tests!
## Optional plugin settings
- The optional plugin settings are implemented via the [`ISettingProvider`](/src/modules/launcher/Wox.Plugin/ISettingProvider.cs) interface from `Wox.Plugin` project.
- All available settings for the plugin are defined in the [`TimeDateSettings`](/src/modules/launcher/Plugins/Microsoft.PowerToys.Run.Plugin.TimeDate/Components/TimeDateSettings.cs) class of the plugin. The settings can be accessed everywhere in the plugin code via the static class instance `TimeDateSettings.Instance`.
- We have the following settings that the user can configure to change the behavior of the plugin:
| `OnlyDateTimeNowGlobal` | `true` | Show only 'Time', 'Date', and 'Now' result for system time on global queries | Regardless of this setting, for global queries the first word of the query has to be a complete match. |
| `TimeWithSeconds` | `false` | Show time with seconds | This setting applies to the 'Time' and 'Now' result. |
| `DateWithWeekday` | `false` | Show date with weekday and name of month | This setting applies to the 'Date' and 'Now' result. |
| `HideNumberMessageOnGlobalQuery` | `false` | Hide 'Invalid number input' error message on global queries | |
- Each instance of the [`AvailableResult`](/src/modules/launcher/Plugins/Microsoft.PowerToys.Run.Plugin.TimeDate/Components/AvailableResult.cs) class represents a time/date result/format that the user can search for.
- The results/formats are defined in the `AvailableResultsList` class.
- The [`AvailableResultsList`](/src/modules/launcher/Plugins/Microsoft.PowerToys.Run.Plugin.TimeDate/Components/AvailableResultsList.cs) class contains the list of available formats/results in its method `GetList()`.
- The [`ResultHelper`](/src/modules/launcher/Plugins/Microsoft.PowerToys.Run.Plugin.TimeDate/Components/ResultHelper.cs) class contains methods for some of the result features (tool tip, copy to clipboard) and the error result on incorrect number input.
- And it contains the `SelectStringFromResources()` method for getting the resource strings based on the user input.
- The method has a parameter for the `stringId` which is the name of the string in the resource file. By default the word `Now` is automatically added at the end to get the string for a system time/date search.
- If a different/custom string is needed for a system time/date search the parameter `stringIdNow` can be used to override the default behavior of the method.
- If only a string for the system time/date search is required, you can set `stringId` to `string.Empty` and only `stringIdNow` to a valid string id.
- The [`TimeAndDateHelper`](/src/modules/launcher/Plugins/Microsoft.PowerToys.Run.Plugin.TimeDate/Components/TimeAndDateHelper.cs) class contains methods to format/convert date and time formats/strings.
- The [`TimeDateSettings`](/src/modules/launcher/Plugins/Microsoft.PowerToys.Run.Plugin.TimeDate/Components/TimeDateSettings.cs) class provides access to all optional plugin settings.
- The class has a static property called `Instance` that holds an instance of the class itself. This allows us to access the settings from everywhere in the plugin code without having additional parameters in our methods.
- The [`SearchController`](/src/modules/launcher/Plugins/Microsoft.PowerToys.Run.Plugin.TimeDate/Components/SearchController.cs) encapsulates the methods needed to search and find matches.
## Search
### Tags
- We compare the user input with the label of each results. If it doesn't match we search the tags of the result too.
- For each result two tag strings are defined. One for a search with system time/date and one for a search with a custom time/date. Most of the results (except the era results) are using one of the generic tag lists: Date, Time or Format
- The selection of the tag (for "system time/date" or "custom time/date") is happening at search time in the `AvailableResultsList.cs` class.
- The different tags in a list are split by the `;` character.
### Score
- The plugin uses `FuzzyMatching` to get the matching formats, if the user searches for a specific format. The score is set based on the `FuzzySearch` result.
- To achieve a better balance between sub title matches and tag matches the score of tag matches is divided by two.
### Match requirements for global queries
On global queries the high score returned by `FuzzySearch` has negative impacts on the user experience and the search results priority/order of other plugins. To mitigate this we defined some matching requirements:
- If the query is a word of the following conjunction list, we don't return any results: for, and, nor, but, or, so
- We don't have 'yet' (synonym of 'now') on the list, because this could block results in some languages.
- The first word of the query has to be a full match with a word in the label or tag list.
- For both requirements we compare case-insensitive.
We have a [Unit Test project](/src/modules/launcher/Plugins/Microsoft.PowerToys.Run.Plugin.TimeDate.UnitTests) that executes various test to ensure that the plugin works as expected.
- The [`TimeDateResultTests.cs`](/src/modules/launcher/Plugins/Microsoft.PowerToys.Run.Plugin.TimeDate.UnitTests/TimeDateResultTests.cs) class contains tests to validate that the time and date values are correctly formatted/calculated.
- That we can execute the tests at any time on any machine, we use a specified date/time value and set the thread culture always to `en-us` while executing the tests.
- Some tests contain checks that calculate the expected result at runtime instead of using an expected value written fix in the code. This is done to get valid results on every machine at any time.
- The [`ImageTests.cs`](/src/modules/launcher/Plugins/Microsoft.PowerToys.Run.Plugin.TimeDate.UnitTests/ImageTests.cs) class contains tests to validate that each result shows the expected and correct image.
- That we can execute the tests at any time on any machine, we set the thread culture always to `en-us` while executing the tests.
- The [`PluginSettingsTests.cs`](/src/modules/launcher/Plugins/Microsoft.PowerToys.Run.Plugin.TimeDate.UnitTests/PluginSettingsTests.cs) class contains tests to validate that all settings exist and that they have the correct default values.
- The [`QueryTests.cs`](/src/modules/launcher/Plugins/Microsoft.PowerToys.Run.Plugin.TimeDate.UnitTests/QueryTests.cs) class contains tests to validate that the user gets the correct results when searching.,
- That we can execute the tests at any time on any machine, we set the thread culture always to `en-us` while executing the tests.
- The [`StringParserTests.cs`](/src/modules/launcher/Plugins/Microsoft.PowerToys.Run.Plugin.TimeDate.UnitTests/StringParserTests.cs) class contains tests to validate that the typed string gets converted correctly into a `DateTime` object.
- That we can execute the tests at any time on any machine, we set the thread culture always to `en-us` while executing the tests.
@@ -61,7 +61,8 @@ A full entry for the `WindowsSettings.json` looks like:
* The integer value for `IntroducedInBuild` and `DeprecatedInBuild` must be in range of `0` to `4294967295`
* The strings for `Name`, `AltNames`, `Areas`, `Type` and `Note` must not contain whitespace(s) or special characters (#, €, $, etc.)
* The strings for `Name`, `AltNames`, `Areas`, `Type` and `Note` are used as ids for the resource file under `Properties\Resources.resx`
* When you add new strings make sure you have add add all translations for it.
* When you add new strings make sure you have added all translations for it.
* If a result has `mmc.exe` as command and the note property is filled, the note is shown in the sub title too. (This is for special MMC results where we don't have a .msc file.)
## Scores
@@ -129,10 +130,8 @@ The plugin use only these interfaces (all inside the `Main.cs`):
| `Images\WindowsSettings.light.png` | Symbol for the results for the light theme |
| `Properties\Resources.Designer.resx` | File that contain all translatable keys |
| `Properties\Resources.resx` | File that contain all translatable strings in the neutral language |
| `GlobalSuppressions.cs` | Code suppressions (no real file, linked via *.csproj) |
| `Main.cs` | Main class, the only place that implement the WOX interfaces |
| `plugin.json` | All meta-data for this plugin |
| `StyleCop.json` | Code style (no real file, linked via *.csproj) |
1. We need this extra wrapper class to make it possible that the JSON file can have and use a JSON schema file.
Because the JSON file must have a object as root type, instead of a array.
@@ -141,7 +140,7 @@ Because the JSON file must have a object as root type, instead of a array.
The window walker plugin matches the user entered query with the open windows on the system.
The user can switch to the found windows, close them or kill their process.

## Remarks
### UWP Apps
- The process of an UWP app can't be detected correctly for windows that are minimized while searching. At this time they are assigned to the generic process `ApplicationFrameHost.exe`. If the user searches for such an window while it is not minimized, then the process gets assigned correctly/updated.
### Killing processes
- Killing the Explorer process is only allowed, if each folder window is running in its own process. (See section `File Explorer setting` below.)
- You can only kill elevated processes, if you have admin permissions (UAC).
- If you kill the process of an UWP app window, you kill all instances of the app. All windows are assigned to the same process.
- Windows of UWP apps don't know their process, until they are searched in non-minimized state.
### File Explorer setting
- To kill the Process of an Explorer window, each window has to run in a separate process. Otherwise the process is the same one as the shell process and killing the shell process will crash the shell (Windows ui).
- To enable this behavior the setting `Launch folder windows in a separate process` under `Folder Options > View` has to be enabled.
- From PowerToys Run you can open the `Folder options` dialog by clicking the information message in the search results. The information message is only shown when searching with action keyword for explorer windows and can be hidden in the plugin settings.
- Note: The folder option/process is evaluated in real time. After changing the setting it is enough to search again for the windows.

## Optional plugin settings
- The optional plugin settings are implemented via the [`ISettingProvider`](/src/modules/launcher/Wox.Plugin/ISettingProvider.cs) interface from `Wox.Plugin` project.
- All available settings for the plugin are defined in the [`WindowWalkerSettings`](/src/modules/launcher/Plugins/Microsoft.Plugin.WindowWalker/Components/WindowWalkerSettings.cs) class of the plugin. The settings can be accessed everywhere in the plugin code via the static class instance `WindowWalkerSettings.Instance`.
- We have the following settings that the user can configure to change the behavior of the plugin:
| Key | Default value | Name/Description |
|--------------|-----------|------------|
| `ResultsFromVisibleDesktopOnly` | `false` | Show only results from visible desktop |
| `SubtitleShowPid` | `false` | Show process id in subtitle |
| `SubtitleShowDesktopName` | `true` | Show desktop name in subtitle (If two or more desktops exist) |
| `ConfirmKillProcess` | `true` | Request confirmation when killing a process |
| `KillProcessTree` | `false` | Kill process and it's child processes |
| `OpenAfterKillAndClose` | `false` | Stay open after closing windows and killing processes (Not working with kill process confirmation) |
- The window walker plugin uses the `EnumWindows` function to enumerate all the open windows in the [`OpenWindows.cs`](/src/modules/launcher/Plugins/Microsoft.Plugin.WindowWalker/Components/OpenWindows.cs) class.
@@ -11,11 +52,33 @@ The window walker plugin matches the user entered query with the open windows on
- It is responsible for updating the search text and performing a fuzzy search on all the open windows.
- The [`Window`](/src/modules/launcher/Plugins/Microsoft.Plugin.WindowWalker/Components/Window.cs) class represents a specific window and has functions to get the name of the window, the state of the window (whether it is visible or not), and the `SwitchTowindow` function which switches the desktop focus to the selected window. This action is performed when the user clicks on a window walker plugin result.
- The [`Window`](/src/modules/launcher/Plugins/Microsoft.Plugin.WindowWalker/Components/Window.cs) class represents a specific window and has functions to get the name of the window, the state of the window (whether it is visible or not), the `SwitchTowindow` function which switches the desktop focus to the selected window and the `CloseThisWindow` function which closes the window. The `SwitchTowindow` action is performed when the user clicks on a window walker plugin result.
- The `Window` class holds a static cache with the process information of all windows we know so far and each window instance has a property which holds its process information (name, file, ...). The process data in the cache and the window property are of the type `WindowProcess`.
- To get the desktop information for a window, we use the common [`VirtualDesktopHelper`](/src/modules/launcher/Wox.Plugin/Common/VirtualDesktop/VirtualDesktopHelper.cs) in `Wox.Plugin` project. The instance of `VirtualDesktopHelper` is cached in the [`Main`](/src/modules/launcher/Plugins/Microsoft.Plugin.WindowWalker/Main.cs) class of the plugin at runtime. The desktop information is stored in a property of the type [`VDesktop`](/src/modules/launcher/Wox.Plugin/Common/VirtualDesktop/VDesktop.cs).
- The [`WindowProcess`](/src/modules/launcher/Plugins/Microsoft.Plugin.WindowWalker/Components/WindowProcess.cs) class represents a specific process for a window. It contains static methods to query process information from the system. And it contains instance methods and properties to hold/retrieve the process information we want to know about a window's process.
- The [`WindowProcess`](/src/modules/launcher/Plugins/Microsoft.Plugin.WindowWalker/Components/WindowProcess.cs) class represents a specific process for a window.
- It contains static methods to query process information from the system and instance methods/properties to hold/retrieve the process information we want to know about a window's process.
- Additionally, it contains the method `KillThisProcess` to kill the process. (If the user has not enough permissions to kill a process they are requested via UAC.)
- The [`ResultHelper`](/src/modules/launcher/Plugins/Microsoft.Plugin.WindowWalker/Components/ResultHelper.cs) class contains the code to create the list with all results for PT Run based on the data returned from `SearchController` class.
- There is a special result that is added if the folder windows doesn't run in separate processes and the user searches for Explorer windows using the action keyword.
- This result informs the user that there is a setting that must be enabled to be able to kill Explorer processes.
- The result can be disabled in plugin options. When it is clicked it opens the folder options.
- The [`ContextMenuHelper`](/src/modules/launcher/Plugins/Microsoft.Plugin.WindowWalker/Components/ContextMenuHelper.cs) class provides the code for the context menu items.
- The [`WindowWalkerSettings`](/src/modules/launcher/Plugins/Microsoft.Plugin.WindowWalker/Components/WindowWalkerSettings.cs) class provides access to all optional plugin settings.
- The class has a static property called `Instance` that holds an instance of the class itself. This allows us to access the settings from everywhere in the plugin code without having additional parameters in our methods.
### Score
The window walker plugin uses [`FuzzyMatching`](/src/modules/launcher/Plugins/Microsoft.Plugin.WindowWalker/Components/FuzzyMatching.cs) to get the matching indices and calculates the score by creating a 2 dimensional array of the window and the query text.
We have a [Unit Test project](/src/modules/launcher/Plugins/Microsoft.Plugin.WindowWalker.UnitTests) that executes various test to ensure that the plugin works as expected.
- The [`PluginSettingsTests.cs`](/src/modules/launcher/Plugins/Microsoft.Plugin.WindowWalker.UnitTests/PluginSettingsTests.cs) class contains tests to validate that all settings exist and that they have the correct default values.
@@ -9,13 +9,15 @@ Developer preview is based on [Microsofts Monaco Editor](https://microsoft.githu
3. Copy the `min` folder inside the [`monacoSRC`](/src/modules/previewpane/MonacoPreviewHandler/monacoSRC) folder.
4. Generate the JSON file (see section below)
## languages.json
## monaco_languages.json
[`languages.json`](/src/modules/previewpane/MonacoPreviewHandler/languages.json) contains all extensions and Id's for the supported languages of Monaco. The [`FileHandler`](/src/modules/previewpane/MonacoPreviewHandler/FileHandler.cs) class and the installer are using this file.
[`monaco_languages.json`](/src/modules/previewpane/MonacoPreviewHandler/monaco_languages.json) contains all extensions and Id's for the supported languages of Monaco. The [`FileHandler`](/src/modules/previewpane/MonacoPreviewHandler/FileHandler.cs) class and the installer are using this file.
### Generate languages.json file
### Generate monaco_languages.json file
After you updated monaco editor or adding a new language you should update the [`languages.json`](/src/modules/previewpane/MonacoPreviewHandler/languages.json) file.
After you updated monaco editor or adding a new language you should update the [`monaco_languages.json`](/src/modules/previewpane/MonacoPreviewHandler/monaco_languages.json) file.
You have to run the file on a local webserver!
1. Build monaco in debug mode.
2. Open [generateLanguagesJson.html](/src/modules/previewpane/MonacoPreviewHandler/generateLanguagesJson.html) in a browser.
@@ -18,7 +18,7 @@ Once you've discussed your proposed feature/fix/etc. with a team member, and you
- Package new ideas into classes or refactor existing ideas into a class as you extend.
- When adding new classes/methods/changing existing code: add new unit tests or update the existing tests.
## Github Workflow
## GitHub Workflow
- Before starting to work on a fix/feature, make sure there is an open issue to track the work.
- Add the `In progress` label to the issue, if not already present also add a `Cost-Small/Medium/Large` estimate and make sure all appropriate labels are set.
@@ -38,15 +38,17 @@ Once you've discussed your proposed feature/fix/etc. with a team member, and you
### Prerequisites for Compiling PowerToys
1. Windows 10 April 2018 Update (version 1803) or newer
2. Visual Studio Community/Professional/Enterprise 2019
3.Once you've cloned and started the `PowerToys.sln`, in the solution explorer, if you see a dialog that says `install extra components`, click `install`
1. Visual Studio Community/Professional/Enterprise 2022 17.4 or newer
1.Git clone PowerToys repository
1. Open the `PowerToys.sln` file.
1. If you see a dialog that says `install extra components` in the solution explorer pane, click `install`
### Get Submodules to compile
We have submodules that need to be initialized before you can compile most parts of PowerToys. This should be a one time step.
1. Open a terminal
2. Navigate to the folder you cloned PowerToys to.
3. Run `git submodule update --init --recursive`
1. Navigate to the folder you cloned PowerToys to.
1. Run `git submodule update --init --recursive`
### Compiling Source Code
@@ -63,32 +65,57 @@ Our installer is two parts, an EXE and an MSI. The EXE (Bootstrapper) contains
The installer can only be compiled in `Release` mode, step 1 and 2 must be done before the MSI will be able to be compiled.
1. Compile `PowerToys.sln`. Instructions are listed above.
1. Compile `PowerToysSetup.sln` Path from root: `installer\PowerToysSetup.sln` (details listed below)
### Prerequisites for building the MSI installer
1. Install the [WiX Toolset Visual Studio 2019 Extension](https://marketplace.visualstudio.com/items?itemName=WixToolset.WixToolsetVisualStudio2019Extension).
2. Install the [WiX Toolset build tools](https://wixtoolset.org/releases/).
1. Install the [WiX Toolset Visual Studio 2022 Extension](https://marketplace.visualstudio.com/items?itemName=WixToolset.WixToolsetVisualStudio2022Extension).
1. Install the [WiX Toolset build tools](https://wixtoolset.org/docs/v3/releases/v3-14-0-6526/). (installer [direct link](https://wixtoolset.org/downloads/v3.14.0.6526/wix314.exe))
1. Download [WiX binaries](https://wixtoolset.org/downloads/v3.14.0.6526/wix314-binaries.zip) and extract `wix.targets` to `C:\Program Files (x86)\WiX Toolset v3.14`.
### Locally building the installer prerequisite projects all at once from the command-line
Contains the executable starting point, initialization code and the list of known PowerToys. All singletones are also initialized here at the start. Loads all the powertoys by scanning the `./modules` folder and `enable()`s those marked as enabled in `%LOCALAPPDATA%\Microsoft\PowerToys\settings.json` config. Then it runs [a message loop](https://docs.microsoft.com/en-us/windows/win32/winmsg/using-messages-and-message-queues) for the tray UI. Note that this message loop also [handles lowlevel_keyboard_hook events](https://github.com/microsoft/PowerToys/blob/1760af50c8803588cb575167baae0439af38a9c1/src/runner/lowlevel_keyboard_event.cpp#L24).
Contains the executable starting point, initialization code and the list of known PowerToys. All singletones are also initialized here at the start. Loads all the powertoys by scanning the `./modules` folder and `enable()`s those marked as enabled in `%LOCALAPPDATA%\Microsoft\PowerToys\settings.json` config. Then it runs [a message loop](https://learn.microsoft.com/windows/win32/winmsg/using-messages-and-message-queues) for the tray UI. Note that this message loop also [handles lowlevel_keyboard_hook events](https://github.com/microsoft/PowerToys/blob/1760af50c8803588cb575167baae0439af38a9c1/src/runner/lowlevel_keyboard_event.cpp#L24).
#### [`powertoy_module.h`](/src/runner/powertoy_module.h) and [`powertoy_module.cpp`](/src/runner/powertoy_module.cpp)
Contains code for initializing and managing the PowerToy modules. `PowertoyModule` is a RAII-style holder for the `PowertoyModuleIface` pointer, which we got by [invoking module DLL's `powertoy_create` function](https://github.com/microsoft/PowerToys/blob/1760af50c8803588cb575167baae0439af38a9c1/src/runner/powertoy_module.cpp#L13-L24).
@@ -17,7 +17,7 @@ Contains code for registering a Windows event hook through `SetWinEventHook`, th
Contains code for managing the PowerToys tray icon and its menu commands. Note that `dispatch_run_on_main_ui_thread` is used to
transfer received json message from the [Settings window](/doc/devdocs/settings.md) to the main thread, since we're communicating with it from [a dedicated thread](https://github.com/microsoft/PowerToys/blob/7357e40d3f54de51176efe54fda6d57028837b8c/src/runner/settings_window.cpp#L267-L271).
Contains code for starting the PowerToys settings window and communicating with it. Settings window is a separate process, so we're using [Windows pipes](https://docs.microsoft.com/en-us/windows/win32/ipc/pipes) as a transport for json messages.
Contains code for starting the PowerToys settings window and communicating with it. Settings window is a separate process, so we're using [Windows pipes](https://learn.microsoft.com/windows/win32/ipc/pipes) as a transport for json messages.
`Settingsv2` is WPF .net core desktop application. It uses the `WindowsXamlHost` control from the Windows Community Toolkit to host UWP controls from `WinUI3` library. More details about WinUI can be found [here](https://microsoft.github.io/microsoft-ui-xaml/about.html#what-is-it).
`Settings` is Windows App Sdk WinUI3 .Net Unpackaged desktop application. More details about Windows App Sdk can be found [here](https://github.com/microsoft/WindowsAppSDK#windows-app-sdk---calling-all-windows-developers). More details about WinUI can be found [here](https://microsoft.github.io/microsoft-ui-xaml/about.html#what-is-it).
## Settings V2 Project structure
The Settings project is a XAML island based project which
The Settings project .Net WinUI3 based project which
follows the [MVVM architectural pattern][MVVM] where the graphical user interface is separated from the view models.
The UI Components are part of PowerToys.Settings project. It contains the xaml files for each of the UI components. It also contains the Hotkey logic for the settings control.
The function of the settings runner project is to communicate all changes that the user makes in the user interface, to the runner so that it can be dispatched and reflected in all the modules.
@@ -4,7 +4,7 @@ The Settings v2 process uses two way IPC to communicate with the runner process.
## Initialization
- On the settings' side, the two way IPC delegates are contained with the [`ShellPage.xaml.cs`](/src/settings-ui/Settings.UI/Views/ShellPage.xaml.cs) file. The delegates are static and the views for all the powerToys send the ipc information to the viewmodels as `ShellPage.DefaultSndMSGCallBack`.
- These delegates are initialized within the [`Mainwindow.xaml.cs`](/src/settings-ui/PowerToys.Settings/MainWindow.xaml.cs) file in the `Settings.Runner` project.
- These delegates are initialized within the [`Mainwindow.xaml.cs`](/src/settings-ui/Settings.UI/MainWindow.xaml.cs) file in the `Settings.Runner` project.
The UI code is distributed between two projects: [`PowerToys.Settings`](/src/settings-ui/PowerToys.Settings) and [`Settings.UI`](/src/settings-ui/Settings.UI.Library). [`PowerToys.Settings`](/src/settings-ui/PowerToys.Settings) is a WPF .net core application. It contains the parent display window and corresponding code is present in [`MainWindow.xaml.`](/src/settings-ui/PowerToys.Settings/MainWindow.xaml) [`Settings.UI`](/src/settings-ui/Settings.UI.Library) is UWP applications and contains views for base navigation and modules. Fig 1 provides a description of the UI controls hierarchy and each of the controls have been summarized below :
- [`MainWindow.xaml`](/src/settings-ui/PowerToys.Settings/MainWindow.xaml) is the parent WPF control.
-`WindowsXamlHost` control is used to host UWP control to [`MainWindow.xaml`](/src/settings-ui/PowerToys.Settings/MainWindow.xaml) parent control.
- [`ShellPage.xaml`](/src/settings-ui/Settings.UI/Views/ShellPage.xaml) is a UWP control, consisting of a side navigation panel with an icon for each module. Clicking on a module icon loads the corresponding `setting.json` file and displays the data in the UI.
The UI code is distributed between two projects: [`PowerToys.Settings`](/src/settings-ui/Settings.UI) and [`Settings.UI`](/src/settings-ui/Settings.UI.Library). [`PowerToys.Settings`](/src/settings-ui/Settings.UI) is a Windows App Sdk .net Unpackaged application. It contains the views for base navigation and modules. Parent display window and corresponding code is present in [`MainWindow.xaml.`](/src/settings-ui/Settings.UI/MainWindow.xaml). Fig 1 provides a description of the UI controls hierarchy and each of the controls have been summarized below :
- [`ShellPage.xaml`](/src/settings-ui/Settings.UI/Views/ShellPage.xaml) is a WinUI control, consisting of a side navigation panel with an icon for each module. Clicking on a module icon loads the corresponding `setting.json` file and displays the data in the UI.
// XAML Islands: If the window is closed while minimized, exit the process. Required to avoid process not terminating issue - https://github.com/microsoft/PowerToys/issues/4430
if (WindowState == WindowState.Minimized)
{
// Run Environment.Exit on a separate task to avoid performance impact
3. Workaround to prevent XAML Island failing to render on Nvidia workstation graphics cards:
```
// XAML Islands: If the window is open, explicitly force it to be shown to solve the blank dialog issue https://github.com/microsoft/PowerToys/issues/3384
This tool is used to collect logs and system information for bug reports. The bug report is then saved as a zip file on the desktop.
## Launching
It can launch from the PowerToys tray icon by clicking "Report Bug", by clicking the bug report icon in the PowerToys flyout or by running the executable directly.
## Included files
The bug report includes the following files:
* Settings files of the modules.
* Logs of the modules and the runner.
* Update log files.
*`compatibility-tab-info.txt` - Information about [compatibility settings](https://support.microsoft.com/windows/make-older-apps-or-programs-compatible-with-windows-783d6dd7-b439-bdb0-0490-54eea0f45938) set for certain PowerToys executables both in the user and system scope.
*`context-menu-packages.txt` - Information about the packages that are registered for the new Windows 11 context menu.
*`dotnet-installation-info.txt` - Information about the installed .NET versions.
*`EventViewer-*.xml` - These files contain event logs from the Windows Event Viewer for the executable specified in the file name.
*`gpo-configuration-info.txt` - Information about the configured [GPO](/doc/gpo/README.md).
*`installationFolderStructure.txt` - Information about the folder structure of the installation. All lines with files have the following structure: `FileName Version MD5Hash`.
*`last_version_run.json` - Information about the last version of PowerToys that was run.
*`log_settings.json` - Information about the log level settings.
*`monitor-report-info.txt` - Information about the monitors connected to the system. This file is created by the [monitor info report tool](/doc/devdocs/tools/monitor-info-report.md).
*`oobe_settings.json` - Information about the OOBE settings.
*`registry-report-info.txt` - Information about the registry keys that are used by PowerToys.
*`settings_placement.json` - Information about the placement of the settings window.
*`settings-telemetry.json` - Information about the last time telemetry data was sent.
*`UpdateState.json` - Information about the last update check and the current status of the update download.
*`windows-settings.txt` - Information about the Windows language settings.
*`windows-version.txt` - Information about the Windows version.
This script converts a .resx file to a .rc file, so it can be used in a C++ project. More information on localization can be found in the [localization guide](/doc/devdocs/localization.md).
This script converts a stringtable to a .resx file, so it can be used in a C# project. More information about this script can be found in the [localization guide](/doc/devdocs/localization.md).
# [FancyZone hit test tool](/tools/FancyZone_HitTest/)

This tool tests the FancyZones layout selection logic. It displays a window with 5 zones. By hovering the mouse over the zones, the zone under the mouse cursor is highlighted. The sidebar shows different metrics that are used to determine which zone is under the mouse cursor.
This test tool is created in order to debug issues related to the drawing of zone layout on screen.
Currently, only column layout is supported with modifiable number of zones. Pressing **w** key toggles zone appearance on primary screen (multi monitor support not yet in place). Pressing **q** key exits application.
Application is DPI unaware which means that application does not scale for DPI changes and it always assumes to have a scale factor of 100% (96 DPI). Scaling will be automatically performed by the system.
Application is DPI unaware which means that application does not scale for DPI changes and it always assumes to have a scale factor of 100% (96 DPI). Scaling will be automatically performed by the system.

This command line application tests if the window where the mouse cursor is located is zonable. It also adds additional information about the window to the console output:
Tools in PowerToys are standalone apps and scripts that run outside of the PowerToys runner. They help developers and users to debug and test PowerToys features.
The source code of the tools can be found in the [tools folder](/tools). The compiled tools are saved under `{PowerToysInstallPath}\tools`.
## Overview of the tools
Following tools are currently available:
* [BugReportTool](bug-report-tool.md) - A tool to collect logs and system information for bug reports.
* [Build tools](build-tools.md) - A set of scripts that help building PowerToys.
* [Clean up tool](clean-up-tool.md) - A tool to clean up the PowerToys installation.
* [FancyZones hit test](fancyzone-hit-test.md) - A tool to test FancyZones layout selection logic.
* [FancyZones draw layout test](fancyzones-draw-layout-test.md) - A tool to test FancyZones layout drawing logic.
* [FancyZones zonable tester](fancyzones-zonable-tester.md) - A tool to test if a window is zonable.
* [Monitor info report](monitor-info-report.md) - A small diagnostic tool which helps identifying WinAPI bugs related to the physical monitor detection.
* [project template](/tools/project_template/README.md) - A Visual Studio project template for a new PowerToys project.
* [StylesReportTool](styles-report-tool.md) - A tool to collect information about an open window.
* [Verification scripts](verification-scripts.md) - A set of scripts that help verifying the PowerToys installation.
* [WebcamReportTool](webcam-report-tool.md) - A tool to collect information about the connected webcams.
The Styles Report Tool is a tool to collect information about an open window. Run the tool, bring the window to the foreground and press Ctrl+Alt+S. The tool will create a file on your desktop called `window_styles.txt` with the information about the window.
## Collected information
* Process name
* Window class
* Window style parameters
* Window exStyle parameters
* DWM attributes
* Infos about the Virtual Desktop the window is on
This command line application generates a report about the connected webcams on the desktop called "WebcamReport.txt". The report contains the following information about every webcam:
Since version 0.64, PowerToys is released on GitHub with GroupPolicyObject files. You can check these releases on https://github.com/microsoft/PowerToys/releases .
## How to install
### Add the administrative template to an individual computer
1. Copy the "PowerToys.admx" file to your Policy Definition template folder. (Example: C:\Windows\PolicyDefinitions)
2. Copy the "PowerToys.adml" file to the matching language folder in your Policy Definition folder. (Example: C:\Windows\PolicyDefinitions\en-US)
### Add the administrative template to Active Directory
1. On a domain controller or workstation with RSAT, go to the **PolicyDefinition** folder (also known as the *Central Store*) on any domain controller for your domain. For older versions of Windows Server, you might need to create the **PolicyDefinition** folder. For more information, see [How to create and manage the Central Store for Group Policy Administrative Templates in Windows](https://support.microsoft.com/help/3087759/how-to-create-and-manage-the-central-store-for-group-policy-administra).
2. Copy the "PowerToys.admx" file to the PolicyDefinition folder. (Example: %systemroot%\sysvol\domain\policies\PolicyDefinitions)
3. Copy the "PowerToys.adml" file to the matching language folder in the PolicyDefinition folder. Create the folder if it doesn't already exist. (Example: %systemroot%\sysvol\domain\policies\PolicyDefinitions\EN-US)
4. If your domain has more than one domain controller, the new ADMX files will be replicated to them at the next domain replication interval.
### Scope
You will find the policies under "Administrative Templates/Microsoft PowerToys" in both the Computer Configuration and User Configuration folders. If both settings are configured, the setting in Computer Configuration takes precedence over the setting in User Configuration.
## Policies
### Configure enabled state
For each utility shipped with PowerToys, there's a "Configure enabled state" policy, which forces and Enabled state for the utility.
If you enable this setting, the utility will be always enabled and the user won't be able to disable it.
If you disable this setting, the utility will be always disabled and the user won't be able to enable it.
If you don't configure this setting, users are able to disable or enable the utility.
### Allow experimentation
This policy configures whether PowerToys experimentation is allowed. With experimentation allowed the user sees the new features being experimented if it gets selected as part of the test group. (Experimentation will only happen on Windows Insider builds.)
If this setting is not configured or enabled, the user can control experimentation in the PowerToys settings menu.
If this setting is disabled, experimentation is not allowed.
If this setting is not configured, experimentation is allowed.
### Installer and Updates
#### Disable per-user installation
This policy configures whether PowerToys per-user installation is allowed or not.
If enabled, per-user installation is not allowed.
If disabled or not configured, per-user installation is allowed.
You can set this policy only as Computer policy.
#### Disable automatic downloads
This policy configures whether automatic downloads of available updates are disabled or not. (On metered connections updates are never downloaded.)
If enabled, automatic downloads are disabled.
If disabled or not configured, the user is in control of automatic downloads setting.
#### Suspend Action Center notification for new updates
This policy configures whether the action center notification for new updates is suspended for 2 minor releases. (Example: if the installed version is v0.60.0, then the next notification is shown for the v0.63.* release.)
If enabled, the notification is suspended.
If disabled or not configured, the notification is shown.
Note: The notification about new major versions is always displayed.
<!-- This policy is implemented for later usage (PT v1.0 and later) and therefore inactive. (To make it working please update `src/runner/UpdateUtils.cpp`)
#### Disable automatic update checks
This policy allows you to disable automatic update checks running in the background. (The manual check in PT Settings is not affected by this policy.)
If enabled, the automatic update checks are disabled.
If disabled or not configured, the automatic update checks are enabled.
Some files were not shown because too many files have changed in this diff
Show More
Reference in New Issue
Block a user
Blocking a user prevents them from interacting with repositories, such as opening or commenting on pull requests or issues. Learn more about blocking a user.