app-chooser-combobox: add an initial implementation

GtkAppChooserCombobox is an implementation of GtkAppChooser inside a
combobox that shows recommended applications for a given content type.

5 files changed, 569 insertions, 0 deletions

diff --git a/gtk/Makefile.am b/gtk/Makefile.am
index a9c495bcb2..8eb288e9a6 100644
--- a/gtk/Makefile.am
+++ b/gtk/Makefile.am
@@ -248,6 +248,7 @@ gtk_public_h_sources =          \
 	gtkoffscreenwindow.h	\
 	gtkappchooser.h		\
 	gtkappchooserdialog.h	\
+	gtkappchoosercombobox.h \
 	gtkappchooserwidget.h	\
 	gtkappchooseronline.h	\
 	gtkorientable.h		\
@@ -538,6 +539,7 @@ gtk_base_c_sources =            \
 	gtkoffscreenwindow.c	\
 	gtkappchooser.c		\
 	gtkappchooserwidget.c	\
+	gtkappchoosercombobox.c \
 	gtkappchooserdialog.c	\
 	gtkappchoosermodule.c	\
 	gtkappchooseronline.c	\
diff --git a/gtk/gtk.h b/gtk/gtk.h
index 81784345f3..cbf8cf674e 100644
--- a/gtk/gtk.h
+++ b/gtk/gtk.h
@@ -132,6 +132,7 @@
 #include <gtk/gtkappchooser.h>
 #include <gtk/gtkappchooserdialog.h>
 #include <gtk/gtkappchooserwidget.h>
+#include <gtk/gtkappchoosercombobox.h>
 #include <gtk/gtkorientable.h>
 #include <gtk/gtkpagesetup.h>
 #include <gtk/gtkpapersize.h>
