breaking change: Make Bind use non-generic IViewFor (#3676)

**What kind of change does this PR introduce?**  Fix for #3644 **What is the current behavior?**  BindCommand requires a view inherited from `IViewFor<TViewModel>` ReactiveUserControl inherits `IViewFor<TViewModel>` which requires Generics which WinForms does not work well with. **What is the new behavior?**  Add BindCommandNonGeneric this is to avoid the request of not changing the existing code, therefore adding to the available options. NOTE: Bind only requires `IViewFor` and `IViewFor<TViewModel>` inherits `IViewFor` therefore would still be an API change if BindCommand were relaxed to IViewFor in the same way as Bind, but perhaps the best route. add ReactiveUserControlNonGeneric for WinForms - inherits `IViewFor` **What might this PR break?** Non due to new functions **Please check if the PR fulfills these requirements** - [ ] Tests for the changes have been added (for bug fixes / features) - [ ] Docs have been added / updated (for bug fixes / features) **Other information**:
reactiveui · Nov 23, 2023 · 246e8ef · 246e8ef
1 parent 45a92af
commit 246e8ef
Show file tree

Hide file tree

Showing 16 changed files with 487 additions and 35 deletions.
diff --git a/src/ReactiveUI.Tests/API/ApiApprovalTests.ReactiveUI.DotNet6_0.verified.txt b/src/ReactiveUI.Tests/API/ApiApprovalTests.ReactiveUI.DotNet6_0.verified.txt
@@ -92,6 +92,18 @@ namespace ReactiveUI
             where TView :  class, ReactiveUI.IViewFor<TViewModel>
             where TViewModel :  class
             where TProp : System.Windows.Input.ICommand { }
+        public static ReactiveUI.IReactiveBinding<TView, TProp> BindCommandNonGeneric<TView, TViewModel, TProp, TControl>(this TView view, TViewModel? viewModel, System.Linq.Expressions.Expression<System.Func<TViewModel, TProp?>> propertyName, System.Linq.Expressions.Expression<System.Func<TView, TControl>> controlName, string? toEvent = null)
+            where TView :  class, ReactiveUI.IViewFor
+            where TViewModel :  class
+            where TProp : System.Windows.Input.ICommand { }
+        public static ReactiveUI.IReactiveBinding<TView, TProp> BindCommandNonGeneric<TView, TViewModel, TProp, TControl, TParam>(this TView view, TViewModel? viewModel, System.Linq.Expressions.Expression<System.Func<TViewModel, TProp?>> propertyName, System.Linq.Expressions.Expression<System.Func<TView, TControl>> controlName, System.IObservable<TParam?> withParameter, string? toEvent = null)
+            where TView :  class, ReactiveUI.IViewFor
+            where TViewModel :  class
+            where TProp : System.Windows.Input.ICommand { }
+        public static ReactiveUI.IReactiveBinding<TView, TProp> BindCommandNonGeneric<TView, TViewModel, TProp, TControl, TParam>(this TView view, TViewModel? viewModel, System.Linq.Expressions.Expression<System.Func<TViewModel, TProp?>> propertyName, System.Linq.Expressions.Expression<System.Func<TView, TControl>> controlName, System.Linq.Expressions.Expression<System.Func<TViewModel, TParam?>> withParameter, string? toEvent = null)
+            where TView :  class, ReactiveUI.IViewFor
+            where TViewModel :  class
+            where TProp : System.Windows.Input.ICommand { }
     }
     public class CommandBinderImplementation : Splat.IEnableLogger
     {
@@ -104,6 +116,14 @@ namespace ReactiveUI
             where TView :  class, ReactiveUI.IViewFor<TViewModel>
             where TViewModel :  class
             where TProp : System.Windows.Input.ICommand { }
+        public ReactiveUI.IReactiveBinding<TView, TProp> BindCommandNonGeneric<TView, TViewModel, TProp, TControl, TParam>(TViewModel? viewModel, TView view, System.Linq.Expressions.Expression<System.Func<TViewModel, TProp?>> vmProperty, System.Linq.Expressions.Expression<System.Func<TView, TControl>> controlProperty, System.IObservable<TParam?> withParameter, string? toEvent = null)
+            where TView :  class, ReactiveUI.IViewFor
+            where TViewModel :  class
+            where TProp : System.Windows.Input.ICommand { }
+        public ReactiveUI.IReactiveBinding<TView, TProp> BindCommandNonGeneric<TView, TViewModel, TProp, TControl, TParam>(TViewModel? viewModel, TView view, System.Linq.Expressions.Expression<System.Func<TViewModel, TProp?>> vmProperty, System.Linq.Expressions.Expression<System.Func<TView, TControl>> controlProperty, System.Linq.Expressions.Expression<System.Func<TViewModel, TParam?>> withParameter, string? toEvent = null)
+            where TView :  class, ReactiveUI.IViewFor
+            where TViewModel :  class
+            where TProp : System.Windows.Input.ICommand { }
     }
     public static class ComparerChainingExtensions
     {

diff --git a/src/ReactiveUI.Tests/API/ApiApprovalTests.ReactiveUI.DotNet7_0.verified.txt b/src/ReactiveUI.Tests/API/ApiApprovalTests.ReactiveUI.DotNet7_0.verified.txt
@@ -92,6 +92,18 @@ namespace ReactiveUI
             where TView :  class, ReactiveUI.IViewFor<TViewModel>
             where TViewModel :  class
             where TProp : System.Windows.Input.ICommand { }
+        public static ReactiveUI.IReactiveBinding<TView, TProp> BindCommandNonGeneric<TView, TViewModel, TProp, TControl>(this TView view, TViewModel? viewModel, System.Linq.Expressions.Expression<System.Func<TViewModel, TProp?>> propertyName, System.Linq.Expressions.Expression<System.Func<TView, TControl>> controlName, string? toEvent = null)
+            where TView :  class, ReactiveUI.IViewFor
+            where TViewModel :  class
+            where TProp : System.Windows.Input.ICommand { }
+        public static ReactiveUI.IReactiveBinding<TView, TProp> BindCommandNonGeneric<TView, TViewModel, TProp, TControl, TParam>(this TView view, TViewModel? viewModel, System.Linq.Expressions.Expression<System.Func<TViewModel, TProp?>> propertyName, System.Linq.Expressions.Expression<System.Func<TView, TControl>> controlName, System.IObservable<TParam?> withParameter, string? toEvent = null)
+            where TView :  class, ReactiveUI.IViewFor
+            where TViewModel :  class
+            where TProp : System.Windows.Input.ICommand { }
+        public static ReactiveUI.IReactiveBinding<TView, TProp> BindCommandNonGeneric<TView, TViewModel, TProp, TControl, TParam>(this TView view, TViewModel? viewModel, System.Linq.Expressions.Expression<System.Func<TViewModel, TProp?>> propertyName, System.Linq.Expressions.Expression<System.Func<TView, TControl>> controlName, System.Linq.Expressions.Expression<System.Func<TViewModel, TParam?>> withParameter, string? toEvent = null)
+            where TView :  class, ReactiveUI.IViewFor
+            where TViewModel :  class
+            where TProp : System.Windows.Input.ICommand { }
     }
     public class CommandBinderImplementation : Splat.IEnableLogger
     {
@@ -104,6 +116,14 @@ namespace ReactiveUI
             where TView :  class, ReactiveUI.IViewFor<TViewModel>
             where TViewModel :  class
             where TProp : System.Windows.Input.ICommand { }
+        public ReactiveUI.IReactiveBinding<TView, TProp> BindCommandNonGeneric<TView, TViewModel, TProp, TControl, TParam>(TViewModel? viewModel, TView view, System.Linq.Expressions.Expression<System.Func<TViewModel, TProp?>> vmProperty, System.Linq.Expressions.Expression<System.Func<TView, TControl>> controlProperty, System.IObservable<TParam?> withParameter, string? toEvent = null)
+            where TView :  class, ReactiveUI.IViewFor
+            where TViewModel :  class
+            where TProp : System.Windows.Input.ICommand { }
+        public ReactiveUI.IReactiveBinding<TView, TProp> BindCommandNonGeneric<TView, TViewModel, TProp, TControl, TParam>(TViewModel? viewModel, TView view, System.Linq.Expressions.Expression<System.Func<TViewModel, TProp?>> vmProperty, System.Linq.Expressions.Expression<System.Func<TView, TControl>> controlProperty, System.Linq.Expressions.Expression<System.Func<TViewModel, TParam?>> withParameter, string? toEvent = null)
+            where TView :  class, ReactiveUI.IViewFor
+            where TViewModel :  class
+            where TProp : System.Windows.Input.ICommand { }
     }
     public static class ComparerChainingExtensions
     {

diff --git a/src/ReactiveUI.Tests/API/ApiApprovalTests.ReactiveUI.DotNet8_0.verified.txt b/src/ReactiveUI.Tests/API/ApiApprovalTests.ReactiveUI.DotNet8_0.verified.txt
@@ -92,6 +92,18 @@ namespace ReactiveUI
             where TView :  class, ReactiveUI.IViewFor<TViewModel>
             where TViewModel :  class
             where TProp : System.Windows.Input.ICommand { }
+        public static ReactiveUI.IReactiveBinding<TView, TProp> BindCommandNonGeneric<TView, TViewModel, TProp, TControl>(this TView view, TViewModel? viewModel, System.Linq.Expressions.Expression<System.Func<TViewModel, TProp?>> propertyName, System.Linq.Expressions.Expression<System.Func<TView, TControl>> controlName, string? toEvent = null)
+            where TView :  class, ReactiveUI.IViewFor
+            where TViewModel :  class
+            where TProp : System.Windows.Input.ICommand { }
+        public static ReactiveUI.IReactiveBinding<TView, TProp> BindCommandNonGeneric<TView, TViewModel, TProp, TControl, TParam>(this TView view, TViewModel? viewModel, System.Linq.Expressions.Expression<System.Func<TViewModel, TProp?>> propertyName, System.Linq.Expressions.Expression<System.Func<TView, TControl>> controlName, System.IObservable<TParam?> withParameter, string? toEvent = null)
+            where TView :  class, ReactiveUI.IViewFor
+            where TViewModel :  class
+            where TProp : System.Windows.Input.ICommand { }
+        public static ReactiveUI.IReactiveBinding<TView, TProp> BindCommandNonGeneric<TView, TViewModel, TProp, TControl, TParam>(this TView view, TViewModel? viewModel, System.Linq.Expressions.Expression<System.Func<TViewModel, TProp?>> propertyName, System.Linq.Expressions.Expression<System.Func<TView, TControl>> controlName, System.Linq.Expressions.Expression<System.Func<TViewModel, TParam?>> withParameter, string? toEvent = null)
+            where TView :  class, ReactiveUI.IViewFor
+            where TViewModel :  class
+            where TProp : System.Windows.Input.ICommand { }
     }
     public class CommandBinderImplementation : Splat.IEnableLogger
     {
@@ -104,6 +116,14 @@ namespace ReactiveUI
             where TView :  class, ReactiveUI.IViewFor<TViewModel>
             where TViewModel :  class
             where TProp : System.Windows.Input.ICommand { }
+        public ReactiveUI.IReactiveBinding<TView, TProp> BindCommandNonGeneric<TView, TViewModel, TProp, TControl, TParam>(TViewModel? viewModel, TView view, System.Linq.Expressions.Expression<System.Func<TViewModel, TProp?>> vmProperty, System.Linq.Expressions.Expression<System.Func<TView, TControl>> controlProperty, System.IObservable<TParam?> withParameter, string? toEvent = null)
+            where TView :  class, ReactiveUI.IViewFor
+            where TViewModel :  class
+            where TProp : System.Windows.Input.ICommand { }
+        public ReactiveUI.IReactiveBinding<TView, TProp> BindCommandNonGeneric<TView, TViewModel, TProp, TControl, TParam>(TViewModel? viewModel, TView view, System.Linq.Expressions.Expression<System.Func<TViewModel, TProp?>> vmProperty, System.Linq.Expressions.Expression<System.Func<TView, TControl>> controlProperty, System.Linq.Expressions.Expression<System.Func<TViewModel, TParam?>> withParameter, string? toEvent = null)
+            where TView :  class, ReactiveUI.IViewFor
+            where TViewModel :  class
+            where TProp : System.Windows.Input.ICommand { }
     }
     public static class ComparerChainingExtensions
     {

diff --git a/src/ReactiveUI.Tests/API/ApiApprovalTests.ReactiveUI.Net4_7.verified.txt b/src/ReactiveUI.Tests/API/ApiApprovalTests.ReactiveUI.Net4_7.verified.txt
@@ -90,6 +90,18 @@ namespace ReactiveUI
             where TView :  class, ReactiveUI.IViewFor<TViewModel>
             where TViewModel :  class
             where TProp : System.Windows.Input.ICommand { }
+        public static ReactiveUI.IReactiveBinding<TView, TProp> BindCommandNonGeneric<TView, TViewModel, TProp, TControl>(this TView view, TViewModel? viewModel, System.Linq.Expressions.Expression<System.Func<TViewModel, TProp?>> propertyName, System.Linq.Expressions.Expression<System.Func<TView, TControl>> controlName, string? toEvent = null)
+            where TView :  class, ReactiveUI.IViewFor
+            where TViewModel :  class
+            where TProp : System.Windows.Input.ICommand { }
+        public static ReactiveUI.IReactiveBinding<TView, TProp> BindCommandNonGeneric<TView, TViewModel, TProp, TControl, TParam>(this TView view, TViewModel? viewModel, System.Linq.Expressions.Expression<System.Func<TViewModel, TProp?>> propertyName, System.Linq.Expressions.Expression<System.Func<TView, TControl>> controlName, System.IObservable<TParam?> withParameter, string? toEvent = null)
+            where TView :  class, ReactiveUI.IViewFor
+            where TViewModel :  class
+            where TProp : System.Windows.Input.ICommand { }
+        public static ReactiveUI.IReactiveBinding<TView, TProp> BindCommandNonGeneric<TView, TViewModel, TProp, TControl, TParam>(this TView view, TViewModel? viewModel, System.Linq.Expressions.Expression<System.Func<TViewModel, TProp?>> propertyName, System.Linq.Expressions.Expression<System.Func<TView, TControl>> controlName, System.Linq.Expressions.Expression<System.Func<TViewModel, TParam?>> withParameter, string? toEvent = null)
+            where TView :  class, ReactiveUI.IViewFor
+            where TViewModel :  class
+            where TProp : System.Windows.Input.ICommand { }
     }
     public class CommandBinderImplementation : Splat.IEnableLogger
     {
@@ -102,6 +114,14 @@ namespace ReactiveUI
             where TView :  class, ReactiveUI.IViewFor<TViewModel>
             where TViewModel :  class
             where TProp : System.Windows.Input.ICommand { }
+        public ReactiveUI.IReactiveBinding<TView, TProp> BindCommandNonGeneric<TView, TViewModel, TProp, TControl, TParam>(TViewModel? viewModel, TView view, System.Linq.Expressions.Expression<System.Func<TViewModel, TProp?>> vmProperty, System.Linq.Expressions.Expression<System.Func<TView, TControl>> controlProperty, System.IObservable<TParam?> withParameter, string? toEvent = null)
+            where TView :  class, ReactiveUI.IViewFor
+            where TViewModel :  class
+            where TProp : System.Windows.Input.ICommand { }
+        public ReactiveUI.IReactiveBinding<TView, TProp> BindCommandNonGeneric<TView, TViewModel, TProp, TControl, TParam>(TViewModel? viewModel, TView view, System.Linq.Expressions.Expression<System.Func<TViewModel, TProp?>> vmProperty, System.Linq.Expressions.Expression<System.Func<TView, TControl>> controlProperty, System.Linq.Expressions.Expression<System.Func<TViewModel, TParam?>> withParameter, string? toEvent = null)
+            where TView :  class, ReactiveUI.IViewFor
+            where TViewModel :  class
+            where TProp : System.Windows.Input.ICommand { }
     }
     public static class ComparerChainingExtensions
     {

diff --git a/...eUI.Tests/Platforms/winforms/API/WinformsApiApprovalTests.Winforms.DotNet6_0.verified.txt b/...eUI.Tests/Platforms/winforms/API/WinformsApiApprovalTests.Winforms.DotNet6_0.verified.txt
@@ -32,6 +32,11 @@ namespace ReactiveUI.Winforms
         public PlatformOperations() { }
         public string? GetOrientation() { }
     }
