Toast: add dismiss signal with dismissal reason (#677)

* Toast: always send close and add close reason

* Add new signal, deprecate old signal

* Update granite.metainfo.xml.in

---------

Co-authored-by: Jeremy Wootten <jeremywootten@gmail.com>
Co-authored-by: Ryan Kornheisl <ryan@skarva.tech>

data/granite.metainfo.xml.in

@@ -27,6 +27,10 @@
   <releases>
     <release version="7.5.0" date="2023-04-29" urgency="medium">
       <description>
+        <p>New Features:</p>
+        <ul>
+          <li>Toast: add a new dismissed signal that includes the reason for dismissal</li>
+        </ul>
         <p>Improvements:</p>
         <ul>
           <li>Make building Demo optional</li>

lib/Widgets/Toast.vala

@@ -16,12 +16,28 @@
  * {{../doc/images/Toast.png}}
  */
 public class Granite.Toast : Gtk.Widget {
+    /**
+     * Reason why a Toast was dismissed
+     * @since 7.5.0
+     */
+    [Version (since = "7.5.0")]
+    public enum DismissReason {
+        EXPIRED = 1,
+        CLOSED = 2,
+        WITHDRAWN = 3
+    }
 
     /**
      * Emitted when the Toast is closed by activating the close button
      */
+    [Version (deprecated = true, deprecated_since = "7.5.0", replacement = "dismissed")]
     public signal void closed ();
 
+    /**
+     * Emitted when the Toast has been dismissed
+     */
+    public signal void dismissed (DismissReason reason);
+
     /**
      * Emitted when the default action button is activated
      */
@@ -101,6 +117,7 @@ public class Granite.Toast : Gtk.Widget {
             revealer.reveal_child = false;
             stop_timeout ();
             closed ();
+            dismissed (DismissReason.CLOSED);
         });
 
         default_action_button.clicked.connect (() => {
@@ -133,6 +150,7 @@ public class Granite.Toast : Gtk.Widget {
 
         timeout_id = GLib.Timeout.add (duration, () => {
             revealer.reveal_child = false;
+            dismissed (DismissReason.EXPIRED);
             timeout_id = 0;
             return GLib.Source.REMOVE;
         });
@@ -180,5 +198,6 @@ public class Granite.Toast : Gtk.Widget {
     public void withdraw () {
         stop_timeout ();
         revealer.reveal_child = false;
+        dismissed (DismissReason.WITHDRAWN);
     }
 }