Replace deprecated scroll-touch-events with input-event

Author: GregorBiswanger

ElectronNET.API/BrowserWindow.cs

@@ -702,93 +702,6 @@ public event Action<string> OnAppCommand
 
         private event Action<string> _appCommand;
 
-        /// <summary>
-        /// Emitted when scroll wheel event phase has begun.
-        /// </summary>
-        public event Action OnScrollTouchBegin
-        {
-            add
-            {
-                if (_scrollTouchBegin == null)
-                {
-                    BridgeConnector.Socket.On("browserWindow-scroll-touch-begin" + Id, () =>
-                    {
-                        _scrollTouchBegin();
-                    });
-
-                    BridgeConnector.Socket.Emit("register-browserWindow-scroll-touch-begin", Id);
-                }
-                _scrollTouchBegin += value;
-            }
-            remove
-            {
-                _scrollTouchBegin -= value;
-
-                if (_scrollTouchBegin == null)
-                    BridgeConnector.Socket.Off("browserWindow-scroll-touch-begin" + Id);
-            }
-        }
-
-        private event Action _scrollTouchBegin;
-
-        /// <summary>
-        /// Emitted when scroll wheel event phase has ended.
-        /// </summary>
-        public event Action OnScrollTouchEnd
-        {
-            add
-            {
-                if (_scrollTouchEnd == null)
-                {
-                    BridgeConnector.Socket.On("browserWindow-scroll-touch-end" + Id, () =>
-                    {
-                        _scrollTouchEnd();
-                    });
-
-                    BridgeConnector.Socket.Emit("register-browserWindow-scroll-touch-end", Id);
-                }
-                _scrollTouchEnd += value;
-            }
-            remove
-            {
-                _scrollTouchEnd -= value;
-
-                if (_scrollTouchEnd == null)
-                    BridgeConnector.Socket.Off("browserWindow-scroll-touch-end" + Id);
-            }
-        }
-
-        private event Action _scrollTouchEnd;
-
-        /// <summary>
-        /// Emitted when scroll wheel event phase filed upon reaching the edge of element.
-        /// </summary>
-        public event Action OnScrollTouchEdge
-        {
-            add
-            {
-                if (_scrollTouchEdge == null)
-                {
-                    BridgeConnector.Socket.On("browserWindow-scroll-touch-edge" + Id, () =>
-                    {
-                        _scrollTouchEdge();
-                    });
-
-                    BridgeConnector.Socket.Emit("register-browserWindow-scroll-touch-edge", Id);
-                }
-                _scrollTouchEdge += value;
-            }
-            remove
-            {
-                _scrollTouchEdge -= value;
-
-                if (_scrollTouchEdge == null)
-                    BridgeConnector.Socket.Off("browserWindow-scroll-touch-edge" + Id);
-            }
-        }
-
-        private event Action _scrollTouchEdge;
-
         /// <summary>
         /// Emitted on 3-finger swipe. Possible directions are up, right, down, left.
         /// </summary>

ElectronNET.API/Converter/ModifierTypeListConverter.cs

@@ -0,0 +1,54 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using ElectronNET.API.Entities;
+using Newtonsoft.Json;
+using Newtonsoft.Json.Linq;
+
+namespace ElectronNET.API.Converter;
+
+/// <summary>
+/// 
+/// </summary>
+public class ModifierTypeListConverter : JsonConverter<List<ModifierType>>
+{
+    /// <summary>
+    /// 
+    /// </summary>
+    /// <param name="reader"></param>
+    /// <param name="objectType"></param>
+    /// <param name="existingValue"></param>
+    /// <param name="hasExistingValue"></param>
+    /// <param name="serializer"></param>
+    /// <returns></returns>
+    public override List<ModifierType> ReadJson(JsonReader reader, Type objectType, List<ModifierType> existingValue, bool hasExistingValue, JsonSerializer serializer)
+    {
+        var token = JToken.Load(reader);
+
+        if (token.Type == JTokenType.Null)
+        {
+            return null;
+        }
+
+
+        return token.ToObject<List<string>>().Select(m => (ModifierType)Enum.Parse(typeof(ModifierType), m)).ToList();
+    }
+
+    /// <summary>
+    /// 
+    /// </summary>
+    /// <param name="writer"></param>
+    /// <param name="value"></param>
+    /// <param name="serializer"></param>
+    public override void WriteJson(JsonWriter writer, List<ModifierType> value, JsonSerializer serializer)
+    {
+        writer.WriteStartArray();
+
+        foreach (var modifier in value)
+        {
+            writer.WriteValue(modifier.ToString());
+        }
+
+        writer.WriteEndArray();
+    }
+}

