2020-08-17 10:00:56 -07:00
// Copyright (c) Microsoft Corporation
// The Microsoft Corporation licenses this file to you under the MIT license.
// See the LICENSE file in the project root for more information.
2020-08-17 15:00:19 -07:00
using System.Collections.Generic ;
2020-10-29 14:24:16 -07:00
using System.Globalization ;
2020-11-02 18:33:43 +01:00
using System.IO.Abstractions ;
2024-10-17 05:14:57 -04:00
2023-01-31 00:00:11 +01:00
using Microsoft.PowerToys.Settings.UI.Helpers ;
2020-10-22 09:45:48 -07:00
using Microsoft.PowerToys.Settings.UI.Library ;
using Microsoft.PowerToys.Settings.UI.Library.Utilities ;
2022-10-26 14:02:31 +01:00
using Microsoft.PowerToys.Settings.UI.ViewModels ;
2022-04-19 22:00:28 +02:00
using Microsoft.UI.Xaml.Controls ;
2020-08-17 15:00:19 -07:00
using Windows.System ;
2020-08-17 10:00:56 -07:00
namespace Microsoft.PowerToys.Settings.UI.Views
{
/// <summary>
/// An empty page that can be used on its own or navigated to within a Frame.
/// </summary>
Setting search (#41285)
<!-- 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
<!-- Please review the items on the PR checklist before submitting-->
## PR Checklist
- [ ] Closes: #xxx
- [ ] **Communication:** I've discussed this with core contributors
already. If the work hasn't been agreed, this work might be rejected
- [x] **Tests:** Added/updated and all pass
- [ ] **Localization:** All end-user-facing strings can be localized
- [ ] **Dev docs:** Added/updated
- [ ] **New binaries:** Added on the required places
- [ ] [JSON for
signing](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
Localized search:
<img width="1576" height="480" alt="image"
src="https://github.com/user-attachments/assets/dd6e5e9f-419b-40b1-b796-f0799481ecfc"
/>
## AI summary
This pull request introduces infrastructure and code to support search
functionality for PowerToys settings, including a new search index
specification, a dedicated search library, and updates to the solution
configuration. The main changes are the addition of a spec describing
how settings should be indexed and navigated, the creation of a new
`Common.Search` project with a fuzz search implementation, and updates
to the solution file to include these new components.
**Settings Search Feature Implementation**
* Documentation:
* Added a detailed specification (`settings-search.md`) describing the
structure of PowerToys settings pages, how to index settings, navigation
logic, runtime search, result grouping, build-time indexing strategy,
and corner cases.
* New Search Library:
* Added the new `Common.Search` project to the solution, including its
project file and implementation of a fuzz search service
(`FuzzSearchService<T>`), match options, match results, and search
precision scoring.
[[1]](diffhunk://#diff-ddc06fa41e4e723e54181b0cb85cdd00f57f75725d51ceefa242d4d651a9a363R1-R8)
[[2]](diffhunk://#diff-1a2ca29fc33bcccf338a7843a040ca2c31ba821e8cab7064fab0dbb1224d454cR1-R39)
[[3]](diffhunk://#diff-242764d948b795f39653a84d9b6bfcdc52730100deab2e3a0995be95bb8e7868R1-R10)
[[4]](diffhunk://#diff-61e525491ed916ebd65dabb66dd4f5dc720320d7e295ef1e0bd6d506ea0f7df6R1-R67)
[[5]](diffhunk://#diff-a775f6de2e8d42982829b4161668f49dedbbd9dcbb05ce20003de7e62275c57aR1-R12)
* Solution Configuration:
* Updated `PowerToys.sln` to include `Common.Search` and
`Settings.UI.XamlIndexBuilder` projects, and configured their build
settings for various platforms and mapped project dependencies.
[[1]](diffhunk://#diff-ca837ce490070b91656ffffe31cbad8865ba9174e0f020231f77baf35ff3f811R714-R716)
[[2]](diffhunk://#diff-ca837ce490070b91656ffffe31cbad8865ba9174e0f020231f77baf35ff3f811R2704-R2727)
[[3]](diffhunk://#diff-ca837ce490070b91656ffffe31cbad8865ba9174e0f020231f77baf35ff3f811R2889)
[[4]](diffhunk://#diff-ca837ce490070b91656ffffe31cbad8865ba9174e0f020231f77baf35ff3f811R3157-R3158)
**Spell-check Dictionary Updates**
* Added new terms related to navigation and settings UI components (such
as `Navigatable`, `NavigatablePage`, `settingscard`, `Tru`, `tweakable`)
to the spell-check dictionary to support the new search and indexing
features.
[[1]](diffhunk://#diff-5dcab162c1b233a49973ae010f2b88c7ec4844382abd705e6154685e62bd5c4dR1020-R1021)
[[2]](diffhunk://#diff-5dcab162c1b233a49973ae010f2b88c7ec4844382abd705e6154685e62bd5c4dR1498)
[[3]](diffhunk://#diff-5dcab162c1b233a49973ae010f2b88c7ec4844382abd705e6154685e62bd5c4dR1755-R1761)
---------
Co-authored-by: Niels Laute <niels.laute@live.nl>
Co-authored-by: Gordon Lam (SH) <yeelam@microsoft.com>
Co-authored-by: Gordon Lam <73506701+yeelam-gordon@users.noreply.github.com>
2025-08-25 21:23:07 +08:00
public sealed partial class KeyboardManagerPage : NavigatablePage , IRefreshablePage
2020-08-17 10:00:56 -07:00
{
2020-08-17 15:00:19 -07:00
private const string PowerToyName = "Keyboard Manager" ;
2020-11-02 18:33:43 +01:00
private readonly IFileSystemWatcher watcher ;
2020-08-17 15:00:19 -07:00
public KeyboardManagerViewModel ViewModel { get ; }
2020-08-17 10:00:56 -07:00
public KeyboardManagerPage ( )
{
2020-11-02 18:33:43 +01:00
var settingsUtils = new SettingsUtils ( ) ;
2020-09-23 13:20:32 -07:00
ViewModel = new KeyboardManagerViewModel ( settingsUtils , SettingsRepository < GeneralSettings > . GetInstance ( settingsUtils ) , ShellPage . SendDefaultIPCMessage , FilterRemapKeysList ) ;
2020-08-17 15:00:19 -07:00
watcher = Helper . GetFileWatcher (
PowerToyName ,
2020-08-19 15:59:10 -07:00
ViewModel . Settings . Properties . ActiveConfiguration . Value + ".json" ,
2020-08-17 15:00:19 -07:00
OnConfigFileUpdate ) ;
2020-08-17 10:00:56 -07:00
InitializeComponent ( ) ;
DataContext = ViewModel ;
}
2020-08-17 15:00:19 -07:00
2022-04-19 22:00:28 +02:00
private void OnConfigFileUpdate ( )
2020-08-17 15:00:19 -07:00
{
// Note: FileSystemWatcher raise notification multiple times for single update operation.
2024-12-06 06:33:08 -10:00
// Todo: Handle duplicate events either by somehow suppress them or re-read the configuration every time since we will be updating the UI only if something is changed.
2020-08-17 15:00:19 -07:00
if ( ViewModel . LoadProfile ( ) )
{
2022-04-19 22:00:28 +02:00
this . DispatcherQueue . TryEnqueue ( ( ) = >
2020-08-17 15:00:19 -07:00
{
ViewModel . NotifyFileChanged ( ) ;
} ) ;
}
}
2020-10-29 14:24:16 -07:00
private static void CombineRemappings ( List < KeysDataModel > remapKeysList , uint leftKey , uint rightKey , uint combinedKey )
2020-08-17 15:00:19 -07:00
{
2020-10-29 14:24:16 -07:00
// Using InvariantCulture for keys as they are internally represented as numerical values
KeysDataModel firstRemap = remapKeysList . Find ( x = > uint . Parse ( x . OriginalKeys , CultureInfo . InvariantCulture ) = = leftKey ) ;
KeysDataModel secondRemap = remapKeysList . Find ( x = > uint . Parse ( x . OriginalKeys , CultureInfo . InvariantCulture ) = = rightKey ) ;
2020-08-17 15:00:19 -07:00
if ( firstRemap ! = null & & secondRemap ! = null )
{
if ( firstRemap . NewRemapKeys = = secondRemap . NewRemapKeys )
{
KeysDataModel combinedRemap = new KeysDataModel
{
2020-10-29 14:24:16 -07:00
OriginalKeys = combinedKey . ToString ( CultureInfo . InvariantCulture ) ,
2020-08-17 15:00:19 -07:00
NewRemapKeys = firstRemap . NewRemapKeys ,
} ;
remapKeysList . Insert ( remapKeysList . IndexOf ( firstRemap ) , combinedRemap ) ;
remapKeysList . Remove ( firstRemap ) ;
remapKeysList . Remove ( secondRemap ) ;
}
}
}
[Settings]Adding a Dashboard Panel (#29023)
* Dashboard: modifying page content + adding SW version button.
* Visual tweaks and minor viewmodel changes
* Updated spacing
* Adding Settings icon
* Settiing the Dashboard page as the default one. Adding functionality to switch to settings pages from the Dashboard page. Localizing texts.
* fixing csproj file
* Reimplementing Active modules handling, showing only the active modules (and not having invisible inactive modules).
* Removing unneccessary binding
* Fix text wrapping
* Adding Registry previewer launch, adding activation mode for FindMyMouse and QuickAccent, modify File Locksmith description.
* Spell checker fix typo
* Adding GPO-blocked state, modifying buttons: adding description, icon.
* Modifying dashboard button layout
* Use SettingsCard instead of button
* Restructuring the dashboard panel
* Removing togglebuttons from the left panel. Showing only active modules. Adding key remappings (to KBM)
* Removing settings buttons, removing descriptions, icons from buttons. Add update of remapped keys, shortcuts.
* Refactoring dashboard
* Making list always visible and fixing scrolling behavior
* Adding background gradient to cards
* Removing keyboard manager's key mappings, minor changes in texts, fixing enabled state when GPO-enabled.
* Use ListView instead of ItemsRepeater
* Updates
* removing right panel with all modules. Extending "left" panel with toggleswitches, showing all modules.
* Separate lists
* Adding Flyout with key remappings for KBM module, adding IsLocked property, icons
* Visual tweaks
* Tweaks
* Fixing lock icon margin
* Minor fixes.
* Removing unused resources
* Make Dashboard default when coming from the OOBE General
* Removed the Previous, Next Layout buttons from FancyZones. Added activation information
---------
Co-authored-by: Niels Laute <niels.laute@live.nl>
2023-10-20 14:23:25 +02:00
public static int FilterRemapKeysList ( List < KeysDataModel > remapKeysList )
2020-08-17 15:00:19 -07:00
{
2022-03-10 20:31:16 +03:00
if ( remapKeysList ! = null )
{
CombineRemappings ( remapKeysList , ( uint ) VirtualKey . LeftControl , ( uint ) VirtualKey . RightControl , ( uint ) VirtualKey . Control ) ;
CombineRemappings ( remapKeysList , ( uint ) VirtualKey . LeftMenu , ( uint ) VirtualKey . RightMenu , ( uint ) VirtualKey . Menu ) ;
CombineRemappings ( remapKeysList , ( uint ) VirtualKey . LeftShift , ( uint ) VirtualKey . RightShift , ( uint ) VirtualKey . Shift ) ;
CombineRemappings ( remapKeysList , ( uint ) VirtualKey . LeftWindows , ( uint ) VirtualKey . RightWindows , Helper . VirtualKeyWindows ) ;
}
2020-08-17 15:00:19 -07:00
return 0 ;
}
2023-01-31 00:00:11 +01:00
public void RefreshEnabledState ( )
{
ViewModel . RefreshEnabledState ( ) ;
}
2020-08-17 10:00:56 -07:00
}
}