ephy-removable-pixbuf-renderer: new renderer for the overview

This is a renderer that draws a "close" button on top of its contents
and that emits a signal when the button is activated.

3 files changed, 351 insertions, 0 deletions

diff --git a/lib/widgets/Makefile.am b/lib/widgets/Makefile.am
index 71980752c..d1b36d6f2 100644
--- a/lib/widgets/Makefile.am
+++ b/lib/widgets/Makefile.am
@@ -1,5 +1,67 @@
 noinst_LTLIBRARIES = libephywidgets.la
 
+BUILT_SOURCES = \
+	ephy-widgets-type-builtins.c	\
+	ephy-widgets-type-builtins.h
+
+TYPES_H_FILES = \
+	ephy-removable-pixbuf-renderer.h
+
+CLEANFILES = $(stamp_files) $(BUILT_SOURCES)
+DISTCLEANFILES = $(stamp_files) $(BUILT_SOURCES)
+MAINTAINERCLEANFILES = $(stamp_files) $(BUILT_SOURCES)
+
+stamp_files = \
+	stamp-ephy-widgets-type-builtins.c	\
+	stamp-ephy-widgets-type-builtins.h
+
+ephy-widgets-type-builtins.c: stamp-ephy-widgets-type-builtins.c Makefile
+	@true
+
+stamp-ephy-widgets-type-builtins.c: Makefile $(TYPES_H_FILES)
+	$(AM_V_GEN) $(GLIB_MKENUMS) \
+		--fhead "#include <config.h>\n\n" \
+		--fhead "#include \"ephy-widgets-type-builtins.h\"\n\n" \
+		--fprod "\n/* enumerations from \"@filename@\" */" \
+		--fprod "\n#include \"@filename@\"" \
+		--vhead "GType\n@enum_name@_get_type (void)\n{\n" \
+		--vhead "  static GType type = 0;\n\n" \
+		--vhead "  if (G_UNLIKELY (type == 0))\n  {\n" \
+		--vhead "    static const G@Type@Value _@enum_name@_values[] = {" \
+		--vprod "      { @VALUENAME@, \"@VALUENAME@\", \"@valuenick@\" }," \
+		--vtail "      { 0, NULL, NULL }\n    };\n\n" \
+		--vtail "    type = g_@type@_register_static (\"@EnumName@\", _@enum_name@_values);\n  }\n\n" \
+		--vtail "  return type;\n}\n\n" \
+		$(filter-out $<,$^) > xgen-$(@F) \
+	&& ( cmp -s xgen-$(@F) $(@F:stamp-%=%) || cp xgen-$(@F) $(@F:stamp-%=%) ) \
+	&& rm -f xgen-$(@F) \
+	&& echo timestamp > $(@F)
+
+ephy-widgets-type-builtins.h: stamp-ephy-widgets-type-builtins.h Makefile
+	@true
+
+stamp-ephy-widgets-type-builtins.h: Makefile $(TYPES_H_FILES)
+	$(AM_V_GEN) $(GLIB_MKENUMS) \
+		--fhead "#if !defined (__EPHY_EPIPHANY_H_INSIDE__) && !defined (EPIPHANY_COMPILATION)\n" \
+		--fhead "#error Only <epiphany/epiphany.h> can be included directly.\n" \
+		--fhead "#endif\n\n" \
+		--fhead "#ifndef EPHY_WIDGETS_TYPE_BUILTINS_H\n" \
+		--fhead "#define EPHY_WIDGETS_TYPE_BUILTINS_H 1\n\n" \
+		--fhead "#include <glib-object.h>\n\n" \
+		--fhead "G_BEGIN_DECLS\n\n" \
+		--ftail "G_END_DECLS\n\n" \
+		--ftail "#endif /* EPHY_WIDGETS_TYPE_BUILTINS_H */\n" \
+		--fprod "\n/* --- @filename@ --- */" \
+		--eprod "#define EPHY_TYPE_@ENUMSHORT@ @enum_name@_get_type()\n" \
+		--eprod "GType @enum_name@_get_type (void);\n" \
+		$(filter-out $<,$^) > xgen-$(@F) \
+	&& ( cmp -s xgen-$(@F) $(@F:stamp-%=%) || cp xgen-$(@F) $(@F:stamp-%=%) ) \
+	&& rm -f xgen-$(@F) \
+	&& echo timestamp > $(@F)
+
+nodist_libephywidgets_la_SOURCES = \
+	$(BUILT_SOURCES)
+
 libephywidgets_la_SOURCES = \
 	ephy-certificate-dialog.c		\
 	ephy-certificate-dialog.h		\
