Editor Widget API: Rename OnWheel to OnMouseWheel (#4505)

sboxbot · RumBugen · web-flow · commit 2b4b1d0ada9e · 2026-04-16T12:23:09.000+01:00
---------

Co-authored-by: RumBugen &lt;vladislavwanner@gmail.com&gt;
diff --git a/engine/Sandbox.Tools/Qt/BaseScrollWidget.cs b/engine/Sandbox.Tools/Qt/BaseScrollWidget.cs
@@ -99,11 +99,11 @@ protected virtual void OnScrollChanged()
 		/// </summary>
 		float SmoothValue;
 
-		protected override void OnWheel( WheelEvent e )
+		protected override void OnMouseWheel( WheelEvent e )
 		{
 			if ( !SmoothScrolling )
 			{
-				base.OnWheel( e );
+				base.OnMouseWheel( e );
 				return;
 			}
 
diff --git a/engine/Sandbox.Tools/Qt/Widget.Events.cs b/engine/Sandbox.Tools/Qt/Widget.Events.cs
@@ -26,11 +26,22 @@ internal static Widget CurrentlyPressedWidget
 		/// </summary>
 		public bool IsPressed => CurrentlyPressedWidget == this;
 
-		internal void InternalWheelEvent( QWheelEvent e ) => OnWheel( new WheelEvent( e ) );
+		internal void InternalWheelEvent( QWheelEvent e ) => OnMouseWheel( new WheelEvent( e ) );
 
 		/// <summary>
 		/// Mouse wheel was scrolled while the mouse cursor was over this widget.
 		/// </summary>
+		protected virtual void OnMouseWheel( WheelEvent e )
+		{
+#pragma warning disable CS0618 // Type or member is obsolete
+			OnWheel( e );
+#pragma warning restore CS0618 // Type or member is obsolete
+		}
+
+		/// <summary>
+		/// Mouse wheel was scrolled while the mouse cursor was over this widget.
+		/// </summary>
+		[Obsolete( $"Use {nameof( OnMouseWheel )}" )]
 		protected virtual void OnWheel( WheelEvent e )
 		{
 
diff --git a/game/addons/tools/Code/Curves/CurveEditor.cs b/game/addons/tools/Code/Curves/CurveEditor.cs
@@ -202,9 +202,9 @@ public CurveEditor( Widget parent ) : base( parent )
 		};
 	}
 
-	protected override void OnWheel( WheelEvent e )
+	protected override void OnMouseWheel( WheelEvent e )
 	{
-		base.OnWheel( e );
+		base.OnMouseWheel( e );
 
 		if ( e.Delta != 0 )
 		{
diff --git a/game/addons/tools/Code/Editor/AssetList/AssetList.cs b/game/addons/tools/Code/Editor/AssetList/AssetList.cs
@@ -524,7 +524,7 @@ public AssetListViewMode ViewMode
 		get => _viewMode;
 	}
 
-	protected override void OnWheel( WheelEvent e )
+	protected override void OnMouseWheel( WheelEvent e )
 	{
 		if ( e.HasCtrl )
 		{
@@ -543,7 +543,7 @@ protected override void OnWheel( WheelEvent e )
 			return;
 		}
 
-		base.OnWheel( e );
+		base.OnMouseWheel( e );
 	}
 
 	void BuildAllIcons()
diff --git a/game/addons/tools/Code/Editor/RectEditor/RectView.cs b/game/addons/tools/Code/Editor/RectEditor/RectView.cs
@@ -569,9 +569,9 @@ protected override void OnResize()
 		UpdateScaledBackgroundImage();
 	}
 
-	protected override void OnWheel( WheelEvent e )
+	protected override void OnMouseWheel( WheelEvent e )
 	{
-		base.OnWheel( e );
+		base.OnMouseWheel( e );
 
 		var mouseUV = PixelToUV( e.Position );
 
diff --git a/game/addons/tools/Code/Editor/SoundEditor/Timeline.cs b/game/addons/tools/Code/Editor/SoundEditor/Timeline.cs
@@ -219,9 +219,9 @@ public void OnFrame()
 		Scrubbing = false;
 	}
 
-	protected override void OnWheel( WheelEvent e )
+	protected override void OnMouseWheel( WheelEvent e )
 	{
-		base.OnWheel( e );
+		base.OnMouseWheel( e );
 
 		e.Accept();
 
diff --git a/game/addons/tools/Code/Editor/SpriteEditor/Timeline.cs b/game/addons/tools/Code/Editor/SpriteEditor/Timeline.cs
@@ -245,9 +245,9 @@ private void UpdatePlayButton()
 		PlayButton.StatusTip = SpriteEditor.IsPlaying ? "Pause" : "Play";
 	}
 
-	protected override void OnWheel( WheelEvent e )
+	protected override void OnMouseWheel( WheelEvent e )
 	{
-		base.OnWheel( e );
+		base.OnMouseWheel( e );
 
 		var delta = e.Delta;
 
diff --git a/game/addons/tools/Code/NodeGraph/GraphView.cs b/game/addons/tools/Code/NodeGraph/GraphView.cs
@@ -177,7 +177,7 @@ internal void MoveableReleased()
 		_moveablePressed = false;
 	}
 
-	protected override void OnWheel( WheelEvent e )
+	protected override void OnMouseWheel( WheelEvent e )
 	{
 		Zoom( e.Delta > 0 ? 1.1f : 0.90f, e.Position );
 		if ( FadeOutBackground )
diff --git a/game/addons/tools/Code/Widgets/KeyBind.cs b/game/addons/tools/Code/Widgets/KeyBind.cs
@@ -39,9 +39,9 @@ public KeyBind( Widget parent ) : base( parent )
 		FocusMode = FocusMode.Click;
 	}
 
-	protected override void OnWheel( WheelEvent e )
+	protected override void OnMouseWheel( WheelEvent e )
 	{
-		base.OnWheel( e );
+		base.OnMouseWheel( e );
 
 		if ( IsTrapping )
 		{
diff --git a/game/addons/tools/Code/Widgets/SoundPlayer/SoundPlayer.cs b/game/addons/tools/Code/Widgets/SoundPlayer/SoundPlayer.cs
@@ -281,7 +281,7 @@ public void MoveScrubber( float position, bool centreOn = true )
 			WaveForm.Update();
 		}
 
-		protected override void OnWheel( WheelEvent e )
+		protected override void OnMouseWheel( WheelEvent e )
 		{
 			ZoomLevel *= e.Delta > 0 ? 1.1f : 0.90f;
 			ZoomLevel = ZoomLevel.Clamp( 1.0f, 20.0f );
diff --git a/game/addons/tools/Code/Widgets/WebWidget.cs b/game/addons/tools/Code/Widgets/WebWidget.cs
@@ -66,7 +66,7 @@ protected override void OnMouseMove( MouseEvent e )
 		else Cursor = CursorShape.Arrow;
 	}
 
-	protected override void OnWheel( WheelEvent e ) => Surface?.TellMouseWheel( (int)e.Delta );
+	protected override void OnMouseWheel( WheelEvent e ) => Surface?.TellMouseWheel( (int)e.Delta );
 	protected override void OnMousePress( MouseEvent e ) => Surface.TellMouseButton( e.Button, true );
 	protected override void OnMouseReleased( MouseEvent e ) => Surface.TellMouseButton( e.Button, false );
 	protected override void OnFocus( FocusChangeReason reason ) => Surface.HasKeyFocus = true;
diff --git a/game/editor/MovieMaker/Code/Editor/TrackListWidget.cs b/game/editor/MovieMaker/Code/Editor/TrackListWidget.cs
@@ -116,7 +116,7 @@ public override void OnDestroyed()
 		SceneEditorSession.Selection.OnItemAdded -= OnSelectionAdded;
 	}
 
-	protected override void OnWheel( WheelEvent e )
+	protected override void OnMouseWheel( WheelEvent e )
 	{
 		Session.Editor.TimelinePanel?.Timeline.ScrollImmediate( e.Delta );
 	}
diff --git a/game/editor/MovieMaker/Code/Timeline/Timeline.cs b/game/editor/MovieMaker/Code/Timeline/Timeline.cs
@@ -204,9 +204,9 @@ private bool UpdateTrack( TrackView source, TimelineTrack item )
 		return true;
 	}
 
