Merge lp:~3v1n0/unity/send-events-to-active-indicators into lp:unity

[Marco Trevisan (Treviño)]

In the current unity implementation when an indicator is opened, there's no way to send it scroll or middle-click events.

This commit fixes this, applying an exception to the case of the appmenu entries, that should handle the middle-click like any other click.

Testing this with autopilot plus a fake indicator which reports events should be doable in the near future.

[Tim Penhey (thumper)]

How can we add a test for this in the panel service? Perhaps Neil could provide help here.

review: Needs Information

[Marco Trevisan (Treviño) (3v1n0)]

I've looked a little to the tests that already we have for the panel service, the main issue here is that to check this we'd need (at the current state) a manual test.

Otherwise I guess that we'd need do add a fake indicator, emitting an event to open it, and finally simulate a mouse event over it...

[Tim Penhey (thumper)]

Lets not block this. Add a manual test.

review: Needs Fixing

[Marco Trevisan (Treviño) (3v1n0)]

Manual test added.

[Tim Penhey (thumper)]

review: Approve

=== added file 'manual-tests/Indicators.txt'
--- manual-tests/Indicators.txt	1970-01-01 00:00:00 +0000
+++ manual-tests/Indicators.txt	2011-12-08 05:11:24 +0000
@@ -0,0 +1,14 @@
+Middle-clicking or Scrolling over active Indicators
+---------------------------------------------------
+This test shows how the indicators icons should react to events when active.
+
+#. Start on a clean screen
+#. Open an indicator Menu (i.e. indicator-sound, not a global menu item)
+#. Move the mouse pointer over the indicator-sound and middle-click or scroll
+   over it.
+
+Outcome
+  The indicator-sound should mute/unmute on middle-clicks, and change the system
+  volume on scroll.
+  Middle-clicking over global-menu items should work as before (causing the open
+  indicator menu to close).

=== modified file 'services/panel-service.c'
--- services/panel-service.c	2011-12-05 13:54:28 +0000
+++ services/panel-service.c	2011-12-08 05:11:24 +0000
@@ -260,36 +260,82 @@
         {
           priv->pressed_entry = get_entry_at (self, event->root_x, event->root_y);
           priv->use_event = (priv->pressed_entry == NULL);
+
+          if (priv->pressed_entry)
+            ret = GDK_FILTER_REMOVE;
         }
 
       if (event->evtype == XI_ButtonRelease)
-        {
-          if (priv->use_event)
-            {
-              priv->use_event = FALSE;
-            }
-          else
-            {
-              IndicatorObjectEntry *entry;
-              entry = get_entry_at (self, event->root_x, event->root_y);
-
-              if (entry)
-                {
-                  if (entry != priv->pressed_entry)
-                    {
-                      ret = GDK_FILTER_REMOVE;
-                      priv->use_event = TRUE;
-                    }
-                  else if (priv->last_entry && entry != priv->last_entry)
-                    {
-                      /* If we were navigating over indicators using the keyboard
-                       * and now we click over the indicator under the mouse, we
-                       * must force it to show back again, not make it close */
-                      gchar *entry_id = g_strdup_printf ("%p", entry);
-                      g_signal_emit (self, _service_signals[ENTRY_ACTIVATE_REQUEST], 0, entry_id);
-                      g_free (entry_id);
-                    }
-                }
+        {       
+          IndicatorObjectEntry *entry;
+          gboolean event_is_a_click = FALSE;
+          entry = get_entry_at (self, event->root_x, event->root_y);
+
+          if (XIMaskIsSet (event->buttons.mask, 1) || XIMaskIsSet (event->buttons.mask, 3))
+            {
+              /* Consider only right and left clicks over the indicators entries */
+              event_is_a_click = TRUE;
+            }
+          else if (XIMaskIsSet (event->buttons.mask, 2) && entry)
+            {
+              /* Middle clicks over an appmenu entry are considered just like
+               * all other clicks */
+              IndicatorObject *obj = g_hash_table_lookup (priv->entry2indicator_hash, entry);
+
+              if (g_strcmp0 (g_object_get_data (G_OBJECT (obj), "id"), "libappmenu.so") == 0)
+                {
+                  event_is_a_click = TRUE;
+                }
+            }
+
+          if (event_is_a_click)
+            {
+              if (priv->use_event)
+                {
+                  priv->use_event = FALSE;
+                }
+              else
+                {
+                  if (entry)
+                    {
+                      if (entry != priv->pressed_entry)
+                        {
+                          ret = GDK_FILTER_REMOVE;
+                          priv->use_event = TRUE;
+                        }
+                      else if (priv->last_entry && entry != priv->last_entry)
+                        {
+                          /* If we were navigating over indicators using the keyboard
+                           * and now we click over the indicator under the mouse, we
+                           * must force it to show back again, not make it close */
+                          gchar *entry_id = g_strdup_printf ("%p", entry);
+                          g_signal_emit (self, _service_signals[ENTRY_ACTIVATE_REQUEST], 0, entry_id);
+                          g_free (entry_id);
+                        }
+                    }
+                }
+            }
+          else if ((XIMaskIsSet (event->buttons.mask, 2) ||
+                    XIMaskIsSet (event->buttons.mask, 4) ||
+                    XIMaskIsSet (event->buttons.mask, 5)) && entry)
+            {
+              /* If we're scrolling or middle-clicking over an indicator
+               * (which is not an appmenu entry) then we need to send the
+               * event to the indicator itself, and avoid it to close */
+              gchar *entry_id = g_strdup_printf ("%p", entry);
+
+              if (XIMaskIsSet (event->buttons.mask, 4) || XIMaskIsSet (event->buttons.mask, 5))
+                {
+                  gint32 delta = XIMaskIsSet (event->buttons.mask, 4) ? 120 : -120;
+                  panel_service_scroll_entry (self, entry_id, delta);
+                }
+              else if (entry == priv->pressed_entry)
+                {
+                  panel_service_secondary_activate_entry (self, entry_id, time(NULL));
+                }
+
+              ret = GDK_FILTER_REMOVE;
+              g_free (entry_id);
             }
         }
     }