Normalized GTK click events so that the same pattern of events is sent, on

dhyams · dhyams · commit 3597218caa1c · 2011-10-25T17:44:16.000-04:00
double click, as the other backends.  DOWN-UP-DBLCLICK-UP.
diff --git a/examples/event_handling/test_mouseclicks.py b/examples/event_handling/test_mouseclicks.py
@@ -15,10 +15,10 @@ def OnClick(event):
    if event.dblclick:
       print "DBLCLICK",event
    else:
-      print "DOWN",event
+      print "DOWN    ",event
 
 def OnRelease(event):
-    print "UP",event
+    print   "UP      ",event
 
 
 fig = plt.gcf()
diff --git a/lib/matplotlib/backends/backend_gtk.py b/lib/matplotlib/backends/backend_gtk.py
@@ -1,6 +1,7 @@
 from __future__ import division
 
 import os, sys
+import time
 def fn_name(): return sys._getframe(1).f_code.co_name
 
 try:
@@ -224,6 +225,8 @@ def __init__(self, figure):
 
         self._idle_event_id = gobject.idle_add(self.idle_event)
 
+        self.last_downclick = {}
+
     def destroy(self):
         #gtk.DrawingArea.destroy(self)
         self.close_event()
@@ -249,6 +252,21 @@ def button_press_event(self, widget, event):
         # flipy so y=0 is bottom of canvas
         y = self.allocation.height - event.y
         dblclick = (event.type == gdk._2BUTTON_PRESS)
+        if not dblclick:
+            # GTK is the only backend that generates a DOWN-UP-DOWN-DBLCLICK-UP  event
+            # sequence for a double click.  All other backends have a DOWN-UP-DBLCLICK-UP
+            # sequence.  In order to provide consistency to matplotlib users, we will
+            # eat the extra DOWN event in the case that we detect it is part of a double
+            # click.
+            # first, get the double click time in milliseconds.
+            current_time  = time.time()
+            last_time     = self.last_downclick.get(event.button,0.0)
+            dblclick_time = gtk.settings_get_for_screen(gdk.screen_get_default()).get_property('gtk-double-click-time')
+            delta_time    = int((current_time-last_time)*1000.0)
+            if delta_time < dblclick_time:
+                del self.last_downclick[event.button] # we do not want to eat more than one event.
+                return False                          # eat.
+            self.last_downclick[event.button] = current_time
         FigureCanvasBase.button_press_event(self, x, y, event.button, dblclick=dblclick, guiEvent=event)
         return False  # finish event propagation?
 
