simulate click

fariza · fariza · commit c5c4f0f185e8 · 2014-04-24T10:33:25.000-04:00
diff --git a/lib/matplotlib/backend_bases.py b/lib/matplotlib/backend_bases.py
@@ -3266,16 +3266,17 @@ def _get_toolbar(self, toolbar, canvas):
 
     @property
     def active_toggle(self):
-        """Get the tooggled Tool"""
+        """Toggled Tool
+
+        **string** :  Currently toggled tool, or None
+        """
         return self._toggled
 
-    def get_instances(self):
-        """Get the active tools instgances
+    @property
+    def instances(self):
+        """Active tools instances
 
-        Returns
-        ----------
-         A dictionary with the active instances that are registered with
-         Navigation
+        **dictionary** : Contains the active instances that are registered
         """
         return self._instances
 
@@ -3289,7 +3290,7 @@ def get_tool_keymap(self, name):
 
         Returns
         ----------
-        Keymap : list of keys associated with the Tool
+        list : list of keys associated with the Tool
         """
         keys = [k for k, i in self._keys.items() if i == name]
         return keys
@@ -3321,6 +3322,11 @@ def set_tool_keymap(self, name, *keys):
     def unregister(self, name):
         """Unregister the tool from the active instances
 
+        Parameters
+        ----------
+        name : string
+            Name of the tool to unregister
+
         Notes
         -----
         This method is used by `PersistentTools` to remove the reference kept
@@ -3330,8 +3336,7 @@ def unregister(self, name):
         destroy if it is a graphical Tool.
 
         If called, next time the `Tool` is used it will be reinstantiated
-        instead
-        of using the existing instance.
+        instead of using the existing instance.
         """
         if self._toggled == name:
             self._handle_toggle(name, from_toolbar=False)
@@ -3408,24 +3413,21 @@ def _get_cls_to_instantiate(self, callback_class):
 
         return callback_class
 
-    def _key_press(self, event):
-        if event.key is None:
-            return
+    def click_tool(self, name):
+        """Simulate a click on a tool
 
-        #some tools may need to capture keypress, but they need to be toggle
-        if self._toggled:
-            instance = self._get_instance(self._toggled)
-            if self.keypresslock.isowner(instance):
-                instance.key_press(event)
-                return
+        This is a convenient method to programatically click on
+        Tools
+        """
+        self._tool_activate(name, None, False)
 
-        name = self._keys.get(event.key, None)
-        if name is None:
-            return
+    def _tool_activate(self, name, event, from_toolbar):
+        if name not in self._tools:
+            raise AttributeError('%s not in Tools' % name)
 
         tool = self._tools[name]
         if tool.toggle:
-            self._handle_toggle(name, event=event)
+            self._handle_toggle(name, event=event, from_toolbar=from_toolbar)
         elif tool.persistent:
             instance = self._get_instance(name)
             instance.activate(event)
@@ -3434,6 +3436,20 @@ def _key_press(self, event):
             #instantiated and forgotten (reminds me an exgirlfriend?)
             tool(self.canvas.figure, event)
 
+    def _key_press(self, event):
+        if event.key is None:
+            return
+
+        #some tools may need to capture keypress, but they need to be toggle
+        if self._toggled:
+            instance = self._get_instance(self._toggled)
+            if self.keypresslock.isowner(instance):
+                instance.key_press(event)
+                return
+
+        name = self._keys.get(event.key, None)
+        self._tool_activate(name, event, False)
+
     def _get_instance(self, name):
         if name not in self._instances:
             instance = self._tools[name](self.canvas.figure)
@@ -3454,14 +3470,7 @@ def _toolbar_callback(self, name):
             Name of the tool that was activated (click) by the user using the
             toolbar
         """
-        tool = self._tools[name]
-        if tool.toggle:
-            self._handle_toggle(name, from_toolbar=True)
-        elif tool.persistent:
-            instance = self._get_instance(name)
-            instance.activate(None)
-        else:
-            tool(self.canvas.figure, None)
+        self._tool_activate(name, None, True)
 
     def _handle_toggle(self, name, event=None, from_toolbar=False):
         #toggle toolbar without callback
