add a menuitem that renders com.canonical.indicator.progress as laid out in https://wiki.ubuntu.com/Power#Phone

4 files changed, 475 insertions, 0 deletions

diff --git a/src/Makefile.am b/src/Makefile.am
index 2791964..a4ca6fd 100644
--- a/src/Makefile.am
+++ b/src/Makefile.am
@@ -19,6 +19,7 @@ sources_h =				\
 	idoswitchmenuitem.h		\
 	idousermenuitem.h		\
 	idoappointmentmenuitem.h	\
+	idobasicmenuitem.h		\
 	idolocationmenuitem.h		\
 	idotimeline.h			\
 	libido.h			\
@@ -80,6 +81,7 @@ libido_0_1_la_SOURCES =			\
 	idomediaplayermenuitem.c	\
 	idoplaybackmenuitem.c		\
 	idoappointmentmenuitem.c	\
+	idobasicmenuitem.c		\
 	idolocationmenuitem.c
 
 libido3_0_1_la_SOURCES = $(libido_0_1_la_SOURCES)
diff --git a/src/idobasicmenuitem.c b/src/idobasicmenuitem.c
new file mode 100644
index 0000000..59e949c
--- /dev/null
+++ b/src/idobasicmenuitem.c
@@ -0,0 +1,392 @@
+/*
+ * Copyright 2013 Canonical Ltd.
+ *
+ * Authors:
+ *   Charles Kerr <charles.kerr@canonical.com>
+ *
+ * This program is free software: you can redistribute it and/or modify it 
+ * under the terms of the GNU General Public License version 3, as published 
+ * by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful, but 
+ * WITHOUT ANY WARRANTY; without even the implied warranties of 
+ * MERCHANTABILITY, SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR 
+ * PURPOSE.  See the GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along 
+ * with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#ifdef HAVE_CONFIG_H
+ #include "config.h"
+#endif
+
+#include <string.h> /* strstr() */
+
+#include <gtk/gtk.h>
+
+#include "idoactionhelper.h"
+#include "idobasicmenuitem.h"
+
+enum
+{
+  PROP_0,
+  PROP_ICON,
+  PROP_TEXT,
+  PROP_SECONDARY_TEXT,
+  PROP_LAST
+};
+
+static GParamSpec *properties[PROP_LAST];
+
+struct _IdoBasicMenuItemPrivate
+{
+  GIcon * icon;
+  char * text;
+  char * secondary_text;
+
+  GtkWidget * image;
+  GtkWidget * label;
+  GtkWidget * secondary_label;
+};
+
+typedef IdoBasicMenuItemPrivate priv_t;
+
+G_DEFINE_TYPE (IdoBasicMenuItem, ido_basic_menu_item, GTK_TYPE_MENU_ITEM);
+
+/***
+****  GObject Virtual Functions
+***/
+
+static void
+my_get_property (GObject     * o,
+                 guint         property_id,
+                 GValue      * value,
+                 GParamSpec  * pspec)
+{
+  IdoBasicMenuItem * self = IDO_BASIC_MENU_ITEM (o);
+  priv_t * p = self->priv;
+
+  switch (property_id)
+    {
+      case PROP_ICON:
+        g_value_set_object (value, p->icon);
+        break;
+
+      case PROP_TEXT:
+        g_value_set_string (value, p->text);
+        break;
+
+      case PROP_SECONDARY_TEXT:
+        g_value_set_string (value, p->secondary_text);
+        break;
+
+      default:
+        G_OBJECT_WARN_INVALID_PROPERTY_ID (o, property_id, pspec);
+        break;
+    }
+}
+
+static void
+my_set_property (GObject       * o,
+                 guint           property_id,
+                 const GValue  * value,
+                 GParamSpec    * pspec)
+{
+  IdoBasicMenuItem * self = IDO_BASIC_MENU_ITEM (o);
+
+  switch (property_id)
+    {
+      case PROP_ICON:
+        ido_basic_menu_item_set_icon (self, g_value_get_object (value));
+        break;
+
+      case PROP_TEXT:
+        ido_basic_menu_item_set_text (self, g_value_get_string (value));
+        break;
+
+      case PROP_SECONDARY_TEXT:
+        ido_basic_menu_item_set_secondary_text (self, g_value_get_string (value));
+        break;
+
+      default:
+        G_OBJECT_WARN_INVALID_PROPERTY_ID (o, property_id, pspec);
+        break;
+    }
+}
+
+static void
+my_dispose (GObject * object)
+{
+  IdoBasicMenuItem * self = IDO_BASIC_MENU_ITEM (object);
+  priv_t * p = self->priv;
+
+  g_clear_object (&p->icon);
+
+  G_OBJECT_CLASS (ido_basic_menu_item_parent_class)->dispose (object);
+}
+
+static void
+my_finalize (GObject * object)
+{
+  IdoBasicMenuItem * self = IDO_BASIC_MENU_ITEM (object);
+  priv_t * p = self->priv;
+
+  g_free (p->text);
+  g_free (p->secondary_text);
+
+  G_OBJECT_CLASS (ido_basic_menu_item_parent_class)->finalize (object);
+}
+
+/***
+****  Instantiation
+***/
+
+static void
+ido_basic_menu_item_class_init (IdoBasicMenuItemClass *klass)
+{
+  GParamFlags prop_flags;
+  GObjectClass * gobject_class = G_OBJECT_CLASS (klass);
+
+  g_type_class_add_private (klass, sizeof (IdoBasicMenuItemPrivate));
+
+  gobject_class->get_property = my_get_property;
+  gobject_class->set_property = my_set_property;
+  gobject_class->dispose = my_dispose;
+  gobject_class->finalize = my_finalize;
+
+  prop_flags = G_PARAM_CONSTRUCT
+             | G_PARAM_READWRITE
+             | G_PARAM_STATIC_STRINGS;
+
+  properties[PROP_ICON] = g_param_spec_object ("icon",
+                                               "Icon",
+                                               "The menuitem's GIcon",
+                                               G_TYPE_OBJECT,
+                                               prop_flags);
+
+  properties[PROP_TEXT] = g_param_spec_string ("text",
+                                               "Text",
+                                               "The menuitem's text",
+                                               "",
+                                               prop_flags);
+
+  properties[PROP_SECONDARY_TEXT] = g_param_spec_string ("secondary-text",
+                                                         "Secondary Text",
+                                                         "The menuitem's secondary text",
+                                                         "",
+                                                         prop_flags);
+
+  g_object_class_install_properties (gobject_class, PROP_LAST, properties);
+}
+
+static void
+ido_basic_menu_item_init (IdoBasicMenuItem *self)
+{
+  priv_t * p;
+  GtkWidget * w;
+  GtkGrid * grid;
+
+  self->priv = G_TYPE_INSTANCE_GET_PRIVATE (self,
+                                            IDO_BASIC_MENU_ITEM_TYPE,
+                                            IdoBasicMenuItemPrivate);
+
+  p = self->priv;
+
+  p->image = gtk_image_new ();
+  gtk_misc_set_alignment(GTK_MISC(p->image), 0.0, 0.0);
+  p->label = gtk_label_new ("");
+  gtk_misc_set_alignment (GTK_MISC(p->label), 0.0, 0.5);
+  p->secondary_label = gtk_label_new ("");
+  gtk_misc_set_alignment (GTK_MISC(p->secondary_label), 1.0, 0.5);
+
+  w = gtk_grid_new ();
+  grid = GTK_GRID (w);
+  gtk_grid_attach (grid, p->image, 0, 0, 1, 1);
+  gtk_grid_attach (grid, p->label, 1, 0, 1, 1);
+  gtk_grid_attach (grid, p->secondary_label, 2, 0, 1, 1);
+  g_object_set (p->label,
+                "halign", GTK_ALIGN_START,
+                "hexpand", TRUE,
+                "margin-right", 6,
+                "valign", GTK_ALIGN_CENTER,
+                NULL);
+  g_object_set (p->secondary_label,
+                "halign", GTK_ALIGN_END,
+                "hexpand", FALSE,
+                "valign", GTK_ALIGN_CENTER,
+                NULL);
+
+  gtk_widget_show (w);
+  gtk_container_add (GTK_CONTAINER (self), w);
+}
+
+
+/***
+****  Public API
+***/
+
+/* create a new IdoBasicMenuItem */
+GtkWidget *
+ido_basic_menu_item_new (void)
+{
+  return GTK_WIDGET (g_object_new (IDO_BASIC_MENU_ITEM_TYPE, NULL));
+}
+
+void
+ido_basic_menu_item_set_icon (IdoBasicMenuItem * self, GIcon * icon)
+{
+  IdoBasicMenuItemPrivate * p = self->priv;
+
+  if (p->icon != icon)
+    {
+      g_clear_object (&p->icon);
+
+      if (icon == NULL)
+        {
+          gtk_image_clear (GTK_IMAGE(p->image));
+          gtk_widget_set_visible (p->image, FALSE);
+        }
+      else
+        {
+          p->icon = g_object_ref (icon);
+          gtk_image_set_from_gicon (GTK_IMAGE(p->image), p->icon, GTK_ICON_SIZE_MENU);
+          gtk_widget_set_visible (p->image, TRUE);
+        }
+    }
+}
+
+void
+ido_basic_menu_item_set_icon_from_file (IdoBasicMenuItem * self, const char * filename)
+{
+  GFile * file = filename ? g_file_new_for_path (filename) : NULL;
+  GIcon * icon = file ? g_file_icon_new (file) : NULL;
+
+  ido_basic_menu_item_set_icon (self, icon);
+
+  g_clear_object (&icon);
+  g_clear_object (&file);
+}
+
+void
+ido_basic_menu_item_set_text (IdoBasicMenuItem * self, const char * text)
+{
+  IdoBasicMenuItemPrivate * p = self->priv;
+
+  if (g_strcmp0 (p->text, text))
+    {
+      g_free (p->text);
+      p->text = g_strdup (text);
+
+      g_object_set (G_OBJECT(p->label),
+                    "label", p->text,
+                    "visible", (gboolean)(p->text && *p->text),
+                    NULL);
+    }
+}
+
+void
+ido_basic_menu_item_set_secondary_text (IdoBasicMenuItem * self, const char * secondary_text)
+{
+  IdoBasicMenuItemPrivate * p = self->priv;
+
+  if (g_strcmp0 (p->secondary_text, secondary_text))
+    {
+      g_free (p->secondary_text);
+      p->secondary_text = g_strdup (secondary_text);
+
+      g_object_set (G_OBJECT(p->secondary_label),
+                    "label", p->secondary_text,
+                    "visible", (gboolean)(p->secondary_text && *p->secondary_text),
+                    NULL);
+    }
+}
+
+/***
+****
+****
+****
+***/
+
+static void
+on_progress_action_state_changed (IdoActionHelper * helper,
+                                  GVariant        * state,
+                                  gpointer          unused G_GNUC_UNUSED)
+{
+  IdoBasicMenuItem * ido_menu_item;
+  char * str;
+
+  ido_menu_item = IDO_BASIC_MENU_ITEM (ido_action_helper_get_widget (helper));
+
+  g_return_if_fail (ido_menu_item != NULL);
+  g_return_if_fail (g_variant_is_of_type (state, G_VARIANT_TYPE_UINT32));
+
+  str = g_strdup_printf ("%"G_GUINT32_FORMAT"%%", g_variant_get_uint32 (state));
+  ido_basic_menu_item_set_secondary_text (ido_menu_item, str);
+  g_free (str);
+}
+
+/**
+ * ido_progress_menu_item_new_from_model:
+ * @menu_item: the corresponding menuitem
+ * @actions: action group to tell when this GtkMenuItem is activated
+ *
+ * Creates a new progress menuitem with properties initialized from
+ * the menuitem's attributes.
+ *
+ * If the menuitem's 'action' attribute is set, trigger that action
+ * in @actions when this IdoBasicMenuItem is activated.
+ */
+GtkMenuItem *
+ido_progress_menu_item_new_from_model (GMenuItem    * menu_item,
+                                       GActionGroup * actions)
+{
+  guint i;
+  guint n;
+  gchar * str;
+  IdoBasicMenuItem * ido_menu_item;
+  GParameter parameters[4];
+
+  /* create the ido menuitem */;
+
+  n = 0;
+
+  if (g_menu_item_get_attribute (menu_item, "label", "s", &str))
+    {
+      GParameter p = { "text", G_VALUE_INIT };
+      g_value_init (&p.value, G_TYPE_STRING);
+      g_value_take_string (&p.value, str);
+      parameters[n++] = p;
+    }
+
+  g_assert (n <= G_N_ELEMENTS (parameters));
+  ido_menu_item = g_object_newv (IDO_BASIC_MENU_ITEM_TYPE, n, parameters);
+
+  for (i=0; i<n; i++)
+    g_value_unset (&parameters[i].value);
+
+  /* as per the spec, draw the progress widget greyed out */
+
+  gtk_widget_set_sensitive (ido_menu_item->priv->label, FALSE);
+  gtk_widget_set_sensitive (ido_menu_item->priv->secondary_label, FALSE);
+
+  /* give it an ActionHelper */
+
+  if (g_menu_item_get_attribute (menu_item, "action", "s", &str))
+    {
+      IdoActionHelper * helper;
+
+      helper = ido_action_helper_new (GTK_WIDGET(ido_menu_item),
+                                      actions,
+                                      str,
+                                      NULL);
+      g_signal_connect (helper, "action-state-changed",
+                        G_CALLBACK (on_progress_action_state_changed), NULL);
+      g_signal_connect_swapped (ido_menu_item, "destroy",
+                                G_CALLBACK (g_object_unref), helper);
+
+      g_free (str);
+    }
+
+  return GTK_MENU_ITEM (ido_menu_item);
+}
diff --git a/src/idobasicmenuitem.h b/src/idobasicmenuitem.h
new file mode 100644
index 0000000..0da9086
--- /dev/null
+++ b/src/idobasicmenuitem.h
@@ -0,0 +1,77 @@
+/**
+ * Copyright 2013 Canonical Ltd.
+ *
+ * Authors:
+ *   Charles Kerr <charles.kerr@canonical.com>
+ *
+ * This program is free software: you can redistribute it and/or modify it 
+ * under the terms of the GNU General Public License version 3, as published 
+ * by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful, but 
+ * WITHOUT ANY WARRANTY; without even the implied warranties of 
+ * MERCHANTABILITY, SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR 
+ * PURPOSE.  See the GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along 
+ * with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#ifndef __IDO_BASIC_MENU_ITEM_H__
+#define __IDO_BASIC_MENU_ITEM_H__
+
+#include <gtk/gtk.h>
+
+G_BEGIN_DECLS
+
+#define IDO_BASIC_MENU_ITEM_TYPE    (ido_basic_menu_item_get_type ())
+#define IDO_BASIC_MENU_ITEM(obj)    (G_TYPE_CHECK_INSTANCE_CAST ((obj), IDO_BASIC_MENU_ITEM_TYPE, IdoBasicMenuItem))
+#define IDO_IS_BASIC_MENU_ITEM(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), IDO_BASIC_MENU_ITEM_TYPE))
+
+typedef struct _IdoBasicMenuItem        IdoBasicMenuItem;
+typedef struct _IdoBasicMenuItemClass   IdoBasicMenuItemClass;
+typedef struct _IdoBasicMenuItemPrivate IdoBasicMenuItemPrivate;
+
+struct _IdoBasicMenuItemClass
+{
+  GtkMenuItemClass parent_class;
+};
+
+/**
+ * A simple menuitem that includes a right-justified secondary text.
+ */
+struct _IdoBasicMenuItem
+{
+  /*< private >*/
+  GtkMenuItem parent;
+  IdoBasicMenuItemPrivate * priv;
+};
+
+
+GType ido_basic_menu_item_get_type               (void) G_GNUC_CONST;
+
+GtkWidget * ido_basic_menu_item_new              (void);
+
+void ido_basic_menu_item_set_icon                (IdoBasicMenuItem * self,
+                                                  GIcon            * icon);
+
+void ido_basic_menu_item_set_icon_from_file      (IdoBasicMenuItem * self,
+                                                  const char       * filename);
+
+void ido_basic_menu_item_set_text                (IdoBasicMenuItem * self,
+                                                  const char       * text);
+
+void ido_basic_menu_item_set_secondary_text      (IdoBasicMenuItem * self,
+                                                  const char       * text);
+
+/**
+***
+**/
+
+GtkMenuItem * ido_progress_menu_item_new_from_model (GMenuItem    * menuitem,
+                                                     GActionGroup * actions);
+
+
+G_END_DECLS
+
+#endif
diff --git a/src/idomenuitemfactory.c b/src/idomenuitemfactory.c
index 5ded309..b233095 100644
--- a/src/idomenuitemfactory.c
+++ b/src/idomenuitemfactory.c
@@ -21,6 +21,7 @@
 #include <gtk/ubuntu-private.h>
 
 #include "idoappointmentmenuitem.h"
+#include "idobasicmenuitem.h"
 #include "idocalendarmenuitem.h"
 #include "idolocationmenuitem.h"
 #include "idoscalemenuitem.h"
@@ -66,6 +67,9 @@ ido_menu_item_factory_create_menu_item (UbuntuMenuItemFactory *factory,
   else if (g_str_equal (type, "com.canonical.indicator.appointment"))
     item = ido_appointment_menu_item_new_from_model (menuitem, actions);
 
+  else if (g_str_equal (type, "com.canonical.indicator.progress"))
+    item = ido_progress_menu_item_new_from_model (menuitem, actions);
+
   else if (g_str_equal (type, "com.canonical.unity.slider"))
     item = ido_scale_menu_item_new_from_model (menuitem, actions);