[libadwaita] view-switcher: Support unread badges

[Adrien Plazas <aplazas src gnome org>]

commit 9885abdd3d7790355e4d6b1f0fcdc9370f1b2746
Author: CodedOre <CodedOre>
Date:   Mon Jun 28 17:36:08 2021 +0500

    view-switcher: Support unread badges

 src/adw-view-switcher-button-private.h |  4 ++
 src/adw-view-switcher-button.c         | 81 +++++++++++++++++++++++++++++++++-
 src/adw-view-switcher-button.ui        | 10 +++++
 src/adw-view-switcher.c                |  3 ++
 4 files changed, 97 insertions(+), 1 deletion(-)
---
diff --git a/src/adw-view-switcher-button-private.h b/src/adw-view-switcher-button-private.h
index 3ff1041f..8b008a38 100644
--- a/src/adw-view-switcher-button-private.h
+++ b/src/adw-view-switcher-button-private.h
@@ -33,6 +33,10 @@ gboolean adw_view_switcher_button_get_needs_attention (AdwViewSwitcherButton *se
 void     adw_view_switcher_button_set_needs_attention (AdwViewSwitcherButton *self,
                                                        gboolean               needs_attention);
 
+guint adw_view_switcher_button_get_badge_number (AdwViewSwitcherButton *self);
+void  adw_view_switcher_button_set_badge_number (AdwViewSwitcherButton *self,
+                                                 guint                  badge_number);
+
 const char *adw_view_switcher_button_get_label (AdwViewSwitcherButton *self);
 void        adw_view_switcher_button_set_label (AdwViewSwitcherButton *self,
                                                 const char            *label);
diff --git a/src/adw-view-switcher-button.c b/src/adw-view-switcher-button.c
index 270ac442..3be0bbe8 100644
--- a/src/adw-view-switcher-button.c
+++ b/src/adw-view-switcher-button.c
@@ -16,12 +16,13 @@ enum {
   PROP_0,
   PROP_ICON_NAME,
   PROP_NEEDS_ATTENTION,
+  PROP_BADGE_NUMBER,
 
   /* Overridden properties */
   PROP_LABEL,
   PROP_ORIENTATION,
 
-  LAST_PROP = PROP_NEEDS_ATTENTION + 1,
+  LAST_PROP = PROP_BADGE_NUMBER + 1,
 };
 
 struct _AdwViewSwitcherButton
@@ -44,6 +45,7 @@ struct _AdwViewSwitcherButton
   char *label;
   GtkOrientation orientation;
   gboolean needs_attention;
+  guint badge_number;
 
   guint switch_timer;
 };
@@ -128,6 +130,19 @@ should_show_indicator (AdwViewSwitcherButton *self,
   return needs_attention && !active;
 }
 
