Skip to content

Commit 75bf97b

Browse files
committed
removing unused event class
1 parent d484ebd commit 75bf97b

File tree

2 files changed

+43
-28
lines changed

2 files changed

+43
-28
lines changed

lib/matplotlib/backend_bases.py

+38-26
Original file line numberDiff line numberDiff line change
@@ -3226,27 +3226,38 @@ def set_history_buttons(self):
32263226

32273227

32283228
class ToolEvent(object):
3229-
"""Base event for tool communication"""
3230-
def __init__(self, name, sender):
3229+
"""Event for tool manipulation (add/remove)"""
3230+
def __init__(self, name, sender, tool):
32313231
self.name = name
32323232
self.sender = sender
3233+
self.tool = tool
32333234

32343235

32353236
class ToolTriggerEvent(ToolEvent):
32363237
"""Event to inform that a tool has been triggered"""
3237-
def __init__(self, name, tool, sender, canvasevent=None, data=None):
3238-
ToolEvent.__init__(self, name, sender)
3239-
self.tool = tool
3238+
def __init__(self, name, sender, tool, canvasevent=None, data=None):
3239+
ToolEvent.__init__(self, name, sender, tool)
32403240
self.canvasevent = canvasevent
32413241
self.data = data
32423242

32433243

3244-
class NavigationEvent(ToolEvent):
3245-
"""Event for navigation tool management (add/remove/message)"""
3246-
def __init__(self, name, sender, **kwargs):
3247-
ToolEvent.__init__(self, name, sender)
3248-
for key, value in kwargs.items():
3249-
setattr(self, key, value)
3244+
class ToolAddedEvent(ToolEvent):
3245+
"""Event triggered when a tool is added"""
3246+
def __init__(self, name, sender, tool, group, position):
3247+
ToolEvent.__init__(self, name, sender, tool)
3248+
self.group = group
3249+
self.position = position
3250+
3251+
3252+
class NavigationMessageEvent(object):
3253+
"""Event carring messages from navigation
3254+
3255+
Messages are generaly displayed to the user by the toolbar
3256+
"""
3257+
def __init__(self, name, sender, message):
3258+
self.name = name
3259+
self.sender = sender
3260+
self.message = message
32503261

32513262

32523263
class NavigationBase(object):
@@ -3303,7 +3314,7 @@ def mpl_disconnect(self, cid):
33033314
33043315
Example usage::
33053316
3306-
cid = navigation.mpl_connect('tool-trigger-zoom', on_press)
3317+
cid = navigation.mpl_connect('tool_trigger_zoom', on_press)
33073318
#...later
33083319
navigation.mpl_disconnect(cid)
33093320
"""
@@ -3315,7 +3326,7 @@ def message_event(self, message, sender=None):
33153326
sender = self
33163327

33173328
s = 'tool_message_event'
3318-
event = NavigationEvent(s, sender, message=message)
3329+
event = NavigationMessageEvent(s, sender, message)
33193330
self._callbacks.process(s, event)
33203331

33213332
@property
@@ -3388,7 +3399,7 @@ def remove_tool(self, name):
33883399
self._remove_keys(name)
33893400

33903401
s = 'tool_removed_event'
3391-
event = NavigationEvent(s, self, tool=tool)
3402+
event = ToolEvent(s, self, tool)
33923403
self._callbacks.process(s, event)
33933404

33943405
del self._tools[name]
@@ -3449,28 +3460,28 @@ def add_tool(self, name, tool, group=None, position=None):
34493460

34503461
def _tool_added_event(self, tool, group, position):
34513462
s = 'tool_added_event'
3452-
event = NavigationEvent(s, self,
3453-
tool=tool,
3454-
group=group,
3455-
position=position)
3463+
event = ToolAddedEvent(s, self,
3464+
tool,
3465+
group,
3466+
position)
34563467
self._callbacks.process(s, event)
34573468

3458-
def _handle_toggle(self, name, sender, canvasevent, data):
3469+
def _handle_toggle(self, tool, sender, canvasevent, data):
34593470
# Toggle tools, need to be untoggled before other Toggle tool is used
34603471
# This is called from tool_trigger_event
34613472

3462-
if self._toggled == name:
3473+
if self._toggled == tool.name:
34633474
toggled = None
34643475
elif self._toggled is None:
3465-
toggled = name
3476+
toggled = tool.name
34663477
else:
34673478
# Untoggle previously toggled tool
34683479
self.tool_trigger_event(self._toggled, self, canvasevent, data)
3469-
toggled = name
3480+
toggled = tool.name
34703481

34713482
self._toggled = toggled
3472-
for a in self.canvas.figure.get_axes():
3473-
a.set_navigate_mode(self._toggled)
3483+
# for a in self.canvas.figure.get_axes():
3484+
# a.set_navigate_mode(self._toggled)
34743485

34753486
def _get_cls_to_instantiate(self, callback_class):
34763487
# Find the class that corresponds to the tool
@@ -3512,7 +3523,8 @@ def tool_trigger_event(self, name, sender=None, canvasevent=None,
35123523
self._trigger_tool(name, sender, canvasevent, data)
35133524

35143525
s = 'tool-trigger-%s' % name
3515-
event = ToolTriggerEvent(s, self._tools[name], sender, canvasevent, data)
3526+
event = ToolTriggerEvent(s, sender, self._tools[name], canvasevent,
3527+
data)
35163528
self._callbacks.process(s, event)
35173529

35183530
def _trigger_tool(self, name, sender=None, canvasevent=None, data=None):
@@ -3523,7 +3535,7 @@ def _trigger_tool(self, name, sender=None, canvasevent=None, data=None):
35233535
tool = self._tools[name]
35243536

35253537
if isinstance(tool, tools.ToolToggleBase):
3526-
self._handle_toggle(name, sender, canvasevent, data)
3538+
self._handle_toggle(tool, sender, canvasevent, data)
35273539

35283540
# Important!!!
35293541
# This is where the Tool object is triggered

lib/matplotlib/backend_tools.py

+5-2
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
import numpy as np
1919

2020

21-
class Cursors:
21+
class Cursors(object):
2222
"""Simple namespace for cursor reference"""
2323
HAND, POINTER, SELECT_REGION, MOVE = list(range(4))
2424
cursors = Cursors()
@@ -118,6 +118,9 @@ class ToolToggleBase(ToolBase):
118118
Every time it is triggered, it switches between enable and disable
119119
"""
120120

121+
radio_group = None
122+
"""Attribute to group 'radio' like tools"""
123+
121124
cursor = None
122125
"""Cursor to use when the tool is active"""
123126

@@ -192,7 +195,7 @@ def _tool_trigger_cbk(self, event):
192195

193196
# If the tool is toggleable, set the cursor when the tool is triggered
194197
def _add_tool(self, tool):
195-
if getattr(tool, 'toggled', None) is not None:
198+
if getattr(tool, 'cursor', None) is not None:
196199
self.navigation.mpl_connect('tool-trigger-%s' % tool.name,
197200
self._tool_trigger_cbk)
198201

0 commit comments

Comments
 (0)