Merge lp:~jpakkane/libgrip/unsubscribering into lp:libgrip

[Jussi Pakkanen]

This branch adds gesture unsubscribe possibility to libgrip. Currently only unsubscribing all gestures on a whole window is supported.

[Stephen M. Webb (bregma)]

OK.

I like the new names better.

review: Approve

=== modified file 'examples/rectangle-mover/gesture.c'
--- examples/rectangle-mover/gesture.c	2011-05-19 11:31:39 +0000
+++ examples/rectangle-mover/gesture.c	2011-06-16 15:02:33 +0000
@@ -9,6 +9,14 @@
 static gdouble translate[2] = { 200, 200 };
 static gint    in_touch = 0;
 
+static void subscribe_gestures(GripGestureManager *manager, GtkWidget *window, GtkWidget *da);
+
+struct app_data {
+  GripGestureManager *manager;
+  GtkWidget *main_window;
+  GtkWidget *da;
+};
+
 static gboolean
 draw_canvas (GtkWidget *widget,
              cairo_t   *cr,
@@ -84,6 +92,16 @@
   gtk_widget_queue_draw (GTK_WIDGET (widget));
 }
 
+static void
+subscribe_toggled(GtkToggleButton *toggle_button, gpointer user_data)
+{
+  struct app_data *app = (struct app_data*)(user_data);
+  if (gtk_toggle_button_get_active(toggle_button)) {
+      subscribe_gestures(app->manager, app->main_window, app->da);
+  } else {
+      grip_gesture_manager_unregister_window(app->manager, app->main_window);
+  }
+}
 
 static GtkTreeModel *
 create_model ()
@@ -91,20 +109,54 @@
   return (GtkTreeModel *)gtk_list_store_new (1, G_TYPE_STRING);
 }
 
+static void
+subscribe_gestures(GripGestureManager *manager, GtkWidget *window,
+    GtkWidget *da)
+{
+  grip_gesture_manager_register_window (manager,
+                                        da,
+                                        GRIP_GESTURE_PINCH,
+                                        2,
+                                        gesture_callback,
+                                        NULL, NULL);
+
+  grip_gesture_manager_register_window (manager,
+                                        da,
+                                        GRIP_GESTURE_ROTATE,
+                                        2,
+                                        gesture_callback,
+                                        NULL, NULL);
+
+  grip_gesture_manager_register_window (manager,
+                                        da,
+                                        GRIP_GESTURE_DRAG,
+                                        2,
+                                        gesture_callback,
+                                        NULL, NULL);
+
+  grip_gesture_manager_register_window (manager,
+                                        da,
+                                        GRIP_GESTURE_TAP,
+                                        2,
+                                        gesture_callback,
+                                        NULL, NULL);
+}
+
 static GtkWidget *
-create_window (GripGestureManager *manager)
+create_window (struct app_data *app)
 {
-  GtkWidget *window = gtk_window_new (GTK_WINDOW_TOPLEVEL);
-  GtkWidget *da;
+  app->main_window = gtk_window_new (GTK_WINDOW_TOPLEVEL);
+  GtkWidget *window = app->main_window;
   GtkWidget *hbox;
   GtkWidget *vbox;
   GtkWidget *button;
+  GtkWidget *subscribed_toggle;
   GtkWidget *tv;
   GtkTreeModel *model;
   GtkWidget *sw;
   const GdkColor white = { 0, 0xffff, 0xffff, 0xffff };
 
-  da = gtk_drawing_area_new ();
+  app->da = gtk_drawing_area_new ();
 
   gtk_window_set_title (GTK_WINDOW (window), "Touch Demo");
   gtk_window_set_default_size (GTK_WINDOW (window), 600, 600);
@@ -115,7 +167,7 @@
   vbox = gtk_vbox_new (FALSE, 0);
 
   gtk_box_pack_start (GTK_BOX (hbox), vbox, FALSE, FALSE, 0);
-  gtk_box_pack_start (GTK_BOX (hbox), da, TRUE, TRUE, 0);
+  gtk_box_pack_start (GTK_BOX (hbox), app->da, TRUE, TRUE, 0);
 
   model = create_model ();
   sw = gtk_scrolled_window_new (NULL, NULL);
@@ -131,44 +183,23 @@
                     "clicked",
                     G_CALLBACK (gtk_main_quit),
                     NULL);