ElectronNET.API/Entities/InputEvent.cs

@@ -0,0 +1,81 @@
+using Newtonsoft.Json.Converters;
+using System.Collections.Generic;
+using ElectronNET.API.Converter;
+using Newtonsoft.Json;
+
+namespace ElectronNET.API.Entities
+{
+    /// <summary>
+    /// 
+    /// </summary>
+    public class InputEvent
+    {
+        /// <summary>
+        /// Equivalent to KeyboardEvent.key.
+        /// </summary>
+        public string Key { get; set; } = "";
+
+        /// <summary>
+        /// Equivalent to KeyboardEvent.code.
+        /// </summary>
+        public string Code { get; set; } = "";
+
+        /// <summary>
+        /// Equivalent to KeyboardEvent.repeat.
+        /// </summary>
+        public bool IsAutoRepeat { get; set; } = false;
+
+        /// <summary>
+        /// Equivalent to KeyboardEvent.isComposing.
+        /// </summary>
+        public bool IsComposing { get; set; } = false;
+
+        /// <summary>
+        /// Equivalent to KeyboardEvent.shiftKey.
+        /// </summary>
+        public bool Shift { get; set; } = false;
+
+        /// <summary>
+        /// Equivalent to KeyboardEvent.controlKey.
+        /// </summary>
+        public bool Control { get; set; } = false;
+
+        /// <summary>
+        /// Equivalent to KeyboardEvent.altKey.
+        /// </summary>
+        public bool Alt { get; set; } = false;
+
+        /// <summary>
+        /// Equivalent to KeyboardEvent.metaKey.
+        /// </summary>
+        public bool Meta { get; set; } = false;
+
+        /// <summary>
+        /// Equivalent to KeyboardEvent.location.
+        /// </summary>
+        public int Location { get; set; } = 0;
+
+        /// <summary>
+        /// An array of modifiers of the event, can be `shift`, `control`, `ctrl`, `alt`,
+        /// `meta`, `command`, `cmd`, `isKeypad`, `isAutoRepeat`, `leftButtonDown`,
+        /// `middleButtonDown`, `rightButtonDown`, `capsLock`, `numLock`, `left`, `right`
+        /// </summary>
+        [JsonConverter(typeof(ModifierTypeListConverter))]
+        public List<ModifierType> Modifiers { get; set; }
+
+        /// <summary>
+        /// Can be `undefined`, `mouseDown`, `mouseUp`, `mouseMove`, `mouseEnter`,
+        /// `mouseLeave`, `contextMenu`, `mouseWheel`, `rawKeyDown`, `keyDown`, `keyUp`,
+        /// `gestureScrollBegin`, `gestureScrollEnd`, `gestureScrollUpdate`,
+        /// `gestureFlingStart`, `gestureFlingCancel`, `gesturePinchBegin`,
+        /// `gesturePinchEnd`, `gesturePinchUpdate`, `gestureTapDown`, `gestureShowPress`,
+        /// `gestureTap`, `gestureTapCancel`, `gestureShortPress`, `gestureLongPress`,
+        /// `gestureLongTap`, `gestureTwoFingerTap`, `gestureTapUnconfirmed`,
+        /// `gestureDoubleTap`, `touchStart`, `touchMove`, `touchEnd`, `touchCancel`,
+        /// `touchScrollStarted`, `pointerDown`, `pointerUp`, `pointerMove`,
+        /// `pointerRawUpdate`, `pointerCancel` or `pointerCausedUaAction`.
+        /// </summary>
+        [JsonConverter(typeof(StringEnumConverter))]
+        public InputEventType Type { get; set; }
+    }
+}