Skip to content

Add on_toggle method instead of enable/disable in ToolToggleBase #18332

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

Add on_toggle method instead of enable/disable in ToolToggleBase #18332

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
32b979b
Add on_toggle instead of enable/disable
Ptrskay3 Aug 23, 2020
543f189
Merge branch 'master' of git://github.com/matplotlib/matplotlib into …
Ptrskay3 Aug 25, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
91 changes: 59 additions & 32 deletions lib/matplotlib/backend_tools.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -190,13 +190,42 @@ def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)

def trigger(self, sender, event, data=None):
"""Calls `enable` or `disable` based on `toggled` value."""
if self._toggled:
self.disable(event)
"""Calls `on_toggle` if `toggled` changes."""
self.on_toggle(self._toggled, event)

if not self._toggled:
enable = cbook._deprecate_method_override(
__class__.enable, self, since="3.3", message="Calling an "
"overridden enable() at ToolToggleBase is deprecated since "
"%(since)s; override on_toggle() instead."
)
if enable is not None:
enable(event)
else:
self.enable(event)
disable = cbook._deprecate_method_override(
__class__.disable, self, since="3.3", message="Calling an "
"overridden disable() at ToolToggleBase is deprecated since "
"%(since)s; override on_toggle() instead."
)
if disable is not None:
disable(event)

self._toggled = not self._toggled

def on_toggle(self, state, event=None):
"""
Call this function whenever `toggled` changes.

Parameters
----------
state : bool
Whether the state of `toggled` is True.
event : `.Event`
The canvas event that caused this tool to be called.
"""
pass

@cbook.deprecated("3.3")
def enable(self, event=None):
"""
Enable the toggle tool.
Expand All @@ -205,6 +234,7 @@ def enable(self, event=None):
"""
pass

@cbook.deprecated("3.3")
def disable(self, event=None):
"""
Disable the toggle tool.
Expand Down Expand Up @@ -460,10 +490,7 @@ class ToolFullScreen(ToolToggleBase):
description = 'Toggle fullscreen mode'
default_keymap = mpl.rcParams['keymap.fullscreen']

def enable(self, event):
self.figure.canvas.manager.full_screen_toggle()

def disable(self, event):
def on_toggle(self, state, event):
self.figure.canvas.manager.full_screen_toggle()


Expand All @@ -475,13 +502,13 @@ def trigger(self, sender, event, data=None):
return
super().trigger(sender, event, data)

def enable(self, event):
self.set_scale(event.inaxes, 'log')
self.figure.canvas.draw_idle()

def disable(self, event):
self.set_scale(event.inaxes, 'linear')
self.figure.canvas.draw_idle()
def on_toggle(self, state, event):
if not state:
self.set_scale(event.inaxes, 'log')
self.figure.canvas.draw_idle()
else:
self.set_scale(event.inaxes, 'linear')
self.figure.canvas.draw_idle()


class ToolYScale(AxisScaleBase):
Expand Down Expand Up @@ -729,23 +756,23 @@ def __init__(self, *args):
self.scrollthresh = .5 # .5 second scroll threshold
self.lastscroll = time.time()-self.scrollthresh

def enable(self, event):
"""Connect press/release events and lock the canvas."""
self.figure.canvas.widgetlock(self)
self._idPress = self.figure.canvas.mpl_connect(
'button_press_event', self._press)
self._idRelease = self.figure.canvas.mpl_connect(
'button_release_event', self._release)
self._idScroll = self.figure.canvas.mpl_connect(
'scroll_event', self.scroll_zoom)

def disable(self, event):
"""Release the canvas and disconnect press/release events."""
self._cancel_action()
self.figure.canvas.widgetlock.release(self)
self.figure.canvas.mpl_disconnect(self._idPress)
self.figure.canvas.mpl_disconnect(self._idRelease)
self.figure.canvas.mpl_disconnect(self._idScroll)
def on_toggle(self, state, event):
if not state:
# Connect press/release events and lock the canvas.
self.figure.canvas.widgetlock(self)
self._idPress = self.figure.canvas.mpl_connect(
'button_press_event', self._press)
self._idRelease = self.figure.canvas.mpl_connect(
'button_release_event', self._release)
self._idScroll = self.figure.canvas.mpl_connect(
'scroll_event', self.scroll_zoom)
else:
# Release the canvas and disconnect press/release events.
self._cancel_action()
self.figure.canvas.widgetlock.release(self)
self.figure.canvas.mpl_disconnect(self._idPress)
self.figure.canvas.mpl_disconnect(self._idRelease)
self.figure.canvas.mpl_disconnect(self._idScroll)

def trigger(self, sender, event, data=None):
self.toolmanager.get_tool(_views_positions).add_figure(self.figure)
Expand Down