-
+  subscribed_toggle = gtk_toggle_button_new_with_label ("Gestures");
+  gtk_toggle_button_set_active (GTK_TOGGLE_BUTTON(subscribed_toggle), TRUE);
+  g_signal_connect (subscribed_toggle,
+                    "toggled",
+                    G_CALLBACK (subscribe_toggled),
+                    app);
+  gtk_box_pack_start (GTK_BOX (vbox), subscribed_toggle, FALSE, FALSE, 0);
   gtk_box_pack_start (GTK_BOX (vbox), button, FALSE, FALSE, 0);
 
   gtk_container_add (GTK_CONTAINER (window), hbox);
 
-  gtk_widget_modify_bg (da, GTK_STATE_NORMAL, &white);
+  gtk_widget_modify_bg (app->da, GTK_STATE_NORMAL, &white);
 
-  g_signal_connect (da, "draw",
+  g_signal_connect (app->da, "draw",
                     G_CALLBACK (draw_canvas), NULL);
 
-  grip_gesture_manager_register_window (manager,
-                                        da,
-                                        GRIP_GESTURE_PINCH,
-                                        2,
-                                        gesture_callback,
-                                        NULL, NULL);
-
-  grip_gesture_manager_register_window (manager,
-                                        da,
-                                        GRIP_GESTURE_ROTATE,
-                                        2,
-                                        gesture_callback,
-                                        NULL, NULL);
-
-  grip_gesture_manager_register_window (manager,
-                                        da,
-                                        GRIP_GESTURE_DRAG,
-                                        2,
-                                        gesture_callback,
-                                        NULL, NULL);
-
-  grip_gesture_manager_register_window (manager,
-                                        da,
-                                        GRIP_GESTURE_TAP,
-                                        2,
-                                        gesture_callback,
-                                        NULL, NULL);
-
+  subscribe_gestures(app->manager, window, app->da);
   return window;
 }
 
@@ -183,8 +214,7 @@
 int
 main (int argc, char **argv)
 {
-  GtkWidget *window;
-  GripGestureManager *manager;
+  struct app_data app;
 
   gtk_init (&argc, &argv);
 
@@ -192,12 +222,12 @@
    * my Dell XT2 has in it. */
   signal (SIGABRT, abort_handler);
 
-  manager = grip_gesture_manager_get ();
-  window = create_window (manager);
-
-  g_signal_connect (window, "destroy", G_CALLBACK (gtk_main_quit), NULL);
-
-  gtk_widget_show_all (GTK_WIDGET (window));
+  app.manager = grip_gesture_manager_get ();
+  create_window (&app);
+
+  g_signal_connect (app.main_window, "destroy", G_CALLBACK (gtk_main_quit), NULL);
+
+  gtk_widget_show_all (GTK_WIDGET (app.main_window));
 
   gtk_main ();
 
 
=== modified file 'src/gripgesturemanager.c'
--- src/gripgesturemanager.c	2011-06-15 12:51:57 +0000
+++ src/gripgesturemanager.c	2011-06-16 15:02:33 +0000
@@ -34,7 +34,7 @@
 
 struct _GripGestureManagerPrivate
 {
-  GHashTable *hash;
+  GHashTable *registered_windows;
   GList      *requests;
 };
 
@@ -143,16 +143,14 @@
 {
 }
 
+
 static void
-free_registration (gpointer key,
-		   gpointer value,
-		   gpointer user_data)
+free_registration(GripGestureRegistration *reg)
 {
-  GripGestureRegistration *reg = (GripGestureRegistration *)value;
   GList *tmp = NULL;
 
   geis_unsubscribe (reg->instance,
-		    (GeisGestureType*)reg->gesture_list->pdata);
+      (GeisGestureType*)reg->gesture_list->pdata);
 
   /* We don't need to free the values in the GPtrArray. */
   g_ptr_array_free (reg->gesture_list, TRUE);
@@ -165,19 +163,30 @@
   g_list_free (reg->bindings);
 }
 
