Merge '~ProgressBarValue' classes

Meld 'BindableProgressBarValue' class into 'AdaptiveProgressBarValue' class The difference between them is subtle and is platform specific. So, melding the changes from one class into the other shouldn't be an issue. Although this is a Breaking Change, it doesn't change any functional behavior. It's refactored to be a drop-in replacement. So, just a global text replace is enough.
CommunityToolkit · Jun 26, 2021 · 092ef04 · 092ef04
1 parent 09eb161
commit 092ef04
Show file tree

Hide file tree

Showing 6 changed files with 38 additions and 100 deletions.
diff --git a/Microsoft.Toolkit.Uwp.Notifications/Adaptive/AdaptiveProgressBar.cs b/Microsoft.Toolkit.Uwp.Notifications/Adaptive/AdaptiveProgressBar.cs
@@ -9,10 +9,8 @@
 
 #if WINRT
 using System.Collections.Generic;
-using BindableProgressBarValue = Microsoft.Toolkit.Uwp.Notifications.AdaptiveProgressBarValue;
 using BindableString = System.String;
 #else
-using BindableProgressBarValue = Microsoft.Toolkit.Uwp.Notifications.BindableProgressBarValue;
 using BindableString = Microsoft.Toolkit.Uwp.Notifications.BindableString;
 #endif
 
@@ -38,7 +36,7 @@ public sealed class AdaptiveProgressBar : IToastBindingGenericChild
         /// <summary>
         /// Gets or sets the value of the progress bar. Supports data binding. Defaults to 0.
         /// </summary>
-        public BindableProgressBarValue Value { get; set; } = AdaptiveProgressBarValue.FromValue(0);
+        public AdaptiveProgressBarValue Value { get; set; } = AdaptiveProgressBarValue.FromValue(0);
 
         /// <summary>
         /// Gets or sets an optional string to be displayed instead of the default percentage string. If this isn't provided, something like "70%" will be displayed.

diff --git a/Microsoft.Toolkit.Uwp.Notifications/Adaptive/AdaptiveProgressBarValue.cs b/Microsoft.Toolkit.Uwp.Notifications/Adaptive/AdaptiveProgressBarValue.cs
@@ -33,6 +33,18 @@ private AdaptiveProgressBarValue()
         {
         }
 
+#if !WINRT
+        /// <summary>
+        /// Initializes a new instance of the <see cref="AdaptiveProgressBarValue"/> class.
+        /// A new binding for a double value, with the required binding value name. Do NOT include surrounding {} brackets.
+        /// </summary>
+        /// <param name="bindingName">The name that maps to your binding data value.</param>
+        public AdaptiveProgressBarValue(string bindingName)
+        {
+            BindingName = bindingName;
+        }
+#endif
+
         internal string ToXmlString()
         {
             if (IsIndeterminate)
@@ -92,5 +104,25 @@ public static AdaptiveProgressBarValue FromBinding(string bindingName)
                 BindingName = bindingName
             };
         }
+
+#if !WINRT
+        /// <summary>
+        /// Creates an <see cref="AdaptiveProgressBarValue"/> that has the raw double value.
+        /// </summary>
+        /// <param name="value">The raw value</param>
+        public static implicit operator AdaptiveProgressBarValue(double value)
+        {
+            return FromValue(value);
+        }
+
+        /// <summary>
+        /// Creates an <see cref="AdaptiveProgressBarValue"/> that has the raw double value.
+        /// </summary>
+        /// <param name="bindingName">The raw value</param>
+        public static implicit operator AdaptiveProgressBarValue(string bindingName)
+        {
+            return FromBinding(bindingName);
+        }
+#endif
     }
 }
diff --git a/Microsoft.Toolkit.Uwp.Notifications/Adaptive/BindableValues/BindableProgressBarValue.cs b/Microsoft.Toolkit.Uwp.Notifications/Adaptive/BindableValues/BindableProgressBarValue.cs
diff --git a/Microsoft.Toolkit.Uwp.Notifications/Toasts/Builder/ToastContentBuilder.Visuals.cs b/Microsoft.Toolkit.Uwp.Notifications/Toasts/Builder/ToastContentBuilder.Visuals.cs
@@ -109,7 +109,7 @@ public static NotificationData CreateProgressBarData(ToastContent toast, int ind
                 data.Values[bindableTitle.BindingName] = title;
             }
 
-            if (progressBar.Value is BindableProgressBarValue bindableProgressValue && value != default)
+            if (progressBar.Value is AdaptiveProgressBarValue bindableProgressValue && value != default)
             {
                 data.Values[bindableProgressValue.BindingName] = value.ToString();
             }
@@ -420,7 +420,7 @@ public ToastContentBuilder AddProgressBar(string title = default, double? value
             }
             else if (value == null)
             {
-                progressBar.Value = new BindableProgressBarValue($"progressValue_{index}");
+                progressBar.Value = new AdaptiveProgressBarValue($"progressValue_{index}");
             }
             else
             {

diff --git a/Microsoft.Toolkit.Win32.WpfCore.SampleApp/MainWindow.xaml.cs b/Microsoft.Toolkit.Win32.WpfCore.SampleApp/MainWindow.xaml.cs
@@ -195,7 +195,7 @@ private async void ButtonProgressToast_Click(object sender, RoutedEventArgs e)
                 .AddText("Sending image to conversation...")
                 .AddVisualChild(new AdaptiveProgressBar()
                 {
-                    Value = new BindableProgressBarValue("progress"),
+                    Value = new AdaptiveProgressBarValue("progress"),
                     Status = "Sending..."
                 })
                 .Show(toast =>

diff --git a/UnitTests/UnitTests.Notifications.Shared/Test_Toast_Xml.cs b/UnitTests/UnitTests.Notifications.Shared/Test_Toast_Xml.cs
@@ -1928,7 +1928,7 @@ public void Test_Toast_ProgressBar_Value()
                     { AdaptiveProgressBarBindableProperty.Value, "progressValue" }
                 },
 #else
-                Value = new BindableProgressBarValue("progressValue"),
+                Value = new AdaptiveProgressBarValue("progressValue"),
 #endif
                 Status = "Downloading..."
             });
@@ -2003,7 +2003,7 @@ public void Test_Toast_ProgressBar()
                     { AdaptiveProgressBarBindableProperty.Status, "progressStatus" }
                 }
 #else
-                Value = new BindableProgressBarValue("progressValue"),
+                Value = new AdaptiveProgressBarValue("progressValue"),
                 Title = new BindableString("progressTitle"),
                 ValueStringOverride = new BindableString("progressValueOverride"),
                 Status = new BindableString("progressStatus")