Merge pull request matplotlib#4225 from JayP16/JayP16-patch-1

ENH/API : Provide way to disable MultiCursor, move enable logic to Widget

Author: tacaswell

doc/users/whats_new/updated_widgets.rst

@@ -0,0 +1,10 @@
+Moved ``ignore``, ``set_active``, and ``get_active`` methods to base class ``Widget``
+`````````````````````````````````````````````````````````````````````````````````
+Pushes up duplicate methods in child class to parent class to avoid duplication of code.
+
+
+Adds enable/disable feature to MultiCursor
+``````````````````````````````````````````
+A MultiCursor object can be disabled (and enabled) after it has been created without destroying the object. 
+Example:
+        multi_cursor.active = False

lib/matplotlib/widgets.py

@@ -68,6 +68,29 @@ class Widget(object):
     """
     drawon = True
     eventson = True
+    _active = True
+
+    def set_active(self, active):
+        """Set whether the widget is active.
+        """
+        self._active = active
+
+    def get_active(self):
+        """Get whether the widget is active.
+        """
+        return self._active
+
+    # set_active is overriden by SelectorWidgets.
+    active = property(get_active, lambda self, active: self.set_active(active),
+                      doc="Is the widget active?")
+                      
+    def ignore(self, event):
+        """Return True if event should be ignored.
+
+        This method (or a version of it) should be called at the beginning
+        of any event callback.
+        """
+        return not self.active
 
 
 class AxesWidget(Widget):
@@ -96,7 +119,6 @@ def __init__(self, ax):
         self.ax = ax
         self.canvas = ax.figure.canvas
         self.cids = []
-        self._active = True
 
     def connect_event(self, event, callback):
         """Connect callback with an event.
@@ -112,28 +134,6 @@ def disconnect_events(self):
         for c in self.cids:
             self.canvas.mpl_disconnect(c)
 
-    def set_active(self, active):
-        """Set whether the widget is active.
-        """
-        self._active = active
-
-    def get_active(self):
-        """Get whether the widget is active.
-        """
-        return self._active
-
-    # set_active is overriden by SelectorWidgets.
-    active = property(get_active, lambda self, active: self.set_active(active),
-                      doc="Is the widget active?")
-
-    def ignore(self, event):
-        """Return True if event should be ignored.
-
-        This method (or a version of it) should be called at the beginning
-        of any event callback.
-        """
-        return not self.active
-
 
 class Button(AxesWidget):
     """
@@ -1090,13 +1090,17 @@ def disconnect(self):
 
     def clear(self, event):
         """clear the cursor"""
+        if self.ignore(event):
+            return        
         if self.useblit:
             self.background = (
                 self.canvas.copy_from_bbox(self.canvas.figure.bbox))
         for line in self.vlines + self.hlines:
             line.set_visible(False)
 
     def onmove(self, event):
+        if self.ignore(event):
+            return        
         if event.inaxes is None:
             return
         if not self.canvas.widgetlock.available(self):
@@ -1126,7 +1130,6 @@ def _update(self):
                     ax.draw_artist(line)
             self.canvas.blit(self.canvas.figure.bbox)
         else:
-
             self.canvas.draw_idle()