+static gchar *
+get_badge_text (AdwViewSwitcherButton *self,
+                guint                  badge_number)
+{
+  if (badge_number > 999)
+    return g_strdup ("999+");
+
+  if (!badge_number)
+    return g_strdup ("");
+
+  return g_strdup_printf ("%u", badge_number);
+}
+
 static void
 adw_view_switcher_button_get_property (GObject    *object,
                                        guint       prop_id,
@@ -143,6 +158,9 @@ adw_view_switcher_button_get_property (GObject    *object,
   case PROP_NEEDS_ATTENTION:
     g_value_set_boolean (value, adw_view_switcher_button_get_needs_attention (self));
     break;
+  case PROP_BADGE_NUMBER:
+    g_value_set_uint (value, adw_view_switcher_button_get_badge_number (self));
+    break;
   case PROP_LABEL:
     g_value_set_string (value, adw_view_switcher_button_get_label (self));
     break;
@@ -170,6 +188,9 @@ adw_view_switcher_button_set_property (GObject      *object,
   case PROP_NEEDS_ATTENTION:
     adw_view_switcher_button_set_needs_attention (self, g_value_get_boolean (value));
     break;
+  case PROP_BADGE_NUMBER:
+    adw_view_switcher_button_set_badge_number (self, g_value_get_uint (value));
+    break;
   case PROP_LABEL:
     adw_view_switcher_button_set_label (self, g_value_get_string (value));
     break;
@@ -254,6 +275,22 @@ adw_view_switcher_button_class_init (AdwViewSwitcherButtonClass *klass)
                         FALSE,
                         G_PARAM_EXPLICIT_NOTIFY | G_PARAM_READWRITE);
 
+  /**
+   * AdwViewSwitcherButton:badge-number:
+   *
+   * A number to display as a badge on the button.
+   *
+   * Since: 1.0
+   */
+  props[PROP_BADGE_NUMBER] =
+    g_param_spec_uint ("badge-number",
+                       "Badge number",
+                       "A number to display as a badge on the button",
+                       0,
+                       G_MAXUINT,
+                       0,
+                       G_PARAM_READWRITE | G_PARAM_EXPLICIT_NOTIFY);
+
   g_object_class_install_properties (object_class, LAST_PROP, props);
 
   /* We probably should set the class's CSS name to "viewswitcherbutton"
@@ -280,6 +317,7 @@ adw_view_switcher_button_class_init (AdwViewSwitcherButtonClass *klass)
   gtk_widget_class_bind_template_callback (widget_class, drag_enter_cb);
   gtk_widget_class_bind_template_callback (widget_class, drag_leave_cb);
   gtk_widget_class_bind_template_callback (widget_class, should_show_indicator);
+  gtk_widget_class_bind_template_callback (widget_class, get_badge_text);
 
   gtk_widget_class_set_accessible_role (widget_class, GTK_ACCESSIBLE_ROLE_TAB);
 }
@@ -409,6 +447,47 @@ adw_view_switcher_button_set_needs_attention (AdwViewSwitcherButton *self,
   g_object_notify_by_pspec (G_OBJECT (self), props[PROP_NEEDS_ATTENTION]);
 }
 
+/**
+ * adw_view_switcher_button_get_badge_number:
+ * @self: a `AdwViewSwitcherButton`
+ *
+ * Gets the badge number.
+ *
+ * Returns: the badge number
+ *
+ * Since: 1.0
+ */
+guint
+adw_view_switcher_button_get_badge_number (AdwViewSwitcherButton *self)
+{
+  g_return_val_if_fail (ADW_IS_VIEW_SWITCHER_BUTTON (self), 0);
+
+  return self->badge_number;
+}
+
+/**
+ * adw_view_switcher_button_set_badge_number:
+ * @self: a `AdwViewSwitcherButton`
+ * @badge_number: the new value
+ *
+ * Sets the badge number.
+ *
+ * Since: 1.0
+ */
+void
+adw_view_switcher_button_set_badge_number (AdwViewSwitcherButton *self,
+                                           guint                  badge_number)
+{
+  g_return_if_fail (ADW_IS_VIEW_SWITCHER_BUTTON (self));
+
+  if (self->badge_number == badge_number)
+    return;
+
+  self->badge_number = badge_number;
+
+  g_object_notify_by_pspec (G_OBJECT (self), props[PROP_BADGE_NUMBER]);
+}
+
 /**
  * adw_view_switcher_button_get_label:
  * @self: a `AdwViewSwitcherButton`
diff --git a/src/adw-view-switcher-button.ui b/src/adw-view-switcher-button.ui
index 928c6500..4e783b44 100644
--- a/src/adw-view-switcher-button.ui
+++ b/src/adw-view-switcher-button.ui
@@ -23,6 +23,11 @@
             <child>
               <object class="AdwIndicatorBin">
                 <property name="valign">center</property>
+                <binding name="badge">
+                  <closure type="gchararray" function="get_badge_text">
+                    <lookup name="badge-number">AdwViewSwitcherButton</lookup>
+                  </closure>
+                </binding>
                 <binding name="needs-attention">
                   <closure type="gboolean" function="should_show_indicator">
                     <lookup name="needs-attention">AdwViewSwitcherButton</lookup>
@@ -70,6 +75,11 @@
               <object class="AdwIndicatorBin">
                 <property name="halign">center</property>
                 <property name="valign">center</property>
+                <binding name="badge">
+                  <closure type="gchararray" function="get_badge_text">
+                    <lookup name="badge-number">AdwViewSwitcherButton</lookup>
+                  </closure>
+                </binding>
                 <binding name="needs-attention">
                   <closure type="gboolean" function="should_show_indicator">
                     <lookup name="needs-attention">AdwViewSwitcherButton</lookup>
diff --git a/src/adw-view-switcher.c b/src/adw-view-switcher.c
index eeebea4b..97b5d2fa 100644
--- a/src/adw-view-switcher.c
+++ b/src/adw-view-switcher.c
@@ -103,6 +103,7 @@ update_button (AdwViewSwitcher  *self,
   g_autofree char *title = NULL;
   g_autofree char *icon_name = NULL;
   gboolean needs_attention;
+  guint badge_number;
   gboolean visible;
   gboolean use_underline;
 
@@ -111,6 +112,7 @@ update_button (AdwViewSwitcher  *self,
                 "icon-name", &icon_name,
                 "needs-attention", &needs_attention,
                 "visible", &visible,
+                "badge-number", &badge_number,
                 "use-underline", &use_underline,
                 NULL);
 
@@ -118,6 +120,7 @@ update_button (AdwViewSwitcher  *self,
                 "icon-name", icon_name,
                 "label", title,
                 "needs-attention", needs_attention,
+                "badge-number", badge_number,
                 "use-underline", use_underline,
                 NULL);