@@ -17,6 +79,8 @@ libephywidgets_la_SOURCES = \
 	ephy-middle-clickable-button.h		\
 	ephy-node-view.c			\
 	ephy-node-view.h			\
+	ephy-removable-pixbuf-renderer.c	\
+	ephy-removable-pixbuf-renderer.h	\
 	ephy-search-entry.c			\
 	ephy-search-entry.h			\
 	ephy-tree-model-node.c			\
diff --git a/lib/widgets/ephy-removable-pixbuf-renderer.c b/lib/widgets/ephy-removable-pixbuf-renderer.c
new file mode 100644
index 000000000..48d8be0ff
--- /dev/null
+++ b/lib/widgets/ephy-removable-pixbuf-renderer.c
@@ -0,0 +1,221 @@
+/*
+ * Copyright (c) 2011 Red Hat, Inc.
+ * Copyright (c) 2012 Igalia, S.L.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or (at your
+ * option) any later version.
+ *
+ * This program 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 Lesser General Public
+ * License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+ *
+ * Based on gd-toggle-pixbuf-renderer by Cosimo Cecchi <cosimoc@redhat.com>
+ *
+ */
+
+#include "config.h"
+
+#include "ephy-removable-pixbuf-renderer.h"
+#include "ephy-widgets-type-builtins.h"
+
+G_DEFINE_TYPE (EphyRemovablePixbufRenderer, ephy_removable_pixbuf_renderer, GD_TYPE_TOGGLE_PIXBUF_RENDERER);
+
+enum {
+  DELETE_CLICKED,
+  LAST_SIGNAL
+};
+
+enum {
+  PROP_0 = 0,
+  PROP_RENDER_POLICY
+};
+
+static guint signals[LAST_SIGNAL] = { 0 };
+
+struct _EphyRemovablePixbufRendererPrivate {
+  EphyRemovablePixbufRenderPolicy policy;
+  GdkPixbuf *close_icon;
+};
+
+static void
+get_icon_rectangle (GtkWidget *widget,
+		    GtkCellRenderer *cell,
+		    const GdkRectangle *cell_area,
+		    GdkPixbuf *icon,
+		    GdkRectangle *rectangle)
+{
+  GtkTextDirection direction;
+  gint x_offset, xpad, ypad;
+  gint icon_size;
+
+  gtk_cell_renderer_get_padding (cell, &xpad, &ypad);
+  direction = gtk_widget_get_direction (widget);
+  icon_size = gdk_pixbuf_get_width (icon);
+
+  if (direction == GTK_TEXT_DIR_RTL)
+    x_offset = xpad + 10;
+  else
+    x_offset = cell_area->width - icon_size - xpad - 10;
+
+  rectangle->x = cell_area->x + x_offset;
+  rectangle->y = cell_area->y + ypad + 5;
+  rectangle->width = rectangle->height = icon_size;
+}
+
+static void
+ephy_removable_pixbuf_renderer_render (GtkCellRenderer      *cell,
+				       cairo_t              *cr,
+				       GtkWidget            *widget,
+				       const GdkRectangle   *background_area,
+				       const GdkRectangle   *cell_area,
+				       GtkCellRendererState  flags)
+{
+  GtkStyleContext *context;
+  EphyRemovablePixbufRenderer *self = EPHY_REMOVABLE_PIXBUF_RENDERER (cell);
+  GdkRectangle icon_area;
+
+  GTK_CELL_RENDERER_CLASS (ephy_removable_pixbuf_renderer_parent_class)->render
+    (cell, cr, widget,
+     background_area, cell_area, flags);
+
+  if (self->priv->policy ==  EPHY_REMOVABLE_PIXBUF_RENDER_NEVER ||
+      (self->priv->policy == EPHY_REMOVABLE_PIXBUF_RENDER_PRELIT && !(flags & GTK_CELL_RENDERER_PRELIT)))
+    return;
+
+  get_icon_rectangle (widget, cell, cell_area, self->priv->close_icon, &icon_area);
+  context = gtk_widget_get_style_context (widget);
+  gtk_render_icon (context, cr, self->priv->close_icon, icon_area.x, icon_area.y);
+}
+
+static gboolean
+ephy_removable_pixbuf_renderer_activate (GtkCellRenderer      *cell,
+					 GdkEvent             *event,
+					 GtkWidget            *widget,
+					 const gchar          *path,
+					 const GdkRectangle   *background_area,
+					 const GdkRectangle   *cell_area,
+					 GtkCellRendererState  flags)
+{
+  GdkRectangle icon_area;
+  GdkEventButton *ev = (GdkEventButton *) gtk_get_current_event();
+  EphyRemovablePixbufRendererPrivate *priv = EPHY_REMOVABLE_PIXBUF_RENDERER (cell)->priv;
+
+  get_icon_rectangle (widget, cell, cell_area, priv->close_icon, &icon_area);
+  if (icon_area.x <= ev->x && ev->x <= icon_area.x + icon_area.width &&
+      icon_area.y <= ev->y && ev->y <= icon_area.y + icon_area.height) {
+    g_signal_emit (cell, signals [DELETE_CLICKED], 0, path);
+    return TRUE;
+  }
+
+  return FALSE;
+}
+
+static void
+ephy_removable_pixbuf_renderer_get_property (GObject    *object,
+					     guint       property_id,
+					     GValue     *value,
+					     GParamSpec *pspec)
+{
+  EphyRemovablePixbufRenderer *self = EPHY_REMOVABLE_PIXBUF_RENDERER (object);
+
+  switch (property_id)
+    {
+    case PROP_RENDER_POLICY:
+      g_value_set_enum (value, self->priv->policy);
+      break;
+    default:
+      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
+      break;
+    }
+}
+
+static void
+ephy_removable_pixbuf_renderer_set_property (GObject    *object,
+					     guint       property_id,
+					     const GValue *value,
+					     GParamSpec *pspec)
+{
+  EphyRemovablePixbufRenderer *self = EPHY_REMOVABLE_PIXBUF_RENDERER (object);
+
+  switch (property_id)
+    {
+    case PROP_RENDER_POLICY:
+      self->priv->policy = g_value_get_enum (value);
+      break;
+    default:
+      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
+      break;
+    }
+}
+
+static void
+ephy_removable_pixbuf_renderer_dispose (GObject     *object)
+{
+  EphyRemovablePixbufRendererPrivate *priv = EPHY_REMOVABLE_PIXBUF_RENDERER (object)->priv;
+
+  if (priv->close_icon)
+    g_clear_object (&priv->close_icon);
+
+  G_OBJECT_CLASS (ephy_removable_pixbuf_renderer_parent_class)->dispose (object);
+}
+
+static void
+ephy_removable_pixbuf_renderer_class_init (EphyRemovablePixbufRendererClass *klass)
+{
+  GObjectClass *oclass = G_OBJECT_CLASS (klass);
+  GtkCellRendererClass *crclass = GTK_CELL_RENDERER_CLASS (klass);
+
+  crclass->render = ephy_removable_pixbuf_renderer_render;
+  crclass->activate = ephy_removable_pixbuf_renderer_activate;
+  oclass->get_property = ephy_removable_pixbuf_renderer_get_property;
+  oclass->set_property = ephy_removable_pixbuf_renderer_set_property;
+  oclass->dispose = ephy_removable_pixbuf_renderer_dispose;
+
+  g_object_class_install_property (oclass,
+				   PROP_RENDER_POLICY,
+				   g_param_spec_enum ("render-policy",
+						      "Render policy",
+						      "The rendering policy for the close icon in the renderer",
+						      EPHY_TYPE_REMOVABLE_PIXBUF_RENDER_POLICY,
+						      EPHY_REMOVABLE_PIXBUF_RENDER_PRELIT,
+						      G_PARAM_CONSTRUCT |
+						      G_PARAM_READWRITE |
+						      G_PARAM_STATIC_STRINGS));
+
+  signals[DELETE_CLICKED] =
+    g_signal_new ("delete-clicked",
+		  G_OBJECT_CLASS_TYPE (oclass),
+		  G_SIGNAL_RUN_LAST,
+		  0, NULL, NULL, NULL,
+		  G_TYPE_NONE, 1,
+		  G_TYPE_STRING);
+
+  g_type_class_add_private (klass, sizeof (EphyRemovablePixbufRendererPrivate));
+}
+
+static void
+ephy_removable_pixbuf_renderer_init (EphyRemovablePixbufRenderer *self)
+{
+  GtkIconTheme *icon_theme;
+
+  self->priv = G_TYPE_INSTANCE_GET_PRIVATE (self, EPHY_TYPE_REMOVABLE_PIXBUF_RENDERER,
+                                            EphyRemovablePixbufRendererPrivate);
+  g_object_set (self, "mode", GTK_CELL_RENDERER_MODE_ACTIVATABLE, NULL);
+  icon_theme = gtk_icon_theme_get_default ();
+  self->priv->close_icon = gtk_icon_theme_load_icon (icon_theme,
+						     "window-close-symbolic",
+						     24, 0, NULL);
+}
+
+GtkCellRenderer *
+ephy_removable_pixbuf_renderer_new (void)
+{
+  return g_object_new (EPHY_TYPE_REMOVABLE_PIXBUF_RENDERER, NULL);
+}
diff --git a/lib/widgets/ephy-removable-pixbuf-renderer.h b/lib/widgets/ephy-removable-pixbuf-renderer.h
new file mode 100644
index 000000000..7bb4458de
--- /dev/null
+++ b/lib/widgets/ephy-removable-pixbuf-renderer.h
@@ -0,0 +1,66 @@
+/*
+ * Copyright (c) 2011 Red Hat, Inc.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or (at your
+ * option) any later version.
+ *
+ * This program 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 Lesser General Public
+ * License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+ *
+ * Author: Cosimo Cecchi <cosimoc@redhat.com>
+ *
+ */
+
+#ifndef _EPHY_REMOVABLE_PIXBUF_RENDERER_H
+#define _EPHY_REMOVABLE_PIXBUF_RENDERER_H
+
+#include "gd-toggle-pixbuf-renderer.h"
+
+#include <gtk/gtk.h>
+
+G_BEGIN_DECLS
+
+#define EPHY_TYPE_REMOVABLE_PIXBUF_RENDERER            (ephy_removable_pixbuf_renderer_get_type())
+#define EPHY_REMOVABLE_PIXBUF_RENDERER(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), EPHY_TYPE_REMOVABLE_PIXBUF_RENDERER, EphyRemovablePixbufRenderer))
+#define EPHY_REMOVABLE_PIXBUF_RENDERER_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), EPHY_TYPE_REMOVABLE_PIXBUF_RENDERER, EphyRemovablePixbufRendererClass))
+#define EPHY_IS_REMOVABLE_PIXBUF_RENDERER(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), EPHY_TYPE_REMOVABLE_PIXBUF_RENDERER))
+#define EPHY_IS_REMOVABLE_PIXBUF_RENDERER_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), EPHY_TYPE_REMOVABLE_PIXBUF_RENDERER))
+#define EPHY_REMOVABLE_PIXBUF_RENDERER_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), EPHY_TYPE_REMOVABLE_PIXBUF_RENDERER, EphyRemovablePixbufRendererClass))
+
+typedef struct _EphyRemovablePixbufRenderer EphyRemovablePixbufRenderer;
+typedef struct _EphyRemovablePixbufRendererClass EphyRemovablePixbufRendererClass;
+typedef struct _EphyRemovablePixbufRendererPrivate EphyRemovablePixbufRendererPrivate;
+
+typedef enum {
+  EPHY_REMOVABLE_PIXBUF_RENDER_NEVER = 0,
+  EPHY_REMOVABLE_PIXBUF_RENDER_PRELIT,
+  EPHY_REMOVABLE_PIXBUF_RENDER_ALWAYS
+} EphyRemovablePixbufRenderPolicy;
+
+struct _EphyRemovablePixbufRenderer
+{
+  GdTogglePixbufRenderer parent;
+
+  EphyRemovablePixbufRendererPrivate *priv;
+};
+
+struct _EphyRemovablePixbufRendererClass
+{
+  GdTogglePixbufRendererClass parent_class;
+};
+
+GType ephy_removable_pixbuf_renderer_get_type (void) G_GNUC_CONST;
+
+GtkCellRenderer *ephy_removable_pixbuf_renderer_new (void);
+
+G_END_DECLS
+
+#endif /* _EPHY_REMOVABLE_PIXBUF_RENDERER_H */