[ColorPicker]Add option to choose what clicking individual mouse buttons does (#39025)

## Summary of the Pull Request
Enables the users to choose what left, right, and middle click does when
color picker is open.
<!-- Please review the items on the PR checklist before submitting-->
## PR Checklist

- [x] **Closes:** #39006
- [x] **Communication:** I've discussed this with core contributors
already
- [x] **Tests:** All pass
- [x] **Localization:** All end user facing strings can be localized
- [x] **Dev docs:** No need
- [x] **New binaries:** None
- [x] **Documentation updated:** No need
## Detailed Description of the Pull Request / Additional comments
![Screenshot of the
settings](https://github.com/user-attachments/assets/a3e1349b-6bb9-4e2f-97f3-a5106a7d92ce)
Adds option to choose from 3 click behaviors for each standard mouse
button:
* **Pick color and open editor**: Copies color to clipboard, saves it to
the color history and opens the editor
* **Pick color and close**: Copies color to clipboard, saves it to the
color history and exits
* **Close**: Closes color picker without copying the color

Pressing <kbd>Enter</kbd> or <kbd>Space</kbd> does what clicking the
primary button would.
Left and middle click actions execute on mouse down, right click on
mouse up for reasons discussed previously (I can't find the conversation
now)
Default settings are chosen in such a way that very little or nothing
changes by updating.
## Validation Steps Performed
Tested:
* Migrating settings from v2.0 to v2.1 (v1 to v2.1 not tested)
* Settings page displays and saves settings correctly
* Default settings load correctly
* All three click actions do what they are supposed to
* Activation behavior works as expected, doesn't affect click actions
This commit is contained in:
PesBandi
2025-06-13 12:01:40 +02:00
committed by GitHub
parent 2d1676b7df
commit ce058f1dc7
17 changed files with 291 additions and 66 deletions

View File

@@ -40,7 +40,10 @@ namespace Microsoft.PowerToys.Settings.UI.Library
VisibleColorFormats.Add("Decimal", new KeyValuePair<bool, string>(false, ColorFormatHelper.GetDefaultFormat("Decimal")));
VisibleColorFormats.Add("HEX Int", new KeyValuePair<bool, string>(false, ColorFormatHelper.GetDefaultFormat("HEX Int")));
ShowColorName = false;
ActivationAction = ColorPickerActivationAction.OpenColorPickerAndThenEditor;
ActivationAction = ColorPickerActivationAction.OpenColorPicker;
PrimaryClickAction = ColorPickerClickAction.PickColorThenEditor;
MiddleClickAction = ColorPickerClickAction.PickColorAndClose;
SecondaryClickAction = ColorPickerClickAction.Close;
CopiedColorRepresentation = "HEX";
}
@@ -57,6 +60,15 @@ namespace Microsoft.PowerToys.Settings.UI.Library
[JsonPropertyName("activationaction")]
public ColorPickerActivationAction ActivationAction { get; set; }
[JsonPropertyName("primaryclickaction")]
public ColorPickerClickAction PrimaryClickAction { get; set; }
[JsonPropertyName("middleclickaction")]
public ColorPickerClickAction MiddleClickAction { get; set; }
[JsonPropertyName("secondaryclickaction")]
public ColorPickerClickAction SecondaryClickAction { get; set; }
// Property ColorHistory is not used, the color history is saved separately in the colorHistory.json file
[JsonPropertyName("colorhistory")]
[CmdConfigureIgnoreAttribute]

View File

@@ -25,7 +25,7 @@ namespace Microsoft.PowerToys.Settings.UI.Library
VisibleColorFormats.Add("RGB", true);
VisibleColorFormats.Add("HSL", true);
ShowColorName = false;
ActivationAction = ColorPickerActivationAction.OpenColorPickerAndThenEditor;
ActivationAction = ColorPickerActivationAction.OpenColorPicker;
}
public HotkeySettings ActivationShortcut { get; set; }

View File

