MEP22: Navigation by events #3652
moving set_cursor completely out of navigation
- Loading branch information
commit d484ebdde7c74ea64bda4926b7b781b24fb860e0
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -3234,9 +3234,9 @@ def __init__(self, name, sender): | |
|
|
||
| class ToolTriggerEvent(ToolEvent): | ||
| """Event to inform that a tool has been triggered""" | ||
| def __init__(self, name, tool, sender, canvasevent=None, data=None): | ||
| ToolEvent.__init__(self, name, sender) | ||
| self.tool = tool | ||
| self.canvasevent = canvasevent | ||
| self.data = data | ||
|
|
||
|
|
@@ -3254,10 +3254,10 @@ class NavigationBase(object): | |
|
|
||
| Attributes | ||
| ---------- | ||
| manager: `FigureManager` instance | ||
| keypresslock: `LockDraw` to know if the `canvas` key_press_event is | ||
| locked | ||
| messagelock: `LockDraw` to know if the message is available to write | ||
| """ | ||
|
|
||
| def __init__(self, manager): | ||
|
|
@@ -3270,7 +3270,7 @@ def __init__(self, manager): | |
| self._tools = {} | ||
| self._keys = {} | ||
| self._toggled = None | ||
| self._callbacks = cbook.CallbackRegistry() | ||
|
|
||
| # to process keypress event | ||
| self.keypresslock = widgets.LockDraw() | ||
|
|
@@ -3279,22 +3279,24 @@ def __init__(self, manager): | |
| def mpl_connect(self, s, func): | ||
|
There was a problem hiding this comment. Please call this something different to not shadow the same function on the canvas objects. There was a problem hiding this comment. I used the same name, to have a consistent "event" interface. This does not shadow the canvas, this one has to be called specifically on the There was a problem hiding this comment. It doesn't shadow at the code level, but it shadows at the user-brain-space level. I view the consistent interface as a negative as |
||
| """Connect event with string *s* to *func*. | ||
|
|
||
| Parameters | ||
| ----------- | ||
| s : String | ||
| Name of the event | ||
|
|
||
| The following events are recognized | ||
|
|
||
| - 'tool_message_event' | ||
| - 'tool_removed_event' | ||
| - 'tool_added_event' | ||
|
There was a problem hiding this comment. This could be the source of the docs build failure http://docutils.sourceforge.net/docs/user/rst/quickref.html#bullet-lists There was a problem hiding this comment. i.e. add a blank line here. |
||
| For every tool added a new event is created | ||
| - 'tool_trigger_TOOLNAME | ||
| Where TOOLNAME is the id of the tool. | ||
|
There was a problem hiding this comment. Why do we need these tool specific event names? This information gets passed by There was a problem hiding this comment. Indeed we have the |
||
| func : function | ||
| Function to be called with signature | ||
| def func(event) | ||
| """ | ||
| return self._callbacks.connect(s, func) | ||
|
|
||
| def mpl_disconnect(self, cid): | ||
| """Disconnect callback id cid | ||
|
|
@@ -3305,16 +3307,16 @@ def mpl_disconnect(self, cid): | |
| #...later | ||
| navigation.mpl_disconnect(cid) | ||
| """ | ||
| return self._callbacks.disconnect(cid) | ||
|
|
||
| def message_event(self, message, sender=None): | ||
| """ Emit a tool_message_event event""" | ||
|
There was a problem hiding this comment. "tool_message_event" --> ":class: There was a problem hiding this comment. erm, I am not sure. The docstring needs a bit more cross-referencing. |
||
| if sender is None: | ||
| sender = self | ||
|
|
||
| s = 'tool_message_event' | ||
| event = NavigationEvent(s, sender, message=message) | ||
| self._callbacks.process(s, event) | ||
|
|
||
| @property | ||
| def active_toggle(self): | ||
|
|
@@ -3369,7 +3371,7 @@ def set_tool_keymap(self, name, *keys): | |
| self._keys[k] = name | ||
|
|
||
| def remove_tool(self, name): | ||
| """Remove tool from `Navigation` | ||
|
|
||
| Parameters | ||
| ---------- | ||
|
|
@@ -3387,7 +3389,7 @@ def remove_tool(self, name): | |
|
|
||
| s = 'tool_removed_event' | ||
| event = NavigationEvent(s, self, tool=tool) | ||
| self._callbacks.process(s, event) | ||
|
|
||
| del self._tools[name] | ||
|
|
||
|
|
@@ -3396,33 +3398,37 @@ def add_tools(self, tools): | |
|
|
||
| Parameters | ||
| ---------- | ||
| tools : List | ||
| List in the form | ||
| [[group1, [(Tool1, name1), (Tool2, name2) ...]][group2...]] | ||
| where group1 is the name of the group where the | ||
| Tool1, Tool2... are going to be added, and name1, name2... are the | ||
| names of the tools | ||
| """ | ||
|
|
||
| for group, grouptools in tools: | ||
| for position, tool in enumerate(grouptools): | ||
| self.add_tool(tool[1], tool[0], group, position) | ||
|
|
||
| def add_tool(self, name, tool, group=None, position=None): | ||
| """Add tool to `NavigationBase` | ||
|
|
||
| Add a tool to the tools controlled by Navigation | ||
|
|
||
| If successful adds a new event `tool_trigger_name` where **name** is | ||
| the **name** of the tool, this event is fired everytime | ||
| the tool is triggered. | ||
|
|
||
| Parameters | ||
| ---------- | ||
| name : string | ||
| Name of the tool, treated as the ID, has to be unique | ||
| E377 | ||
| tool : string or `matplotlib.backend_tools.ToolBase` derived class | ||
| Reference to find the class of the Tool to be added | ||
| group: String | ||
| Group to position the tool in | ||
| position : int or None (default) | ||
| Position within its group in the toolbar, if None, is positioned at the end | ||
| """ | ||
|
|
||
| tool_cls = self._get_cls_to_instantiate(tool) | ||
|
|
@@ -3447,7 +3453,7 @@ def _tool_added_event(self, tool, group, position): | |
| tool=tool, | ||
| group=group, | ||
| position=position) | ||
| self._callbacks.process(s, event) | ||
|
|
||
| def _handle_toggle(self, name, sender, canvasevent, data): | ||
| # Toggle tools, need to be untoggled before other Toggle tool is used | ||
|
|
@@ -3466,8 +3472,6 @@ def _handle_toggle(self, name, sender, canvasevent, data): | |
| for a in self.canvas.figure.get_axes(): | ||
| a.set_navigate_mode(self._toggled) | ||
|
|
||
| def _get_cls_to_instantiate(self, callback_class): | ||
| # Find the class that corresponds to the tool | ||
| if isinstance(callback_class, six.string_types): | ||
|
|
@@ -3485,17 +3489,17 @@ def _get_cls_to_instantiate(self, callback_class): | |
|
|
||
| def tool_trigger_event(self, name, sender=None, canvasevent=None, | ||
|
There was a problem hiding this comment. This name is a bit too ambiguous, can it be There was a problem hiding this comment. Agree, what do you think of just |
||
| data=None): | ||
| """Trigger a tool and emit the tool-trigger-[name] event | ||
|
There was a problem hiding this comment. shouldn't it be "tool_trigger_[name]"? |
||
|
|
||
| Parameters | ||
| ---------- | ||
| name : string | ||
| Name of the tool | ||
| sender: object | ||
| Object that wish to trigger the tool | ||
| canvasevent : Event | ||
| Original Canvas event or None | ||
| data : Object | ||
| Extra data to pass to the tool when triggering | ||
| """ | ||
| if name not in self._tools: | ||
|
|
@@ -3508,8 +3512,8 @@ def tool_trigger_event(self, name, sender=None, canvasevent=None, | |
| self._trigger_tool(name, sender, canvasevent, data) | ||
|
|
||
| s = 'tool-trigger-%s' % name | ||
| event = ToolTriggerEvent(s, self._tools[name], sender, canvasevent, data) | ||
| self._callbacks.process(s, event) | ||
|
|
||
| def _trigger_tool(self, name, sender=None, canvasevent=None, data=None): | ||
| """Trigger on a tool | ||
|
|
@@ -3534,45 +3538,31 @@ def _key_press(self, event): | |
| return | ||
| self.tool_trigger_event(name, canvasevent=event) | ||
|
|
||
| @property | ||
| def tools(self): | ||
| """Return the tools controlled by `Navigation`""" | ||
|
|
||
| return self._tools | ||
|
|
||
| def get_tool(self, name): | ||
| """Return the tool object | ||
|
|
||
| Parameters | ||
| ----------- | ||
| name : String | ||
| Name of the tool | ||
| """ | ||
| return self._tools[name] | ||
|
|
||
|
|
||
| class ToolbarBase(object): | ||
| """Base class for `Toolbar` implementation | ||
|
|
||
| Attributes | ||
| ---------- | ||
| manager : `FigureManager` object that integrates this `Toolbar` | ||
| navigation : `NavigationBase` object that hold the tools that | ||
| this `Toolbar` wants to communicate with | ||
| """ | ||
|
|
||
| def __init__(self, manager): | ||
|
|
@@ -3596,12 +3586,12 @@ def _tool_triggered_cbk(self, event): | |
| if event.sender is self: | ||
| return | ||
|
|
||
| self.toggle_toolitem(event.tool.name) | ||
|
|
||
| def _add_tool_cbk(self, event): | ||
| """Captures 'tool_added_event' and add the tool to the toolbar""" | ||
| image = self._get_image_filename(event.tool.image) | ||
| toggle = getattr(event.tool, 'toggled', None) is not None | ||
| self.add_toolitem(event.tool.name, | ||
| event.group, | ||
| event.position, | ||
|
|
@@ -3641,6 +3631,8 @@ def trigger_tool(self, name): | |
| def add_toolitem(self, name, group, position, image, description, toggle): | ||
| """Add a toolitem to the toolbar | ||
|
|
||
| This method has to be implemented per backend | ||
|
|
||
| The callback associated with the button click event, | ||
| must be **EXACTLY** `self.trigger_tool(name)` | ||
|
|
||
|
|
@@ -3653,31 +3645,47 @@ def add_toolitem(self, name, group, position, image, description, toggle): | |
| Name of the group that the tool belongs to | ||
| position : Int | ||
| Position of the tool whthin its group if -1 at the End | ||
| image_file : String | ||
| Filename of the image for the button or `None` | ||
| description : String | ||
| Description of the tool, used for the tooltips | ||
| toggle : Bool | ||
| * `True` : The button is a toggle (change the pressed/unpressed | ||
| state between consecutive clicks) | ||
| * `False` : The button is a normal button (returns to unpressed | ||
| state after release) | ||
| """ | ||
|
|
||
| raise NotImplementedError | ||
|
|
||
| def set_message(self, s): | ||
| """Display a message on toolbar or in status bar | ||
|
|
||
| Parameters | ||
| ---------- | ||
| s : String | ||
| Message text | ||
| """ | ||
|
|
||
| pass | ||
|
|
||
| def toggle_toolitem(self, name): | ||
| """Toggle the toolitem without firing event | ||
|
|
||
| Parameters | ||
| ---------- | ||
| name : String | ||
| Id of the tool to toggle | ||
| """ | ||
| raise NotImplementedError | ||
|
|
||
| def remove_toolitem(self, name): | ||
| """Remove a toolitem from the `Toolbar` | ||
|
|
||
| This method has to be implemented per backend | ||
|
|
||
| Called when `tool_removed_event` is emited by `NavigationBase` | ||
|
|
||
| Parameters | ||
| ---------- | ||
| name : string | ||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
Since these are examples, I would suggest getting rid of extraneous commented out code, and also highlight important lines of code such as this one. For example, is it important that it gets called before importing pyplot? What is it for? Perhaps a short docstring at the top of this example would help explain its purpose/goal that it is demonstrating?