diff options
Diffstat (limited to 'win/CS/HandBrakeWPF/Services/Interfaces/IErrorService.cs')
| -rw-r--r-- | win/CS/HandBrakeWPF/Services/Interfaces/IErrorService.cs | 59 |
1 files changed, 47 insertions, 12 deletions
diff --git a/win/CS/HandBrakeWPF/Services/Interfaces/IErrorService.cs b/win/CS/HandBrakeWPF/Services/Interfaces/IErrorService.cs index cba3a79b3..cc9ef968c 100644 --- a/win/CS/HandBrakeWPF/Services/Interfaces/IErrorService.cs +++ b/win/CS/HandBrakeWPF/Services/Interfaces/IErrorService.cs @@ -7,28 +7,63 @@ // </summary>
// --------------------------------------------------------------------------------------------------------------------
-using System.Windows;
-
namespace HandBrakeWPF.Services.Interfaces
{
+ using System;
+ using System.Windows;
+
+ /// <summary>
+ /// The Interface to the Error Service.
+ /// </summary>
public interface IErrorService
{
/// <summary>
- /// Show an Error Window with debug output.
+ /// Show an Exception Error Window
/// </summary>
- /// <param name="message"></param>
- /// <param name="solution"></param>
- /// <param name="details"></param>
+ /// <param name="message">
+ /// The message.
+ /// </param>
+ /// <param name="solution">
+ /// The solution.
+ /// </param>
+ /// <param name="details">
+ /// The details.
+ /// </param>
void ShowError(string message, string solution, string details);
/// <summary>
- /// Show a Message Box
+ /// Show an Exception Error Window
+ /// </summary>
+ /// <param name="message">
+ /// The message.
+ /// </param>
+ /// <param name="solution">
+ /// The solution.
+ /// </param>
+ /// <param name="exception">
+ /// The exception.
+ /// </param>
+ void ShowError(string message, string solution, Exception exception);
+
+ /// <summary>
+ /// Show a Message Box.
+ /// It is good practice to use this, so that if we ever introduce unit testing, the message boxes won't cause issues.
/// </summary>
- /// <param name="message"></param>
- /// <param name="header"></param>
- /// <param name="image"></param>
- /// <param name="buttons"></param>
- /// <returns></returns>
+ /// <param name="message">
+ /// The message.
+ /// </param>
+ /// <param name="header">
+ /// The header.
+ /// </param>
+ /// <param name="buttons">
+ /// The buttons.
+ /// </param>
+ /// <param name="image">
+ /// The image.
+ /// </param>
+ /// <returns>
+ /// The MessageBoxResult Object
+ /// </returns>
MessageBoxResult ShowMessageBox(string message, string header, MessageBoxButton buttons, MessageBoxImage image);
}
}
\ No newline at end of file |