updated keypress examples

jdh2358 · jdh2358 · commit eaf2c339650d · 2004-12-29T16:49:34.000Z
svn path=/trunk/matplotlib/; revision=829
diff --git a/TODO b/TODO
@@ -614,4 +614,6 @@ ZeroDivisionError: SeparableTransformation::eval_scalars yin interval is zero; c
 
 -- DONE mathtext color is wrong in PS
 
--- reverse pie rotation
+-- CLOSED reverse pie rotation
+
+-- check keypress event handling on tooggle_images.
diff --git a/examples/keypress_demo.py b/examples/keypress_demo.py
@@ -1,4 +1,10 @@
+"""
+Show how to connect to keypress events
 
+Note, on the wx backend on some platforms (eg linux), you have to
+first click on the figure before the keypress events are activated.
+If you know how to fix this, please email us!
+"""
 from pylab import *
 
 def press(event):
diff --git a/examples/toggle_images.py b/examples/toggle_images.py
@@ -9,6 +9,11 @@
 
 As usual, we'll define some random images for demo.  Real data is much more
 exciting!
+
+Note, on the wx backend on some platforms (eg linux), you have to
+first click on the figure before the keypress events are activated.
+If you know how to fix this, please email us!
+
 """
 
 from pylab import *
diff --git a/lib/matplotlib/backends/backend_template.py b/lib/matplotlib/backends/backend_template.py
@@ -265,6 +265,12 @@ class FigureCanvasTemplate(FigureCanvasBase):
     Public attribute
 
       figure - A Figure instance
+
+    Note GUI templates will want to connect events for button presses,
+    mouse movements and key presses to functions that call the base
+    class methods button_press_event, button_release_event,
+    motion_notify_event, key_press_event, and key_release_event.  See,
+    eg backend_gtk.py, backend_wx.py and backend_tkagg.py
     """
 
     def draw(self):