-	protected override void OnWheel( WheelEvent e )
+	protected override void OnMouseWheel( WheelEvent e )
 	{
-		base.OnWheel( e );
+		base.OnMouseWheel( e );
 
 		Session.EditMode?.MouseWheel( e );
 
diff --git a/game/editor/ShaderGraph/Code/Preview.cs b/game/editor/ShaderGraph/Code/Preview.cs
@@ -895,9 +895,9 @@ protected override void OnMouseReleased( MouseEvent e )
 		}
 	}
 
-	protected override void OnWheel( WheelEvent e )
+	protected override void OnMouseWheel( WheelEvent e )
 	{
-		base.OnWheel( e );
+		base.OnMouseWheel( e );
 
 		Zoom( e.Delta * -0.1f );
 	}

Original file line number	Diff line number	Diff line change
`@@ -99,11 +99,11 @@ protected virtual void OnScrollChanged()`
`99`	`99`	`/// </summary>`
`100`	`100`	`float SmoothValue;`
`101`	`101`
`102`		`- protected override void OnWheel( WheelEvent e )`
	`102`	`+ protected override void OnMouseWheel( WheelEvent e )`
`103`	`103`	`{`
`104`	`104`	`if ( !SmoothScrolling )`
`105`	`105`	`{`
`106`		`- base.OnWheel( e );`
	`106`	`+ base.OnMouseWheel( e );`
`107`	`107`	`return;`
`108`	`108`	`}`
`109`	`109`
Original file line number	Diff line number	Diff line change
`@@ -202,9 +202,9 @@ public CurveEditor( Widget parent ) : base( parent )`
`202`	`202`	`};`
`203`	`203`	`}`
`204`	`204`
`205`		`- protected override void OnWheel( WheelEvent e )`
	`205`	`+ protected override void OnMouseWheel( WheelEvent e )`