@@ -9,6 +9,7 @@ using System.Text.Json;
using System.Text.Json.Serialization;
using ManagedCommon;
using Microsoft.PowerToys.Settings.UI.Library.Enumerations;
using Microsoft.PowerToys.Settings.UI.Library.Interfaces;
namespace Microsoft.PowerToys.Settings.UI.Library
@@ -23,7 +24,7 @@ namespace Microsoft.PowerToys.Settings.UI.Library
public ColorPickerSettings()
{
Properties = new ColorPickerProperties();
Version = "2";
Version = "2.1";
Name = ModuleName;
}
@@ -47,7 +48,21 @@ namespace Microsoft.PowerToys.Settings.UI.Library
// This can be utilized in the future if the settings.json file is to be modified/deleted.
public bool UpgradeSettingsConfiguration()
=> false;
{
// Upgrading V1 to V2 doesn't set the version to 2.0, therefore V2 settings still report Version == 1.0
if (Version == "1.0")
{
if (!Enum.IsDefined(Properties.ActivationAction))
{
Properties.ActivationAction = ColorPickerActivationAction.OpenColorPicker;
}
Version = "2.1";
return true;
}
return false;
}
public static object UpgradeSettings(object oldSettingsObject)
{

View File

@@ -9,10 +9,7 @@ namespace Microsoft.PowerToys.Settings.UI.Library.Enumerations
// Activation shortcut opens editor
OpenEditor,
// Activation shortcut opens color picker and after picking a color is copied into clipboard and opens editor
OpenColorPickerAndThenEditor,
// Activation shortcut opens color picker only and picking color copies color into clipboard
OpenOnlyColorPicker,
// Activation shortcut opens color picker and after picking a color is copied into clipboard and editor optionally opens depending on which mouse button was pressed
OpenColorPicker,
}
}

View File

@@ -0,0 +1,18 @@
// 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.
namespace Microsoft.PowerToys.Settings.UI.Library.Enumerations
{
public enum ColorPickerClickAction
{
// Clicking copies the picked color and opens the editor
PickColorThenEditor,
// Clicking only copies the picked color and then exits color picker
PickColorAndClose,
// Clicking exits color picker, without copying anything
Close,
}
}

View File

@@ -130,6 +130,13 @@ namespace Microsoft.PowerToys.Settings.UI.Library
T2 oldSettings = GetSettings<T2>(powertoy, fileName);
T newSettings = (T)settingsUpgrader(oldSettings);
Logger.LogInfo($"Settings file {fileName} for {powertoy} was read successfully in the old format.");
// If the file needs to be modified, to save the new configurations accordingly.
if (newSettings.UpgradeSettingsConfiguration())
{
SaveSettings(newSettings.ToJsonString(), powertoy, fileName);
}
return newSettings;
}
catch (Exception)

View File

@@ -50,12 +50,39 @@
<tkcontrols:SettingsCard x:Uid="ColorPicker_ActivationAction" HeaderIcon="{ui:FontIcon Glyph=&#xEC4E;}">
<ComboBox MinWidth="{StaticResource SettingActionControlMinWidth}" SelectedIndex="{x:Bind Path=ViewModel.ActivationBehavior, Mode=TwoWay}">
<ComboBoxItem x:Uid="EditorFirst" />
<ComboBoxItem x:Uid="ColorPickerFirst" />
<ComboBoxItem x:Uid="ColorPickerOnly" />
<ComboBoxItem x:Uid="ColorPicker_OpenEditor" />
<ComboBoxItem x:Uid="ColorPicker_PickColor" />
</ComboBox>
</tkcontrols:SettingsCard>
<tkcontrols:SettingsExpander
x:Uid="ColorPicker_MouseActions"
HeaderIcon="{ui:FontIcon Glyph=&#xE962;}"
IsEnabled="{x:Bind ViewModel.IsEnabled, Mode=OneWay}">
<tkcontrols:SettingsExpander.Items>
<tkcontrols:SettingsCard x:Uid="ColorPicker_PrimaryClick" IsEnabled="{x:Bind ViewModel.IsEnabled, Mode=OneWay}">
<ComboBox MinWidth="{StaticResource SettingActionControlMinWidth}" SelectedIndex="{x:Bind ViewModel.PrimaryClickBehavior, Mode=TwoWay}">
<ComboBoxItem x:Uid="ColorPicker_PickColorThenEditor" />
<ComboBoxItem x:Uid="ColorPicker_PickColorAndClose" />
<ComboBoxItem x:Uid="ColorPicker_Close" />
</ComboBox>
</tkcontrols:SettingsCard>
<tkcontrols:SettingsCard x:Uid="ColorPicker_MiddleClick" IsEnabled="{x:Bind ViewModel.IsEnabled, Mode=OneWay}">
<ComboBox MinWidth="{StaticResource SettingActionControlMinWidth}" SelectedIndex="{x:Bind ViewModel.MiddleClickBehavior, Mode=TwoWay}">
<ComboBoxItem x:Uid="ColorPicker_PickColorThenEditor" />
<ComboBoxItem x:Uid="ColorPicker_PickColorAndClose" />
<ComboBoxItem x:Uid="ColorPicker_Close" />
</ComboBox>
</tkcontrols:SettingsCard>
<tkcontrols:SettingsCard x:Uid="ColorPicker_SecondaryClick" IsEnabled="{x:Bind ViewModel.IsEnabled, Mode=OneWay}">
<ComboBox MinWidth="{StaticResource SettingActionControlMinWidth}" SelectedIndex="{x:Bind ViewModel.SecondaryClickBehavior, Mode=TwoWay}">
<ComboBoxItem x:Uid="ColorPicker_PickColorThenEditor" />
<ComboBoxItem x:Uid="ColorPicker_PickColorAndClose" />
<ComboBoxItem x:Uid="ColorPicker_Close" />
</ComboBox>
</tkcontrols:SettingsCard>
</tkcontrols:SettingsExpander.Items>
</tkcontrols:SettingsExpander>
</controls:SettingsGroup>
<controls:SettingsGroup x:Uid="ColorFormats" IsEnabled="{x:Bind ViewModel.IsEnabled, Mode=OneWay}">