diff --git a/gtk/gtkappchoosercombobox.c b/gtk/gtkappchoosercombobox.c
new file mode 100644
index 0000000000..b74398ed4c
--- /dev/null
+++ b/gtk/gtkappchoosercombobox.c
@@ -0,0 +1,383 @@
+/*
+ * gtkappchoosercombobox.h: an app-chooser combobox
+ *
+ * Copyright (C) 2010 Red Hat, Inc.
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Library General Public License as
+ * published by the Free Software Foundation; either version 2 of the
+ * License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Library General Public License for more details.
+ *
+ * You should have received a copy of the GNU Library General Public
+ * License along with the Gnome Library; see the file COPYING.LIB.  If not,
+ * write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
+ * Boston, MA 02111-1307, USA.
+ *
+ * Authors: Cosimo Cecchi <ccecchi@redhat.com>
+ */
+
+#include <config.h>
+
+#include "gtkappchoosercombobox.h"
+
+#include "gtkappchooser.h"
+#include "gtkappchooserprivate.h"
+#include "gtkcelllayout.h"
+#include "gtkcellrendererpixbuf.h"
+#include "gtkcellrenderertext.h"
+#include "gtkcombobox.h"
+
+enum {
+  PROP_CONTENT_TYPE = 1,
+};
+
+enum {
+  COLUMN_APP_INFO,
+  COLUMN_NAME,
+  COLUMN_ICON,
+  COLUMN_CUSTOM,
+  COLUMN_SEPARATOR,
+  COLUMN_CALLBACK,
+  NUM_COLUMNS,
+};
+
+typedef struct {
+  GtkAppChooserComboBoxItemFunc func;
+  gpointer user_data;
+} CustomAppComboData;
+
+static gpointer
+custom_app_data_copy (gpointer boxed)
+{
+  CustomAppComboData *retval, *original;
+
+  original = boxed;
+
+  retval = g_slice_new0 (CustomAppComboData);
+  retval->func = original->func;
+  retval->user_data = original->user_data;
+
+  return retval;
+}
+
+static void
+custom_app_data_free (gpointer boxed)
+{
+  g_slice_free (CustomAppComboData, boxed);
+}
+
+#define CUSTOM_COMBO_DATA_TYPE custom_app_combo_data_get_type()
+G_DEFINE_BOXED_TYPE (CustomAppComboData, custom_app_combo_data,
+		     custom_app_data_copy,
+		     custom_app_data_free);
+
+static void app_chooser_iface_init (GtkAppChooserIface *iface);
+
+G_DEFINE_TYPE_WITH_CODE (GtkAppChooserComboBox, gtk_app_chooser_combo_box, GTK_TYPE_COMBO_BOX,
+			 G_IMPLEMENT_INTERFACE (GTK_TYPE_APP_CHOOSER,
+						app_chooser_iface_init));
+
+struct _GtkAppChooserComboBoxPrivate {
+  gchar *content_type;
+  GtkListStore *store;
+};
+
+static gboolean
+row_separator_func (GtkTreeModel *model,
+		    GtkTreeIter *iter,
+		    gpointer user_data)
+{
+  gboolean separator;
+
+  gtk_tree_model_get (model, iter,
+		      COLUMN_SEPARATOR, &separator,
+		      -1);
+
+  return separator;
+}
+
+static void
+gtk_app_chooser_combo_box_populate (GtkAppChooserComboBox *self)
+{
+  GList *recommended_apps = NULL, *l;
+  GAppInfo *app;
+  GtkTreeIter iter;
+  GIcon *icon;
+
+  recommended_apps = g_app_info_get_recommended_for_type (self->priv->content_type);
+
+  for (l = recommended_apps; l != NULL; l = l->next)
+    {
+      app = l->data;
+
+      icon = g_app_info_get_icon (app);
+
+      if (icon == NULL)
+	icon = g_themed_icon_new ("x-application/executable");
+      else
+	g_object_ref (icon);
+
+      gtk_list_store_append (self->priv->store, &iter);
+      gtk_list_store_set (self->priv->store, &iter,
+			  COLUMN_APP_INFO, app,
+			  COLUMN_NAME, g_app_info_get_display_name (app),
+			  COLUMN_ICON, icon,
+			  COLUMN_CUSTOM, FALSE,
+			  -1);
+
+      g_object_unref (icon);
+    }
+
+  gtk_combo_box_set_active (GTK_COMBO_BOX (self), 0);
+}
+
+static void
+gtk_app_chooser_combo_box_build_ui (GtkAppChooserComboBox *self)
+{
+  GtkCellRenderer *cell;
+
+  self->priv->store = gtk_list_store_new (NUM_COLUMNS,
+					  G_TYPE_APP_INFO,
+					  G_TYPE_STRING,
+					  G_TYPE_ICON,
+					  G_TYPE_BOOLEAN,
+					  G_TYPE_BOOLEAN,
+					  CUSTOM_COMBO_DATA_TYPE);
+
+  gtk_combo_box_set_model (GTK_COMBO_BOX (self),
+			   GTK_TREE_MODEL (self->priv->store));
+
+  gtk_combo_box_set_row_separator_func (GTK_COMBO_BOX (self),
+					row_separator_func, NULL, NULL);
+
+  cell = gtk_cell_renderer_pixbuf_new ();
+  gtk_cell_layout_pack_start (GTK_CELL_LAYOUT (self), cell, FALSE);
+  gtk_cell_layout_set_attributes (GTK_CELL_LAYOUT (self), cell,
+				  "gicon", COLUMN_ICON,
+				  NULL);
+
+  cell = gtk_cell_renderer_text_new ();
+  gtk_cell_layout_pack_start (GTK_CELL_LAYOUT (self), cell, TRUE);
+  gtk_cell_layout_set_attributes (GTK_CELL_LAYOUT (self), cell,
+				  "text", COLUMN_NAME,
+				  NULL);
+
+  gtk_app_chooser_combo_box_populate (self);
+}
+
+static void
+gtk_app_chooser_combo_box_remove_non_custom (GtkAppChooserComboBox *self)
+{
+  GtkTreeModel *model;
+  GtkTreeIter iter;
+  gboolean custom, res;
+
+  model = GTK_TREE_MODEL (self->priv->store);
+
+  if (!gtk_tree_model_get_iter_first (model, &iter))
+    return;
+
+  do {
+    gtk_tree_model_get (model, &iter,
+			COLUMN_CUSTOM, &custom,
+			-1);
+    if (custom)
+      res = gtk_list_store_remove (GTK_LIST_STORE (model), &iter);
+    else
+      res = gtk_tree_model_iter_next (model, &iter);
+  } while (res);
+}
+
+static void
+gtk_app_chooser_combo_box_changed (GtkComboBox *object)
+{
+  GtkAppChooserComboBox *self = GTK_APP_CHOOSER_COMBO_BOX (object);
+  GtkTreeIter iter;
+  gboolean custom, separator;
+  CustomAppComboData *custom_data = NULL;
+
+  gtk_combo_box_get_active_iter (object, &iter);
+
+  gtk_tree_model_get (GTK_TREE_MODEL (self->priv->store), &iter,
+		      COLUMN_CUSTOM, &custom,
+		      COLUMN_SEPARATOR, &separator,
+		      COLUMN_CALLBACK, &custom_data,
+		      -1);
+
+  if (custom && !separator &&
+      custom_data != NULL && custom_data->func != NULL)
+    custom_data->func (self, custom_data->user_data);
+}
+
+static void
+gtk_app_chooser_combo_box_refresh (GtkAppChooser *object)
+{
+  GtkAppChooserComboBox *self = GTK_APP_CHOOSER_COMBO_BOX (object);
+
+  gtk_app_chooser_combo_box_remove_non_custom (self);
+  gtk_app_chooser_combo_box_populate (self);
+}
+
+static GAppInfo *
+gtk_app_chooser_combo_box_get_app_info (GtkAppChooser *object)
+{
+  GtkAppChooserComboBox *self = GTK_APP_CHOOSER_COMBO_BOX (object);
+  GtkTreeIter iter;
+  GAppInfo *info;
+
+  if (!gtk_combo_box_get_active_iter (GTK_COMBO_BOX (self), &iter))
+    return NULL;
+
+  gtk_tree_model_get (GTK_TREE_MODEL (self->priv->store), &iter,
+		      COLUMN_APP_INFO, &info,
+		      -1);
+
+  return info;
+}
+
+static void
+gtk_app_chooser_combo_box_constructed (GObject *obj)
+{
+  GtkAppChooserComboBox *self = GTK_APP_CHOOSER_COMBO_BOX (obj);
+
+  if (G_OBJECT_CLASS (gtk_app_chooser_combo_box_parent_class)->constructed != NULL)
+    G_OBJECT_CLASS (gtk_app_chooser_combo_box_parent_class)->constructed (obj);
+
+  g_assert (self->priv->content_type != NULL);
+
+  gtk_app_chooser_combo_box_build_ui (self);
+}
+
+static void
+gtk_app_chooser_combo_box_set_property (GObject *obj,
+					guint property_id,
+					const GValue *value,
+					GParamSpec *pspec)
+{
+  GtkAppChooserComboBox *self = GTK_APP_CHOOSER_COMBO_BOX (obj);
+
+  switch (property_id)
+    {
+    case PROP_CONTENT_TYPE:
+      self->priv->content_type = g_value_dup_string (value);
+      break;
+    default:
+      G_OBJECT_WARN_INVALID_PROPERTY_ID (obj, property_id, pspec);
+      break;
+    }
+}
+
+static void
+gtk_app_chooser_combo_box_get_property (GObject *obj,
+					guint property_id,
+					GValue *value,
+					GParamSpec *pspec)
+{
+  GtkAppChooserComboBox *self = GTK_APP_CHOOSER_COMBO_BOX (obj);
+
+  switch (property_id)
+    {
+    case PROP_CONTENT_TYPE:
+      g_value_set_string (value, self->priv->content_type);
+      break;
+    default:
+      G_OBJECT_WARN_INVALID_PROPERTY_ID (obj, property_id, pspec);
+      break;
+    }
+}
+
+static void
+gtk_app_chooser_combo_box_finalize (GObject *obj)
+{
+  GtkAppChooserComboBox *self = GTK_APP_CHOOSER_COMBO_BOX (obj);
+
+  g_free (self->priv->content_type);
+
+  G_OBJECT_CLASS (gtk_app_chooser_combo_box_parent_class)->finalize (obj);
+}
+
+static void
+app_chooser_iface_init (GtkAppChooserIface *iface)
+{
+  iface->get_app_info = gtk_app_chooser_combo_box_get_app_info;
+  iface->refresh = gtk_app_chooser_combo_box_refresh;
+}
+
+static void
+gtk_app_chooser_combo_box_class_init (GtkAppChooserComboBoxClass *klass)
+{
+  GObjectClass *oclass = G_OBJECT_CLASS (klass);
+  GtkComboBoxClass *combo_class = GTK_COMBO_BOX_CLASS (klass);
+
+  oclass->set_property = gtk_app_chooser_combo_box_set_property;
+  oclass->get_property = gtk_app_chooser_combo_box_get_property;
+  oclass->finalize = gtk_app_chooser_combo_box_finalize;
+  oclass->constructed = gtk_app_chooser_combo_box_constructed;
+
+  combo_class->changed = gtk_app_chooser_combo_box_changed;
+
+  g_object_class_override_property (oclass, PROP_CONTENT_TYPE, "content-type");
+
+  g_type_class_add_private (klass, sizeof (GtkAppChooserComboBoxPrivate));
+}
+
+static void
+gtk_app_chooser_combo_box_init (GtkAppChooserComboBox *self)
+{
+  self->priv =
+    G_TYPE_INSTANCE_GET_PRIVATE (self, GTK_TYPE_APP_CHOOSER_COMBO_BOX,
+				 GtkAppChooserComboBoxPrivate);
+}
+
+GtkWidget *
+gtk_app_chooser_combo_box_new (const gchar *content_type)
+{
+  g_return_val_if_fail (content_type != NULL, NULL);
+
+  return g_object_new (GTK_TYPE_APP_CHOOSER_COMBO_BOX,
+		       "content-type", content_type,
+		       NULL);
+}
+
+void
+gtk_app_chooser_combo_box_append_separator (GtkAppChooserComboBox *self)
+{
+  GtkTreeIter iter;
+
+  g_return_if_fail (GTK_IS_APP_CHOOSER_COMBO_BOX (self));
+
+  gtk_list_store_append (self->priv->store, &iter);
+  gtk_list_store_set (self->priv->store, &iter,
+		      COLUMN_CUSTOM, TRUE,
+		      COLUMN_SEPARATOR, TRUE,
+		      -1);
+}
+
+void
+gtk_app_chooser_combo_box_append_custom_item (GtkAppChooserComboBox *self,
+					      const gchar *label,
+					      GIcon *icon,
+					      GtkAppChooserComboBoxItemFunc func,
+					      gpointer user_data)
+{
+  GtkTreeIter iter;
+  CustomAppComboData *data;
+
+  data = g_slice_new0 (CustomAppComboData);
+  data->func = func;
+  data->user_data = user_data;
+
+  gtk_list_store_append (self->priv->store, &iter);
+  gtk_list_store_set (self->priv->store, &iter,
+		      COLUMN_NAME, label,
+		      COLUMN_ICON, icon,
+		      COLUMN_CALLBACK, data,
+		      COLUMN_CUSTOM, TRUE,
+		      COLUMN_SEPARATOR, FALSE,
+		      -1);
+}
diff --git a/gtk/gtkappchoosercombobox.h b/gtk/gtkappchoosercombobox.h
new file mode 100644
index 0000000000..4bd268b86e
--- /dev/null
+++ b/gtk/gtkappchoosercombobox.h
@@ -0,0 +1,79 @@
+/*
+ * gtkappchoosercombobox.h: an app-chooser combobox
+ *
+ * Copyright (C) 2010 Red Hat, Inc.
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Library General Public License as
+ * published by the Free Software Foundation; either version 2 of the
+ * License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Library General Public License for more details.
+ *
+ * You should have received a copy of the GNU Library General Public
+ * License along with the Gnome Library; see the file COPYING.LIB.  If not,
+ * write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
+ * Boston, MA 02111-1307, USA.
+ *
+ * Authors: Cosimo Cecchi <ccecchi@redhat.com>
+ */
+
+#if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
+#error "Only <gtk/gtk.h> can be included directly."
+#endif
+
+#ifndef __GTK_APP_CHOOSER_COMBO_BOX_H__
+#define __GTK_APP_CHOOSER_COMBO_BOX_H__
+
+#include <gtk/gtkcombobox.h>
+#include <gio/gio.h>
+
+#define GTK_TYPE_APP_CHOOSER_COMBO_BOX\
+  (gtk_app_chooser_combo_box_get_type ())
+#define GTK_APP_CHOOSER_COMBO_BOX(obj)\
+  (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_APP_CHOOSER_COMBO_BOX, GtkAppChooserComboBox))
+#define GTK_APP_CHOOSER_COMBO_BOX_CLASS(klass)\
+  (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_APP_CHOOSER_COMBO_BOX, GtkAppChooserComboBoxClass))
+#define GTK_IS_APP_CHOOSER_COMBO_BOX(obj)\
+  (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_APP_CHOOSER_COMBO_BOX))
+#define GTK_IS_APP_CHOOSER_COMBO_BOX_CLASS(klass)\
+  (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_APP_CHOOSER_COMBO_BOX))
+#define GTK_APP_CHOOSER_COMBO_BOX_GET_CLASS(obj)\
+  (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_APP_CHOOSER_COMBO_BOX, GtkAppChooserComboBoxClass))
+
+typedef struct _GtkAppChooserComboBox        GtkAppChooserComboBox;
+typedef struct _GtkAppChooserComboBoxClass   GtkAppChooserComboBoxClass;
+typedef struct _GtkAppChooserComboBoxPrivate GtkAppChooserComboBoxPrivate;
+
+typedef void (* GtkAppChooserComboBoxItemFunc) (GtkAppChooserComboBox *self,
+						gpointer user_data);
+
+struct _GtkAppChooserComboBox {
+  GtkComboBox parent;
+
+  /*< private >*/
+  GtkAppChooserComboBoxPrivate *priv;
+};
+
+struct _GtkAppChooserComboBoxClass {
+  GtkComboBoxClass parent_class;
+
+  /* padding for future class expansion */
+  gpointer padding[16];
+};
+
+GType      gtk_app_chooser_combo_box_get_type (void) G_GNUC_CONST;
+
+GtkWidget * gtk_app_chooser_combo_box_new (const gchar *content_type);
+
+void gtk_app_chooser_combo_box_append_separator (GtkAppChooserComboBox *self);
+void gtk_app_chooser_combo_box_append_custom_item (GtkAppChooserComboBox *self,
+						   const gchar *label,
+						   GIcon *icon,
+						   GtkAppChooserComboBoxItemFunc func,
+						   gpointer user_data);
+
+#endif /* __GTK_APP_CHOOSER_COMBO_BOX_H__ */
diff --git a/tests/testappchoosercombo.c b/tests/testappchoosercombo.c
new file mode 100644
index 0000000000..11af64f2ea
--- /dev/null
+++ b/tests/testappchoosercombo.c
@@ -0,0 +1,104 @@
+/* testappchoosercombo.c
+ * Copyright (C) 2010 Red Hat, Inc.
+ * Authors: Cosimo Cecchi
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Library General Public
+ * License as published by the Free Software Foundation; either
+ * version 2 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Library General Public License for more details.
+ *
+ * You should have received a copy of the GNU Library General Public
+ * License along with this library; if not, write to the
+ * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
+ * Boston, MA 02111-1307, USA.
+ */
+
+#include <config.h>
+#include <stdlib.h>
+
+#include <gtk/gtk.h>
+
+static GtkWidget *toplevel, *combobox, *box;
+static GtkWidget *sel_image, *sel_name;
+
+static void
+combo_changed_cb (GtkComboBox *cb,
+		  gpointer user_data)
+{
+  GAppInfo *app_info;
+
+  app_info = gtk_app_chooser_get_app_info (GTK_APP_CHOOSER (cb));
+
+  if (app_info == NULL)
+    return;
+
+  gtk_image_set_from_gicon (GTK_IMAGE (sel_image), g_app_info_get_icon (app_info),
+			    GTK_ICON_SIZE_DIALOG);
+  gtk_label_set_text (GTK_LABEL (sel_name), g_app_info_get_display_name (app_info));
+
+  g_object_unref (app_info);
+}
+
+static void
+special_item_activated_cb (GtkAppChooserComboBox *cb,
+			   gpointer user_data)
+{
+  gtk_image_set_from_gicon (GTK_IMAGE (sel_image), g_themed_icon_new ("face-smile"),
+			    GTK_ICON_SIZE_DIALOG);
+  gtk_label_set_text (GTK_LABEL (sel_name), "Special Item");  
+}
+
+int
+main (int argc,
+      char **argv)
+{
+  GtkWidget *w;
+
+  g_type_init ();
+  gtk_init (&argc, &argv);
+
+  toplevel = gtk_window_new (GTK_WINDOW_TOPLEVEL);
+  gtk_container_set_border_width (GTK_CONTAINER (toplevel), 12);
+
+  box = gtk_box_new (GTK_ORIENTATION_VERTICAL, 6);
+  gtk_container_add (GTK_CONTAINER (toplevel), box);
+
+  combobox = gtk_app_chooser_combo_box_new ("image/jpeg");
+  gtk_box_pack_start (GTK_BOX (box), combobox, TRUE, TRUE, 0);
+
+  g_signal_connect (combobox, "changed",
+		    G_CALLBACK (combo_changed_cb), NULL);
+
+  w = gtk_label_new (NULL);
+  gtk_label_set_markup (GTK_LABEL (w), "<b>Selected app info</b>");
+  gtk_box_pack_start (GTK_BOX (box), w, TRUE, TRUE, 0);
+
+  w = gtk_box_new (GTK_ORIENTATION_HORIZONTAL, 6);
+  gtk_box_pack_start (GTK_BOX (box), w, TRUE, TRUE, 0);
+
+  sel_image = gtk_image_new ();
+  gtk_box_pack_start (GTK_BOX (w), sel_image, TRUE, TRUE, 0);
+  sel_name = gtk_label_new (NULL);
+  gtk_box_pack_start (GTK_BOX (w), sel_name, TRUE, TRUE, 0);
+
+  gtk_app_chooser_combo_box_append_separator (GTK_APP_CHOOSER_COMBO_BOX (combobox));
+  gtk_app_chooser_combo_box_append_custom_item (GTK_APP_CHOOSER_COMBO_BOX (combobox),
+						"Hey, I'm special!",
+						g_themed_icon_new ("face-smile"),
+						special_item_activated_cb,
+						NULL);
+
+  gtk_widget_show_all (toplevel);
+
+  g_signal_connect (toplevel, "delete-event",
+		    G_CALLBACK (gtk_main_quit), NULL);
+
+  gtk_main ();
+
+  return EXIT_SUCCESS;
+}