`206`	`206`	`{`
`207`		`- base.OnWheel( e );`
	`207`	`+ base.OnMouseWheel( e );`
`208`	`208`
`209`	`209`	`if ( e.Delta != 0 )`
`210`	`210`	`{`
Original file line number	Diff line number	Diff line change
`@@ -524,7 +524,7 @@ public AssetListViewMode ViewMode`
`524`	`524`	`get => _viewMode;`
`525`	`525`	`}`
`526`	`526`
`527`		`- protected override void OnWheel( WheelEvent e )`
	`527`	`+ protected override void OnMouseWheel( WheelEvent e )`
`528`	`528`	`{`
`529`	`529`	`if ( e.HasCtrl )`
`530`	`530`	`{`
`@@ -543,7 +543,7 @@ protected override void OnWheel( WheelEvent e )`
`543`	`543`	`return;`
`544`	`544`	`}`
`545`	`545`
`546`		`- base.OnWheel( e );`
	`546`	`+ base.OnMouseWheel( e );`
`547`	`547`	`}`
`548`	`548`
`549`	`549`	`void BuildAllIcons()`
Original file line number	Diff line number	Diff line change
`@@ -569,9 +569,9 @@ protected override void OnResize()`
`569`	`569`	`UpdateScaledBackgroundImage();`
`570`	`570`	`}`
`571`	`571`
`572`		`- protected override void OnWheel( WheelEvent e )`
	`572`	`+ protected override void OnMouseWheel( WheelEvent e )`
`573`	`573`	`{`
`574`		`- base.OnWheel( e );`
	`574`	`+ base.OnMouseWheel( e );`
`575`	`575`
`576`	`576`	`var mouseUV = PixelToUV( e.Position );`
`577`	`577`
Original file line number	Diff line number	Diff line change
`@@ -219,9 +219,9 @@ public void OnFrame()`
`219`	`219`	`Scrubbing = false;`
`220`	`220`	`}`
`221`	`221`
`222`		`- protected override void OnWheel( WheelEvent e )`
	`222`	`+ protected override void OnMouseWheel( WheelEvent e )`
`223`	`223`	`{`
`224`		`- base.OnWheel( e );`
	`224`	`+ base.OnMouseWheel( e );`
`225`	`225`
`226`	`226`	`e.Accept();`
`227`	`227`
Original file line number	Diff line number	Diff line change
`@@ -245,9 +245,9 @@ private void UpdatePlayButton()`
`245`	`245`	`PlayButton.StatusTip = SpriteEditor.IsPlaying ? "Pause" : "Play";`
`246`	`246`	`}`
`247`	`247`
`248`		`- protected override void OnWheel( WheelEvent e )`
	`248`	`+ protected override void OnMouseWheel( WheelEvent e )`
`249`	`249`	`{`
`250`		`- base.OnWheel( e );`
	`250`	`+ base.OnMouseWheel( e );`
`251`	`251`
`252`	`252`	`var delta = e.Delta;`
`253`	`253`
Original file line number	Diff line number	Diff line change
`@@ -177,7 +177,7 @@ internal void MoveableReleased()`
`177`	`177`	`_moveablePressed = false;`
`178`	`178`	`}`
`179`	`179`
`180`		`- protected override void OnWheel( WheelEvent e )`
	`180`	`+ protected override void OnMouseWheel( WheelEvent e )`
`181`	`181`	`{`
`182`	`182`	`Zoom( e.Delta > 0 ? 1.1f : 0.90f, e.Position );`
`183`	`183`	`if ( FadeOutBackground )`
Original file line number	Diff line number	Diff line change
`@@ -39,9 +39,9 @@ public KeyBind( Widget parent ) : base( parent )`
`39`	`39`	`FocusMode = FocusMode.Click;`
`40`	`40`	`}`
`41`	`41`
`42`		`- protected override void OnWheel( WheelEvent e )`
	`42`	`+ protected override void OnMouseWheel( WheelEvent e )`
`43`	`43`	`{`
`44`		`- base.OnWheel( e );`
	`44`	`+ base.OnMouseWheel( e );`
`45`	`45`
`46`	`46`	`if ( IsTrapping )`
`47`	`47`	`{`
Original file line number	Diff line number	Diff line change
`@@ -281,7 +281,7 @@ public void MoveScrubber( float position, bool centreOn = true )`
`281`	`281`	`WaveForm.Update();`
`282`	`282`	`}`
`283`	`283`
`284`		`- protected override void OnWheel( WheelEvent e )`
	`284`	`+ protected override void OnMouseWheel( WheelEvent e )`
`285`	`285`	`{`
`286`	`286`	`ZoomLevel *= e.Delta > 0 ? 1.1f : 0.90f;`
`287`	`287`	`ZoomLevel = ZoomLevel.Clamp( 1.0f, 20.0f );`