[dotnet] warn about upcoming changes to MoveToElementOffsetOrigin

titusfortner · titusfortner · commit cb68cf53b230 · 2022-05-27T00:39:48.000-05:00
diff --git a/dotnet/src/webdriver/Interactions/Actions.cs b/dotnet/src/webdriver/Interactions/Actions.cs
@@ -25,7 +25,10 @@ namespace OpenQA.Selenium.Interactions
     /// <summary>
     /// Provides values that indicate from where element offsets for MoveToElement
     /// are calculated.
+    /// Note: TopLeft only does the expected thing when the element is completely
+    /// inside the viewport.
     /// </summary>
+    [Obsolete("Starting in Selenium 4.3 only Center behavior will be supported")]
     public enum MoveToElementOffsetOrigin
     {
         /// <summary>
@@ -308,6 +311,7 @@ public Actions MoveToElement(IWebElement toElement)
 
         /// <summary>
         /// Moves the mouse to the specified offset of the top-left corner of the specified element.
+        /// In Selenium 4.3 the origin for the offset will be the in-view center point of the element.
         /// </summary>
         /// <param name="toElement">The element to which to move the mouse.</param>
         /// <param name="offsetX">The horizontal offset to which to move the mouse.</param>
@@ -326,6 +330,7 @@ public Actions MoveToElement(IWebElement toElement, int offsetX, int offsetY)
         /// <param name="offsetY">The vertical offset to which to move the mouse.</param>
         /// <param name="offsetOrigin">The <see cref="MoveToElementOffsetOrigin"/> value from which to calculate the offset.</param>
         /// <returns>A self-reference to this <see cref="Actions"/>.</returns>
+        [Obsolete("Starting in Selenium 4.3 only MoveToElementOffsetOrigin.Center will be supported")]
         public Actions MoveToElement(IWebElement toElement, int offsetX, int offsetY, MoveToElementOffsetOrigin offsetOrigin)
         {
             ILocatable target = GetLocatableFromElement(toElement);
diff --git a/dotnet/src/webdriver/Interactions/PointerInputDevice.cs b/dotnet/src/webdriver/Interactions/PointerInputDevice.cs
@@ -102,11 +102,6 @@ public enum MouseButton
         /// The X2 button used for navigating forward.
         /// </summary>
         Forward = 4,
-
-        /// <summary>
-        /// The button used by Pen pointers to erase.
-        /// </summary>
-        Eraser = 5
     }
 
     /// <summary>
@@ -177,7 +172,7 @@ public override Dictionary<string, object> ToDictionary()
         /// <returns>The action representing the pointer down gesture.</returns>
         public Interaction CreatePointerDown(MouseButton button)
         {
-            return new PointerDownInteraction(this, button, new PointerEventProperties());
+            return CreatePointerDown(button, new PointerEventProperties());
         }
 
         /// <summary>
@@ -201,7 +196,7 @@ public Interaction CreatePointerDown(MouseButton button, PointerEventProperties
         /// <returns>The action representing the pointer up gesture.</returns>
         public Interaction CreatePointerUp(MouseButton button)
         {
-            return new PointerUpInteraction(this, button, new PointerEventProperties());
+            return CreatePointerUp(button, new PointerEventProperties());
         }
 
         /// <summary>
@@ -228,7 +223,7 @@ public Interaction CreatePointerUp(MouseButton button, PointerEventProperties pr
         /// <returns>The action representing the pointer move gesture.</returns>
         public Interaction CreatePointerMove(IWebElement target, int xOffset, int yOffset, TimeSpan duration)
         {
-            return new PointerMoveInteraction(this, target, CoordinateOrigin.Element, xOffset, yOffset, duration, new PointerEventProperties());
+            return CreatePointerMove(target, xOffset, yOffset, duration, new PointerEventProperties());
         }
 
         /// <summary>
@@ -258,12 +253,7 @@ public Interaction CreatePointerMove(IWebElement target, int xOffset, int yOffse
         /// Users should us the other CreatePointerMove overload to move to a specific element.</exception>
         public Interaction CreatePointerMove(CoordinateOrigin origin, int xOffset, int yOffset, TimeSpan duration)
         {
-            if (origin == CoordinateOrigin.Element)
-            {
-                throw new ArgumentException("Using a value of CoordinateOrigin.Element without an element is not supported.", nameof(origin));
-            }
-
-            return new PointerMoveInteraction(this, null, origin, xOffset, yOffset, duration, new PointerEventProperties());
+            return CreatePointerMove(origin, xOffset, yOffset, duration, new PointerEventProperties());
         }
 
         /// <summary>

Original file line number	Diff line number	Diff line change
`@@ -102,11 +102,6 @@ public enum MouseButton`
`102`	`102`	`/// The X2 button used for navigating forward.`
`103`	`103`	`/// </summary>`
`104`	`104`	`Forward = 4,`
`105`		`-`
`106`		`- /// <summary>`
`107`		`- /// The button used by Pen pointers to erase.`
`108`		`- /// </summary>`
`109`		`- Eraser = 5`
`110`	`105`	`}`
`111`	`106`
`112`	`107`	`/// <summary>`
`@@ -177,7 +172,7 @@ public override Dictionary<string, object> ToDictionary()`
`177`	`172`	`/// <returns>The action representing the pointer down gesture.</returns>`
`178`	`173`	`public Interaction CreatePointerDown(MouseButton button)`
`179`	`174`	`{`
`180`		`- return new PointerDownInteraction(this, button, new PointerEventProperties());`
	`175`	`+ return CreatePointerDown(button, new PointerEventProperties());`
`181`	`176`	`}`
`182`	`177`
`183`	`178`	`/// <summary>`
`@@ -201,7 +196,7 @@ public Interaction CreatePointerDown(MouseButton button, PointerEventProperties`
`201`	`196`	`/// <returns>The action representing the pointer up gesture.</returns>`
`202`	`197`	`public Interaction CreatePointerUp(MouseButton button)`
`203`	`198`	`{`
`204`		`- return new PointerUpInteraction(this, button, new PointerEventProperties());`
	`199`	`+ return CreatePointerUp(button, new PointerEventProperties());`
`205`	`200`	`}`
`206`	`201`
`207`	`202`	`/// <summary>`
`@@ -228,7 +223,7 @@ public Interaction CreatePointerUp(MouseButton button, PointerEventProperties pr`
`228`	`223`	`/// <returns>The action representing the pointer move gesture.</returns>`
`229`	`224`	`public Interaction CreatePointerMove(IWebElement target, int xOffset, int yOffset, TimeSpan duration)`
`230`	`225`	`{`
`231`		`- return new PointerMoveInteraction(this, target, CoordinateOrigin.Element, xOffset, yOffset, duration, new PointerEventProperties());`
	`226`	`+ return CreatePointerMove(target, xOffset, yOffset, duration, new PointerEventProperties());`
`232`	`227`	`}`
`233`	`228`
`234`	`229`	`/// <summary>`
`@@ -258,12 +253,7 @@ public Interaction CreatePointerMove(IWebElement target, int xOffset, int yOffse`
`258`	`253`	`/// Users should us the other CreatePointerMove overload to move to a specific element.</exception>`
`259`	`254`	`public Interaction CreatePointerMove(CoordinateOrigin origin, int xOffset, int yOffset, TimeSpan duration)`
`260`	`255`	`{`
`261`		`- if (origin == CoordinateOrigin.Element)`
`262`		`- {`
`263`		`- throw new ArgumentException("Using a value of CoordinateOrigin.Element without an element is not supported.", nameof(origin));`
`264`		`- }`
`265`		`-`
`266`		`- return new PointerMoveInteraction(this, null, origin, xOffset, yOffset, duration, new PointerEventProperties());`
	`256`	`+ return CreatePointerMove(origin, xOffset, yOffset, duration, new PointerEventProperties());`
`267`	`257`	`}`
`268`	`258`
`269`	`259`	`/// <summary>`