+    public class ReactiveUserControlNonGeneric : System.Windows.Forms.UserControl, ReactiveUI.IActivatableView, ReactiveUI.IViewFor
+    {
+        public ReactiveUserControlNonGeneric() { }
+        protected override void Dispose(bool disposing) { }
+    }
     public class ReactiveUserControl<TViewModel> : System.Windows.Forms.UserControl, ReactiveUI.IActivatableView, ReactiveUI.IViewFor, ReactiveUI.IViewFor<TViewModel>
         where TViewModel :  class
     {

diff --git a/...eUI.Tests/Platforms/winforms/API/WinformsApiApprovalTests.Winforms.DotNet7_0.verified.txt b/...eUI.Tests/Platforms/winforms/API/WinformsApiApprovalTests.Winforms.DotNet7_0.verified.txt
@@ -32,6 +32,11 @@ namespace ReactiveUI.Winforms
         public PlatformOperations() { }
         public string? GetOrientation() { }
     }
+    public class ReactiveUserControlNonGeneric : System.Windows.Forms.UserControl, ReactiveUI.IActivatableView, ReactiveUI.IViewFor
+    {
+        public ReactiveUserControlNonGeneric() { }
+        protected override void Dispose(bool disposing) { }
+    }
     public class ReactiveUserControl<TViewModel> : System.Windows.Forms.UserControl, ReactiveUI.IActivatableView, ReactiveUI.IViewFor, ReactiveUI.IViewFor<TViewModel>
         where TViewModel :  class
     {

diff --git a/...eUI.Tests/Platforms/winforms/API/WinformsApiApprovalTests.Winforms.DotNet8_0.verified.txt b/...eUI.Tests/Platforms/winforms/API/WinformsApiApprovalTests.Winforms.DotNet8_0.verified.txt
@@ -32,6 +32,11 @@ namespace ReactiveUI.Winforms
         public PlatformOperations() { }
         public string? GetOrientation() { }
     }
