Improve documents

Author: Jack251970

Flow.Launcher.Plugin/Interfaces/IPublicAPI.cs

@@ -322,17 +322,16 @@ public interface IPublicAPI
         public MessageBoxResult ShowMsgBox(string messageBoxText, string caption = "", MessageBoxButton button = MessageBoxButton.OK, MessageBoxImage icon = MessageBoxImage.None, MessageBoxResult defaultResult = MessageBoxResult.OK);
 
         /// <summary>
-        /// Displays a standardised Flow message box.
-        /// If there is issue when showing the message box, it will return null.
+        /// Displays a standardised Flow progress box.
         /// </summary>
-        /// <param name="caption">The caption of the message box.</param>
+        /// <param name="caption">The caption of the progress box.</param>
         /// <param name="reportProgressAsync">
         /// Time-consuming task function, whose input is the action to report progress.
         /// The input of the action is the progress value which is a double value between 0 and 100.
         /// If there are any exceptions, this action will be null.
         /// </param>
-        /// <param name="forceClosed">When user closes the progress box manually by button or esc key, this action will be called.</param>
-        /// <returns>A progress box interface.</returns>
-        public Task ShowProgressBoxAsync(string caption, Func<Action<double>, Task> reportProgressAsync, Action forceClosed = null);
+        /// <param name="cancelProgress">When user cancel the progress, this action will be called.</param>
+        /// <returns></returns>
+        public Task ShowProgressBoxAsync(string caption, Func<Action<double>, Task> reportProgressAsync, Action cancelProgress = null);
     }
 }

Flow.Launcher/ProgressBoxEx.xaml.cs

@@ -8,15 +8,15 @@ namespace Flow.Launcher
 {
     public partial class ProgressBoxEx : Window
     {
-        private readonly Action _forceClosed;
+        private readonly Action _cancelProgress;
 
-        private ProgressBoxEx(Action forceClosed)
+        private ProgressBoxEx(Action cancelProgress)
         {
-            _forceClosed = forceClosed;
+            _cancelProgress = cancelProgress;
             InitializeComponent();
         }
 
-        public static async Task ShowAsync(string caption, Func<Action<double>, Task> reportProgressAsync, Action forceClosed = null)
+        public static async Task ShowAsync(string caption, Func<Action<double>, Task> reportProgressAsync, Action cancelProgress = null)
         {
             ProgressBoxEx prgBox = null;
             try
@@ -25,7 +25,7 @@ public static async Task ShowAsync(string caption, Func<Action<double>, Task> re
                 {
                     await Application.Current.Dispatcher.InvokeAsync(() =>
                     {
-                        prgBox = new ProgressBoxEx(forceClosed)
+                        prgBox = new ProgressBoxEx(cancelProgress)
                         {
                             Title = caption
                         };
@@ -35,7 +35,7 @@ await Application.Current.Dispatcher.InvokeAsync(() =>
                 }
                 else
                 {
-                    prgBox = new ProgressBoxEx(forceClosed)
+                    prgBox = new ProgressBoxEx(cancelProgress)
                     {
                         Title = caption
                     };
@@ -113,7 +113,7 @@ private void Button_Background(object sender, RoutedEventArgs e)
         private void ForceClose()
         {
             Close();
-            _forceClosed?.Invoke();
+            _cancelProgress?.Invoke();
         }
     }
 }

Flow.Launcher/PublicAPIInstance.cs

@@ -324,7 +324,7 @@ public bool IsGameModeOn()
         public MessageBoxResult ShowMsgBox(string messageBoxText, string caption = "", MessageBoxButton button = MessageBoxButton.OK, MessageBoxImage icon = MessageBoxImage.None, MessageBoxResult defaultResult = MessageBoxResult.OK) =>
             MessageBoxEx.Show(messageBoxText, caption, button, icon, defaultResult);
 
-        public Task ShowProgressBoxAsync(string caption, Func<Action<double>, Task> reportProgressAsync, Action forceClosed = null) => ProgressBoxEx.ShowAsync(caption, reportProgressAsync, forceClosed);
+        public Task ShowProgressBoxAsync(string caption, Func<Action<double>, Task> reportProgressAsync, Action cancelProgress = null) => ProgressBoxEx.ShowAsync(caption, reportProgressAsync, cancelProgress);
 
         #endregion