Merge branch 'snackbar'

Author: ButchersBoy

MaterialDesignThemes.Wpf/ISnackbarMessageQueue.cs

@@ -4,12 +4,58 @@ namespace MaterialDesignThemes.Wpf
 {
     public interface ISnackbarMessageQueue
     {
+        /// <summary>
+        /// Queues a notificaton message for display in a snackbar.
+        /// </summary>
+        /// <param name="content">Message.</param>
         void Enqueue(object content);
 
+        /// <summary>
+        /// Queues a notificaton message for display in a snackbar.
+        /// </summary>
+        /// <param name="content">Message.</param>
+        /// <param name="actionContent">Content for the action button.</param>
+        /// <param name="actionHandler">Call back to be executed if user clicks the action button.</param>
         void Enqueue(object content, object actionContent, Action actionHandler);
 
+        /// <summary>
+        /// Queues a notificaton message for display in a snackbar.
+        /// </summary>
+        /// <param name="content">Message.</param>
+        /// <param name="actionContent">Content for the action button.</param>
+        /// <param name="actionHandler">Call back to be executed if user clicks the action button.</param>
+        /// <param name="actionArgument">Argument to pass to <paramref name="actionHandler"/>.</param>
         void Enqueue<TArgument>(object content, object actionContent, Action<TArgument> actionHandler, TArgument actionArgument);
 
+        /// <summary>
+        /// Queues a notificaton message for display in a snackbar.
+        /// </summary>
+        /// <param name="content">Message.</param>
+        /// <param name="neverConsiderToBeDuplicate">Subsequent, duplicate messages queued within a short time span will 
+        /// be discarded. To override this behaviour and ensure the message always gets displayed set to <c>true</c>.</param>
+        void Enqueue(object content, bool neverConsiderToBeDuplicate);
+
+        /// <summary>
+        /// Queues a notificaton message for display in a snackbar.
+        /// </summary>
+        /// <param name="content">Message.</param>
+        /// <param name="actionContent">Content for the action button.</param>
+        /// <param name="actionHandler">Call back to be executed if user clicks the action button.</param>
+        /// <param name="neverConsiderToBeDuplicate">Subsequent, duplicate messages queued within a short time span will 
+        /// be discarded. To override this behaviour and ensure the message always gets displayed set to <c>true</c>.</param>
+        void Enqueue(object content, object actionContent, Action actionHandler, bool neverConsiderToBeDuplicate);
+
+        /// <summary>
+        /// Queues a notificaton message for display in a snackbar.
+        /// </summary>
+        /// <param name="content">Message.</param>
+        /// <param name="actionContent">Content for the action button.</param>
+        /// <param name="actionHandler">Call back to be executed if user clicks the action button.</param>
+        /// <param name="actionArgument">Argument to pass to <paramref name="actionHandler"/>.</param>
+        /// <param name="neverConsiderToBeDuplicate">Subsequent, duplicate messages queued within a short time span will 
+        /// be discarded. To override this behaviour and ensure the message always gets displayed set to <c>true</c>.</param>        
+        void Enqueue<TArgument>(object content, object actionContent, Action<TArgument> actionHandler, TArgument actionArgument, bool neverConsiderToBeDuplicate);
+
         //TODO consider additional variants of Enqueue:
         // ShowAsync(. . .)
     }

MaterialDesignThemes.Wpf/SnackbarMessageQueue.cs

@@ -185,6 +185,11 @@ internal Action Pause()
         }
 
         public void Enqueue(object content)
+        {
+            Enqueue(content, false);
+        }
+
+        public void Enqueue(object content, bool neverConsiderToBeDuplicate)
         {
             if (content == null) throw new ArgumentNullException(nameof(content));
 
@@ -193,6 +198,11 @@ public void Enqueue(object content)
         }
 
         public void Enqueue(object content, object actionContent, Action actionHandler)
+        {
+            Enqueue(content, actionContent, actionHandler, false);
+        }
+
+        public void Enqueue(object content, object actionContent, Action actionHandler, bool neverConsiderToBeDuplicate)
         {
             if (content == null) throw new ArgumentNullException(nameof(content));
 
@@ -202,6 +212,12 @@ public void Enqueue(object content, object actionContent, Action actionHandler)
 
         public void Enqueue<TArgument>(object content, object actionContent, Action<TArgument> actionHandler,
             TArgument actionArgument)
+        {
+            Enqueue<TArgument>(content, actionContent, actionHandler, actionArgument, false);
+        }
+
+        public void Enqueue<TArgument>(object content, object actionContent, Action<TArgument> actionHandler,
+            TArgument actionArgument, bool neverConsiderToBeDuplicate)
         {
             if (content == null) throw new ArgumentNullException(nameof(content));
 
@@ -249,9 +265,11 @@ private async void PumpAsync()
                 if (snackbar != null)
                 {
                     var message = _snackbarMessages.Dequeue();
-                    if (_latestShownItem == null || !Equals(_latestShownItem.Item1.Content, message.Content) ||
-                        !Equals(_latestShownItem.Item1.ActionContent, message.ActionContent) ||
-                        _latestShownItem.Item2 <= DateTime.Now.Subtract(_messageDuration))
+                    if (_latestShownItem == null 
+                        || message.NeverConsiderToBeDuplicate
+                        || !Equals(_latestShownItem.Item1.Content, message.Content) 
+                        || !Equals(_latestShownItem.Item1.ActionContent, message.ActionContent) 
+                        || _latestShownItem.Item2 <= DateTime.Now.Subtract(_messageDuration))
                     {
                         await ShowAsync(snackbar, message);
                         _latestShownItem = new Tuple<SnackbarMessageQueueItem, DateTime>(message, DateTime.Now);

MaterialDesignThemes.Wpf/SnackbarMessageQueueItem.cs

@@ -4,13 +4,14 @@ namespace MaterialDesignThemes.Wpf
 {
     internal class SnackbarMessageQueueItem
     {
-        public SnackbarMessageQueueItem(object content, object actionContent = null, object actionHandler = null, object actionArgument = null, Type argumentType = null)
+        public SnackbarMessageQueueItem(object content, object actionContent = null, object actionHandler = null, object actionArgument = null, Type argumentType = null, bool neverConsiderToBeDuplicate = false)
         {
             Content = content;
             ActionContent = actionContent;
             ActionHandler = actionHandler;
             ActionArgument = actionArgument;
             ArgumentType = argumentType;
+            NeverConsiderToBeDuplicate = neverConsiderToBeDuplicate;
         }
 
         public object Content { get; }
@@ -22,5 +23,7 @@ public SnackbarMessageQueueItem(object content, object actionContent = null, obj
         public object ActionArgument { get; }
 
         public Type ArgumentType { get; }
+
+        public bool NeverConsiderToBeDuplicate { get; }
     }
 }