+    public class ReactiveUserControlNonGeneric : System.Windows.Forms.UserControl, ReactiveUI.IActivatableView, ReactiveUI.IViewFor
+    {
+        public ReactiveUserControlNonGeneric() { }
+        protected override void Dispose(bool disposing) { }
+    }
     public class ReactiveUserControl<TViewModel> : System.Windows.Forms.UserControl, ReactiveUI.IActivatableView, ReactiveUI.IViewFor, ReactiveUI.IViewFor<TViewModel>
         where TViewModel :  class
     {

diff --git a/...tiveUI.Tests/Platforms/winforms/API/WinformsApiApprovalTests.Winforms.Net4_7.verified.txt b/...tiveUI.Tests/Platforms/winforms/API/WinformsApiApprovalTests.Winforms.Net4_7.verified.txt
@@ -30,6 +30,11 @@ namespace ReactiveUI.Winforms
         public PlatformOperations() { }
         public string? GetOrientation() { }
     }
+    public class ReactiveUserControlNonGeneric : System.Windows.Forms.UserControl, ReactiveUI.IActivatableView, ReactiveUI.IViewFor
+    {
+        public ReactiveUserControlNonGeneric() { }
+        protected override void Dispose(bool disposing) { }
+    }
     public class ReactiveUserControl<TViewModel> : System.Windows.Forms.UserControl, ReactiveUI.IActivatableView, ReactiveUI.IViewFor, ReactiveUI.IViewFor<TViewModel>
         where TViewModel :  class
     {

diff --git a/src/ReactiveUI.Winforms/ReactiveUserControlNonGeneric.Designer.cs b/src/ReactiveUI.Winforms/ReactiveUserControlNonGeneric.Designer.cs
diff --git a/src/ReactiveUI.Winforms/ReactiveUserControlNonGeneric.cs b/src/ReactiveUI.Winforms/ReactiveUserControlNonGeneric.cs
@@ -0,0 +1,39 @@
+// Copyright (c) 2023 .NET Foundation and Contributors. All rights reserved.
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+// See the LICENSE file in the project root for full license information.
+
+using System.Windows.Forms;
+
+namespace ReactiveUI.Winforms;
+
+/// <summary>
+/// This is an  UserControl that is both and UserControl and has a ReactiveObject powers
+/// (i.e. you can call RaiseAndSetIfChanged).
+/// </summary>
+/// <seealso cref="System.Windows.Forms.UserControl" />
+/// <seealso cref="ReactiveUI.IViewFor" />
+public partial class ReactiveUserControlNonGeneric : UserControl, IViewFor
+{
+    /// <summary>
+    /// Initializes a new instance of the <see cref="ReactiveUserControlNonGeneric"/> class.
+    /// </summary>
+    public ReactiveUserControlNonGeneric() => InitializeComponent();
+
+    /// <inheritdoc/>
+    object? IViewFor.ViewModel { get; set; }
+
+    /// <summary>
+    /// Clean up any resources being used.
+    /// </summary>
+    /// <param name="disposing">true if managed resources should be disposed; otherwise, false.</param>
+    protected override void Dispose(bool disposing)
+    {
+        if (disposing)
+        {
+            components?.Dispose();
+        }
+
+        base.Dispose(disposing);
+    }
+}