View File

@@ -1507,18 +1507,39 @@ Made with 💗 by Microsoft and the PowerToys community.</value>
<data name="ColorPicker_CopiedColorRepresentation.Header" xml:space="preserve">
<value>Default color format</value>
</data>
<data name="ColorPickerFirst.Content" xml:space="preserve">
<value>Pick a color and open editor</value>
</data>
<data name="EditorFirst.Content" xml:space="preserve">
<value>Open editor</value>
</data>
<data name="ColorPickerOnly.Content" xml:space="preserve">
<value>Only pick a color</value>
</data>
<data name="ColorPicker_ActivationAction.Header" xml:space="preserve">
<value>Activation behavior</value>
</data>
<data name="ColorPicker_OpenEditor.Content" xml:space="preserve">
<value>Open editor</value>
</data>
<data name="ColorPicker_PickColor.Content" xml:space="preserve">
<value>Pick a color first</value>
</data>
<data name="ColorPicker_MouseActions.Header" xml:space="preserve">
<value>Mouse actions</value>
</data>
<data name="ColorPicker_MouseActions.Description" xml:space="preserve">
<value>Choose what clicking individual buttons does</value>
</data>
<data name="ColorPicker_PrimaryClick.Header" xml:space="preserve">
<value>Primary click</value>
</data>
<data name="ColorPicker_MiddleClick.Header" xml:space="preserve">
<value>Middle click</value>
</data>
<data name="ColorPicker_SecondaryClick.Header" xml:space="preserve">
<value>Secondary click</value>
</data>
<data name="ColorPicker_PickColorThenEditor.Content" xml:space="preserve">
<value>Pick a color and open editor</value>
</data>
<data name="ColorPicker_PickColorAndClose.Content" xml:space="preserve">
<value>Pick a color and close</value>
</data>
<data name="ColorPicker_Close.Content" xml:space="preserve">
<value>Close</value>
</data>
<data name="ColorFormats.Header" xml:space="preserve">
<value>Picker behavior</value>
</data>

View File

@@ -182,6 +182,51 @@ namespace Microsoft.PowerToys.Settings.UI.ViewModels
}
}
public int PrimaryClickBehavior
{
get => (int)_colorPickerSettings.Properties.PrimaryClickAction;
set
{
if (value != (int)_colorPickerSettings.Properties.PrimaryClickAction)
{
_colorPickerSettings.Properties.PrimaryClickAction = (ColorPickerClickAction)value;
OnPropertyChanged(nameof(PrimaryClickBehavior));
NotifySettingsChanged();
}
}
}
public int MiddleClickBehavior
{
get => (int)_colorPickerSettings.Properties.MiddleClickAction;
set
{
if (value != (int)_colorPickerSettings.Properties.MiddleClickAction)
{
_colorPickerSettings.Properties.MiddleClickAction = (ColorPickerClickAction)value;
OnPropertyChanged(nameof(MiddleClickBehavior));
NotifySettingsChanged();
}
}
}
public int SecondaryClickBehavior
{
get => (int)_colorPickerSettings.Properties.SecondaryClickAction;
set
{
if (value != (int)_colorPickerSettings.Properties.SecondaryClickAction)
{
_colorPickerSettings.Properties.SecondaryClickAction = (ColorPickerClickAction)value;
OnPropertyChanged(nameof(SecondaryClickBehavior));
NotifySettingsChanged();
}
}
}
public bool ShowColorName
{
get => _colorPickerSettings.Properties.ShowColorName;