Added Ctrl+Click support for opening context menu on mac

AvaloniaUI · May 29, 2024 · d907e96 · d907e96
1 parent 2cb40ac
commit d907e96
Show file tree

Hide file tree

Showing 14 changed files with 143 additions and 3 deletions.
diff --git a/src/Android/Avalonia.Android/AndroidPlatform.cs b/src/Android/Avalonia.Android/AndroidPlatform.cs
@@ -87,6 +87,7 @@ public static void Initialize()
                 .Bind<IPlatformThreadingInterface>().ToConstant(new AndroidThreadingInterface())
                 .Bind<IPlatformIconLoader>().ToSingleton<PlatformIconLoaderStub>()
                 .Bind<IRenderTimer>().ToConstant(new ChoreographerTimer())
+                .Bind<PlatformPointerConfiguration>().ToSingleton<PlatformPointerConfiguration>()
                 .Bind<PlatformHotkeyConfiguration>().ToSingleton<PlatformHotkeyConfiguration>()
                 .Bind<IActivatableLifetime>().ToConstant(new AndroidActivatableLifetime());
 

diff --git a/src/Avalonia.Base/Input/Platform/PlatformPointerConfiguration.cs b/src/Avalonia.Base/Input/Platform/PlatformPointerConfiguration.cs
@@ -0,0 +1,24 @@
+using System.Collections.Generic;
+using Avalonia.Metadata;
+
+namespace Avalonia.Input.Platform;
+
+public sealed class PlatformPointerConfiguration
+{
+    public List<PointerGesture> OpenContextMenu { get; set; }
+
+    [PrivateApi]
+    public PlatformPointerConfiguration()
+    {
+        OpenContextMenu = new List<PointerGesture>
+        {
+            new PointerGesture(MouseButton.Right, KeyModifiers.None)
+        };
+    }
+
+    [PrivateApi]
+    public PlatformPointerConfiguration(params PointerGesture[] additionalContextGestures) : this()
+    {
+        OpenContextMenu.AddRange(additionalContextGestures);
+    }
+}
diff --git a/src/Avalonia.Base/Input/PointerGesture.cs b/src/Avalonia.Base/Input/PointerGesture.cs
@@ -0,0 +1,103 @@
+using System;
+using System.Text;
+using Avalonia.VisualTree;
+
+namespace Avalonia.Input;
+
+public class PointerGesture : IEquatable<PointerGesture>
+{
+    public PointerGesture(MouseButton button, KeyModifiers modifiers = KeyModifiers.None)
+    {
+        Button = button;
+        KeyModifiers = modifiers;
+    }
+
+    public bool Equals(PointerGesture? other)
+    {
+        if (ReferenceEquals(null, other)) return false;
+        if (ReferenceEquals(this, other)) return true;
+
+        return Button == other.Button && KeyModifiers == other.KeyModifiers;
+    }
+
+    public override bool Equals(object? obj)
+    {
+        if (ReferenceEquals(null, obj)) return false;
+        if (ReferenceEquals(this, obj)) return true;
+
+        return obj is KeyGesture gesture && Equals(gesture);
+    }
+
+    public override int GetHashCode()
+    {
+        unchecked
+        {
+            return ((int)Button * 397) ^ (int)KeyModifiers;
+        }
+    }
+
+    public static bool operator ==(PointerGesture? left, PointerGesture? right)
+    {
+        return Equals(left, right);
+    }
+
+    public static bool operator !=(PointerGesture? left, PointerGesture? right)
+    {
+        return !Equals(left, right);
+    }
+
+    public MouseButton Button { get; }
+
+    public KeyModifiers KeyModifiers { get; }
+
+    public override string ToString()
+    {
+        var s = new StringBuilder();
+
+        static void Plus(StringBuilder s)
+        {
+            if (s.Length > 0)
+            {
+                s.Append("+");
+            }
+        }
+
+        if (KeyModifiers.HasAllFlags(KeyModifiers.Control))
+        {
+            s.Append("Ctrl");
+        }
+
+        if (KeyModifiers.HasAllFlags(KeyModifiers.Shift))
+        {
+            Plus(s);
+            s.Append("Shift");
+        }
+
+        if (KeyModifiers.HasAllFlags(KeyModifiers.Alt))
+        {
+            Plus(s);
+            s.Append("Alt");
+        }
+
+        if (KeyModifiers.HasAllFlags(KeyModifiers.Meta))
+        {
+            Plus(s);
+            s.Append("Cmd");
+        }
+
+        Plus(s);
+        s.Append(Button);
+
+        return s.ToString();
+    }
+
+    public bool Matches(PointerEventArgs pointerEvent) =>
+        pointerEvent != null &&
+        pointerEvent.KeyModifiers == KeyModifiers &&
+        pointerEvent.GetCurrentPoint(pointerEvent.Source as Visual).Properties.PointerUpdateKind.GetMouseButton() == Button;
+
+    public bool Matches(PointerReleasedEventArgs pointerEvent) =>
+        pointerEvent != null &&
+        pointerEvent.KeyModifiers == KeyModifiers &&
+        pointerEvent.InitialPressMouseButton == Button;
+}
diff --git a/src/Avalonia.Controls/Button.cs b/src/Avalonia.Controls/Button.cs
@@ -419,7 +419,7 @@ protected override void OnPointerReleased(PointerReleasedEventArgs e)
         {
             base.OnPointerReleased(e);
 
-            if (IsPressed && e.InitialPressMouseButton == MouseButton.Left)
+            if (!e.Handled && IsPressed && e.InitialPressMouseButton == MouseButton.Left)
             {
                 IsPressed = false;
                 e.Handled = true;

diff --git a/src/Avalonia.Controls/Control.cs b/src/Avalonia.Controls/Control.cs
@@ -1,6 +1,7 @@
 using System;
 using System.Collections.Generic;
 using System.ComponentModel;
+using System.Linq;
 using Avalonia.Automation.Peers;
 using Avalonia.Controls.Primitives;
 using Avalonia.Controls.Templates;
@@ -480,9 +481,11 @@ protected override void OnPointerReleased(PointerReleasedEventArgs e)
         {
             base.OnPointerReleased(e);
 
+            var contextGestures = AvaloniaLocator.Current.GetService<PlatformPointerConfiguration>()?.OpenContextMenu;
+
             if (e.Source == this
                 && !e.Handled
-                && e.InitialPressMouseButton == MouseButton.Right)
+                && contextGestures?.Any(x => x.Matches(e)) == true)
             {
                 var args = new ContextRequestedEventArgs(e);
                 RaiseEvent(args);

diff --git a/src/Avalonia.DesignerSupport/Remote/PreviewerWindowingPlatform.cs b/src/Avalonia.DesignerSupport/Remote/PreviewerWindowingPlatform.cs
@@ -55,6 +55,7 @@ public static void Initialize(IAvaloniaRemoteTransportConnection transport)
                 .Bind<IRenderTimer>().ToConstant(new UiThreadRenderTimer(60))
                 .Bind<IWindowingPlatform>().ToConstant(instance)
                 .Bind<IPlatformIconLoader>().ToSingleton<IconLoaderStub>()
+                .Bind<PlatformPointerConfiguration>().ToSingleton<PlatformPointerConfiguration>()
                 .Bind<PlatformHotkeyConfiguration>().ToSingleton<PlatformHotkeyConfiguration>();
 
         }

diff --git a/src/Avalonia.Native/AvaloniaNativePlatform.cs b/src/Avalonia.Native/AvaloniaNativePlatform.cs
@@ -122,7 +122,8 @@ void DoInitialize(AvaloniaNativePlatformOptions options)
             hotkeys.MoveCursorToTheEndOfLine.Add(new KeyGesture(Key.Right, hotkeys.CommandModifiers));
             hotkeys.MoveCursorToTheEndOfLineWithSelection.Add(new KeyGesture(Key.Right, hotkeys.CommandModifiers | hotkeys.SelectionModifiers));
 
-            AvaloniaLocator.CurrentMutable.Bind<PlatformHotkeyConfiguration>().ToConstant(hotkeys);
+            AvaloniaLocator.CurrentMutable.Bind<PlatformHotkeyConfiguration>().ToConstant(hotkeys)
+                .Bind<PlatformPointerConfiguration>().ToConstant(new PlatformPointerConfiguration(new PointerGesture(MouseButton.Left, KeyModifiers.Control)));;
 
             foreach (var mode in _options.RenderingMode)
             {

diff --git a/src/Avalonia.X11/X11Platform.cs b/src/Avalonia.X11/X11Platform.cs
@@ -80,6 +80,7 @@ public void Initialize(X11PlatformOptions options)
                 .Bind<IWindowingPlatform>().ToConstant(this)
                 .Bind<IDispatcherImpl>().ToConstant(new X11PlatformThreading(this))
                 .Bind<IRenderTimer>().ToConstant(timer)
+                .Bind<PlatformPointerConfiguration>().ToSingleton<PlatformPointerConfiguration>()
                 .Bind<PlatformHotkeyConfiguration>().ToConstant(new PlatformHotkeyConfiguration(KeyModifiers.Control))
                 .Bind<IKeyboardDevice>().ToFunc(() => KeyboardDevice)
                 .Bind<ICursorFactory>().ToConstant(new X11CursorFactory(Display))

diff --git a/src/Browser/Avalonia.Browser/WindowingPlatform.cs b/src/Browser/Avalonia.Browser/WindowingPlatform.cs
@@ -69,6 +69,7 @@ public static void Register()
             .Bind<IPlatformSettings>().ToSingleton<BrowserPlatformSettings>()
             .Bind<IWindowingPlatform>().ToConstant(instance)
             .Bind<IPlatformIconLoader>().ToSingleton<IconLoaderStub>()
+            .Bind<PlatformPointerConfiguration>().ToSingleton<PlatformPointerConfiguration>()
             .Bind<PlatformHotkeyConfiguration>().ToSingleton<PlatformHotkeyConfiguration>()
             .Bind<IActivatableLifetime>().ToSingleton<BrowserActivatableLifetime>();
         AvaloniaLocator.CurrentMutable.Bind<IDispatcherImpl>().ToSingleton<BrowserDispatcherImpl>();

diff --git a/src/Headless/Avalonia.Headless/AvaloniaHeadlessPlatform.cs b/src/Headless/Avalonia.Headless/AvaloniaHeadlessPlatform.cs
@@ -76,6 +76,7 @@ internal static void Initialize(AvaloniaHeadlessPlatformOptions opts)
                 .Bind<IKeyboardDevice>().ToConstant(new KeyboardDevice())
                 .Bind<IRenderTimer>().ToConstant(new RenderTimer(60))
                 .Bind<IWindowingPlatform>().ToConstant(new HeadlessWindowingPlatform(opts.FrameBufferFormat))
+                .Bind<PlatformPointerConfiguration>().ToSingleton<PlatformPointerConfiguration>()
                 .Bind<PlatformHotkeyConfiguration>().ToSingleton<PlatformHotkeyConfiguration>();
             Compositor = new Compositor( null);
         }

diff --git a/src/Linux/Avalonia.LinuxFramebuffer/LinuxFramebufferPlatform.cs b/src/Linux/Avalonia.LinuxFramebuffer/LinuxFramebufferPlatform.cs
@@ -72,6 +72,7 @@ void Initialize()
                 .Bind<IKeyboardDevice>().ToConstant(new KeyboardDevice())
                 .Bind<IPlatformIconLoader>().ToSingleton<LinuxFramebufferIconLoaderStub>()
                 .Bind<IPlatformSettings>().ToSingleton<DefaultPlatformSettings>()
+                .Bind<PlatformPointerConfiguration>().ToSingleton<PlatformPointerConfiguration>()
                 .Bind<PlatformHotkeyConfiguration>().ToSingleton<PlatformHotkeyConfiguration>();
 
             Compositor = new Compositor(AvaloniaLocator.Current.GetService<IPlatformGraphics>());

diff --git a/src/Windows/Avalonia.Win32/Win32Platform.cs b/src/Windows/Avalonia.Win32/Win32Platform.cs
@@ -93,6 +93,7 @@ public static void Initialize(Win32PlatformOptions options)
                 .Bind<IDispatcherImpl>().ToConstant(s_instance._dispatcher)
                 .Bind<IRenderTimer>().ToConstant(renderTimer)
                 .Bind<IWindowingPlatform>().ToConstant(s_instance)
+                .Bind<PlatformPointerConfiguration>().ToSingleton<PlatformPointerConfiguration>()
                 .Bind<PlatformHotkeyConfiguration>().ToConstant(new PlatformHotkeyConfiguration(KeyModifiers.Control)
                 {
                     OpenContextMenu =

diff --git a/src/iOS/Avalonia.iOS/Platform.cs b/src/iOS/Avalonia.iOS/Platform.cs
@@ -82,6 +82,7 @@ public static void Register(IAvaloniaAppDelegate? appDelegate)
                 .Bind<IWindowingPlatform>().ToConstant(new WindowingPlatformStub())
                 .Bind<IPlatformSettings>().ToSingleton<PlatformSettings>()
                 .Bind<IPlatformIconLoader>().ToConstant(new PlatformIconLoaderStub())
+                .Bind<PlatformPointerConfiguration>().ToSingleton<PlatformPointerConfiguration>()
                 .Bind<PlatformHotkeyConfiguration>().ToSingleton<PlatformHotkeyConfiguration>()
                 .Bind<IRenderTimer>().ToConstant(Timer)
                 .Bind<IDispatcherImpl>().ToConstant(DispatcherImpl.Instance)

diff --git a/tests/Avalonia.UnitTests/UnitTestApplication.cs b/tests/Avalonia.UnitTests/UnitTestApplication.cs
@@ -77,6 +77,7 @@ public override void RegisterServices()
                 .Bind<IDispatcherImpl>().ToConstant(Services.DispatcherImpl)
                 .Bind<ICursorFactory>().ToConstant(Services.StandardCursorFactory)
                 .Bind<IWindowingPlatform>().ToConstant(Services.WindowingPlatform)
+                .Bind<PlatformPointerConfiguration>().ToSingleton<PlatformPointerConfiguration>()
                 .Bind<PlatformHotkeyConfiguration>().ToSingleton<PlatformHotkeyConfiguration>()
                 .Bind<IPlatformSettings>().ToSingleton<DefaultPlatformSettings>()
                 .Bind<IAccessKeyHandler>().ToConstant(Services.AccessKeyHandler)