MEP22: Navigation by events #3652
- Loading branch information
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2586,6 +2586,8 @@ def __init__(self, canvas, num): | |
| self.key_press_handler_id = self.canvas.mpl_connect( | ||
| 'key_press_event', | ||
| self.key_press) | ||
|
Member
There was a problem hiding this comment. Should
Member
Author
There was a problem hiding this comment. Eventually
Member
There was a problem hiding this comment. I am torn on this one, I see @fariza point that this is on it's way out, but I also don't like variable attributes on objects (just because you can doesn't mean you should). On the other hand, this is the only place in our code base that we reference This would only be used to deregister a call back, does that code cope well with
Member
There was a problem hiding this comment. This was added to make it possible for users to disable the default keymap
Member
Author
There was a problem hiding this comment. done, I added the |
||
| else: | ||
| self.key_press_handler_id = None | ||
| """ | ||
| The returned id from connecting the default key handler via | ||
| :meth:`FigureCanvasBase.mpl_connnect`. | ||
|
|
@@ -3331,11 +3333,7 @@ def message_event(self, message, sender=None): | |
|
|
||
| @property | ||
| def active_toggle(self): | ||
| """Currently toggled tools""" | ||
|
|
||
| return self._toggled | ||
|
|
||
|
|
@@ -3360,7 +3358,7 @@ def _remove_keys(self, name): | |
| for k in self.get_tool_keymap(name): | ||
| del self._keys[k] | ||
|
|
||
| def update_keymap(self, name, *keys): | ||
| """ | ||
| Set the keymap to associate with the specified tool | ||
|
Member
There was a problem hiding this comment. Can you clarify this a bit. This is setting a property of
Member
Author
There was a problem hiding this comment. What do you think of renaming to
Member
There was a problem hiding this comment. How about It might also be worth adding a
Member
Author
There was a problem hiding this comment. rename done, not sure about
Member
There was a problem hiding this comment. is this done and not pushed? I am not seeing the code change....
Member
Author
There was a problem hiding this comment. I am finishing all the current comments and push the commit, give me 5 😉 |
||
|
|
||
|
|
@@ -3449,30 +3447,31 @@ def add_tool(self, name, tool, *args, **kwargs): | |
| """ | ||
|
|
||
| tool_cls = self._get_cls_to_instantiate(tool) | ||
| if not tool_cls: | ||
| raise ValueError('Impossible to find class for %s' % str(tool)) | ||
|
|
||
| if name in self._tools: | ||
|
Member
There was a problem hiding this comment. Should this be done first in this function? Do we want to check to make sure that they are the same type? Again, why warn rather than raise?
Member
Author
There was a problem hiding this comment. I used warn because i don't think that adding twice the same tool represents a major fault and your program will keep working as expected (you already have the tool) |
||
| warnings.warn('A "Tool class" with the same name already exists, ' | ||
| 'not added') | ||
| return self._tools[name] | ||
|
|
||
| tool_obj = tool_cls(self, name, *args, **kwargs) | ||
| self._tools[name] = tool_obj | ||
|
|
||
| if tool_cls.default_keymap is not None: | ||
| self.update_keymap(name, tool_cls.default_keymap) | ||
|
|
||
| # For toggle tools init the radio_group in self._toggled | ||
| if isinstance(tool_obj, tools.ToolToggleBase): | ||
| # None group is not mutually exclusive, a set is used to keep track | ||
| # of all toggled tools in this group | ||
| if tool_obj.radio_group is None: | ||
| self._toggled.setdefault(None, set()) | ||
| else: | ||
| self._toggled.setdefault(tool_obj.radio_group, None) | ||
|
|
||
| self._tool_added_event(tool_obj) | ||
| return tool_obj | ||
|
|
||
| def _tool_added_event(self, tool): | ||
| s = 'tool_added_event' | ||
|
|
@@ -3483,6 +3482,16 @@ def _handle_toggle(self, tool, sender, canvasevent, data): | |
| """ | ||
|
Member
There was a problem hiding this comment. Can you put docstrings on these with the expected types? |
||
| Toggle tools, need to untoggle prior to using other Toggle tool | ||
| Called from tool_trigger_event | ||
|
|
||
| Parameters | ||
| ---------- | ||
| tool: Tool object | ||
| sender: object | ||
| Object that wishes to trigger the tool | ||
| canvasevent : Event | ||
| Original Canvas event or None | ||
| data : Object | ||
| Extra data to pass to the tool when triggering | ||
| """ | ||
|
|
||
| radio_group = tool.radio_group | ||
|
|
@@ -3500,7 +3509,7 @@ def _handle_toggle(self, tool, sender, canvasevent, data): | |
| toggled = None | ||
| # If no tool was toggled in the radio_group | ||
| # toggle it | ||
| elif self._toggled[radio_group] is None: | ||
| toggled = tool.name | ||
| # Other tool in the radio_group is toggled | ||
| else: | ||
|
|
@@ -3521,15 +3530,18 @@ def _get_cls_to_instantiate(self, callback_class): | |
| if isinstance(callback_class, six.string_types): | ||
| # FIXME: make more complete searching structure | ||
| if callback_class in globals(): | ||
| callback_class = globals()[callback_class] | ||
| else: | ||
| mod = self.__class__.__module__ | ||
| current_module = __import__(mod, | ||
| globals(), locals(), [mod], 0) | ||
|
|
||
| callback_class = getattr(current_module, callback_class, False) | ||
|
|
||
| if callable(callback_class): | ||
| return callback_class | ||
| else: | ||
| return None | ||
|
|
||
| def tool_trigger_event(self, name, sender=None, canvasevent=None, | ||
|
Member
There was a problem hiding this comment. This name is a bit too ambiguous, can it be
Member
Author
There was a problem hiding this comment. Agree, what do you think of just |
||
| data=None): | ||
|
|
@@ -3598,7 +3610,7 @@ def get_tool(self, name, warn=True): | |
| ----------- | ||
| name : str, ToolBase | ||
| Name of the tool, or the tool itself | ||
| warn : bool, optional | ||
| If this method should give warnings. | ||
| """ | ||
| if isinstance(name, tools.ToolBase) and name.name in self._tools: | ||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
same here, should be a class docstring