+/* Helper function needed to make things work with GTK. */
+
+static void
+free_registration_adapter (gpointer key,
+                   gpointer value,
+                   gpointer user_data)
+{
+  GripGestureRegistration *reg = (GripGestureRegistration *)value;
+  free_registration(reg);
+}
+
 static void
 grip_gesture_manager_finalize (GObject *object)
 {
   GripGestureManagerPrivate *priv = GRIP_GESTURE_MANAGER_GET_PRIVATE (object);
 
-  if (priv->hash != NULL)
+  if (priv->registered_windows != NULL)
     {
-      g_hash_table_foreach (priv->hash,
-			    free_registration,
+      g_hash_table_foreach (priv->registered_windows,
+			    free_registration_adapter,
 			    NULL);
 
-      g_hash_table_unref (priv->hash);
-      priv->hash = NULL;
+      g_hash_table_unref (priv->registered_windows);
+      priv->registered_windows = NULL;
     }
 }
 
@@ -647,7 +656,7 @@
 
   priv = item->priv = GRIP_GESTURE_MANAGER_GET_PRIVATE (item);
 
-  priv->hash = g_hash_table_new (g_direct_hash, g_direct_equal);
+  priv->registered_windows = g_hash_table_new (g_direct_hash, g_direct_equal);
 }
 
 static gboolean
@@ -668,7 +677,7 @@
 {
   GripGestureManager *manager = (GripGestureManager *)user_data;
   GripGestureManagerPrivate *priv = manager->priv;
-  GripGestureRegistration *reg = g_hash_table_lookup (priv->hash, object);
+  GripGestureRegistration *reg = g_hash_table_lookup (priv->registered_windows, object);
   GList *list;
 
   for (list = reg->bindings; list != NULL; list = list->next)
@@ -691,7 +700,7 @@
 
   geis_finish (reg->instance);
 
-  g_hash_table_remove (priv->hash, object);
+  g_hash_table_remove (priv->registered_windows, object);
   g_free (reg);
 }
 
@@ -737,7 +746,7 @@
 
   priv = manager->priv;
 
-  if (!(reg = g_hash_table_lookup (priv->hash, toplevel)))
+  if (!(reg = g_hash_table_lookup (priv->registered_windows, toplevel)))
     {
       GeisInstance  instance;
       GIOChannel   *iochannel;
@@ -826,7 +835,7 @@
 
   reg->bindings = g_list_append (reg->bindings, binding);
 
-  g_hash_table_insert (priv->hash,
+  g_hash_table_insert (priv->registered_windows,
                        toplevel,
                        reg);
 }
@@ -1036,6 +1045,30 @@
     }
 }
 
+void
+grip_gesture_manager_unregister_window (GripGestureManager  *manager,
+                                        GtkWidget           *toplevel)
+{
+  GripGestureManagerPrivate *priv = manager->priv;
+  GripGestureRegistration *reg;
+
+  g_return_if_fail (GRIP_IS_GESTURE_MANAGER (manager));
+  g_return_if_fail (GTK_IS_WINDOW (toplevel));
+
+  /* Currently only allow unsubscribing after the window has been shown. */
+  g_return_if_fail (gtk_widget_get_mapped (GTK_WIDGET (toplevel)));
+  reg = g_hash_table_lookup (priv->registered_windows, toplevel);
+  if (!reg) {
+      return;
+  }
+  free_registration(reg);
+  geis_finish(reg->instance);
+  reg->instance = NULL;
+  g_free(reg);
+  g_hash_table_remove(priv->registered_windows, toplevel);
+
+}
+
 GType
 grip_gesture_event_get_type (void)
 {
 
=== modified file 'src/gripgesturemanager.h'
--- src/gripgesturemanager.h	2011-05-31 14:00:43 +0000
+++ src/gripgesturemanager.h	2011-06-16 15:02:33 +0000
@@ -214,6 +214,9 @@
                                                            gpointer            user_data,
                                                            GDestroyNotify      destroy);
 
+void grip_gesture_manager_unregister_window (GripGestureManager  *manager,
+                                             GtkWidget           *widget);
+
 GType             grip_gesture_event_get_type (void) G_GNUC_CONST;
 GripGestureEvent *grip_gesture_event_new      (GripGestureType   gesture_type);
 void              grip_gesture_event_free     (GripGestureEvent *event);
 
=== modified file 'src/libgrip-0.1.ver'
--- src/libgrip-0.1.ver	2011-03-04 21:48:13 +0000
+++ src/libgrip-0.1.ver	2011-06-16 15:02:33 +0000
@@ -30,6 +30,7 @@
     grip_gesture_manager_get;
     grip_gesture_manager_get_type;
     grip_gesture_manager_register_window;
+    grip_gesture_manager_unregister_window; # Delete once the version number is bumped.
     grip_gesture_type_get_type;
     grip_time_type_get_type;
 
@@ -37,3 +38,8 @@
     *;
 };
 
+# Uncomment once version number is bumped.
+#GRIP_0.2 {
+#  global:
+#    grip_gesture_manager_unregister_window;
+#} GRIP_0.1;