B ]t\2@sdZddlZddlmZddlmZddlmZddlm Z Gddde Z Gddde Z Gdd d e ZGd d d e ZdS) z `ToolManager` Class that makes the bridge between user interaction (key press, toolbar clicks, ..) and the actions in response to the user inputs. N)validate_stringlistc@seZdZdZdddZdS) ToolEventz(Event for tool manipulation (add/remove)NcCs||_||_||_||_dS)N)namesendertooldata)selfrrrrr :lib/python3.7/site-packages/matplotlib/backend_managers.py__init__szToolEvent.__init__)N)__name__ __module__ __qualname____doc__r r r r r rsrc@seZdZdZdddZdS)ToolTriggerEventz.Event to inform that a tool has been triggeredNcCst|||||||_dS)N)rr canvasevent)rrrrrrr r r r szToolTriggerEvent.__init__)NN)r r rrr r r r r rsrc@seZdZdZddZdS)ToolManagerMessageEventzq Event carrying messages from toolmanager Messages usually get displayed to the user by the toolbar cCs||_||_||_dS)N)rrmessage)rrrrr r r r %sz ToolManagerMessageEvent.__init__N)r r rrr r r r r rsrc@seZdZdZd/ddZeddZeddZejd dZd0d d Z d dZ ddZ d1ddZ eddZ ddZddZddZddZddZdd Zd!d"Zd#d$Zd2d%d&Zd3d'd(Zd)d*Zed+d,Zd4d-d.ZdS)5 ToolManageraZ Helper class that groups all the user interactions for a Figure. Attributes ---------- figure: `Figure` keypresslock: `widgets.LockDraw` `LockDraw` object to know if the `canvas` key_press_event is locked messagelock: `widgets.LockDraw` `LockDraw` object to know if the message is available to write NcCsTtdd|_i|_i|_i|_t|_t |_ t |_ d|_ ||dS)NzTreat the new Tool classes introduced in v1.5 as experimental for now, the API will likely change in version 2.1 and perhaps the rcParam as well)warningswarn_key_press_handler_id_tools_keys_toggledcbookZCallbackRegistry _callbackswidgetsZLockDraw keypresslockZ messagelock_figure set_figure)rfigurer r r r 8s   zToolManager.__init__cCs|js dS|jjS)zCanvas managed by FigureManagerN)rcanvas)rr r r r"KszToolManager.canvascCs|jS)zFigure that holds the canvas)r)rr r r r!RszToolManager.figurecCs||dS)N)r )rr!r r r r!WsTcCsR|jr|j|j||_|r0|jd|j|_|rNx|jD] }||_q@WdS)z Bind the given figure to the tools. Parameters ---------- figure : `.Figure` update_tools : bool Force tools to update figure Zkey_press_eventN) rr"Zmpl_disconnectrZ mpl_connect _key_pressrvaluesr!)rr!Z update_toolsrr r r r [s  zToolManager.set_figurecCs|j||S)a% 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' For every tool added a new event is created - 'tool_trigger_TOOLNAME` Where TOOLNAME is the id of the tool. func : function Function to be called with signature def func(event) )rZconnect)rsfuncr r r toolmanager_connectoszToolManager.toolmanager_connectcCs |j|S)a Disconnect callback id *cid* Example usage:: cid = toolmanager.toolmanager_connect('tool_trigger_zoom', on_press) #...later toolmanager.toolmanager_disconnect(cid) )rZ disconnect)rZcidr r r toolmanager_disconnects z"ToolManager.toolmanager_disconnectcCs.|dkr |}d}t|||}|j||dS)z! Emit a `ToolManagerMessageEvent`NZtool_message_event)rrprocess)rrrr%eventr r r message_events  zToolManager.message_eventcCs|jS)zCurrently toggled tools)r)rr r r active_toggleszToolManager.active_togglecsfdd|jD}|S)z Get the keymap associated with the specified tool Parameters ---------- name : string Name of the Tool Returns ------- list : list of keys associated with the Tool csg|]\}}|kr|qSr r ).0ki)rr r sz/ToolManager.get_tool_keymap..)ritems)rrkeysr )rr get_tool_keymapszToolManager.get_tool_keymapcCs x||D] }|j|=q WdS)N)r3r)rrr.r r r _remove_keysszToolManager._remove_keyscGsr||jkrtd|||xL|D]D}x>t|D]2}||jkr\td||j||f||j|<q4Wq&WdS)z Set the keymap to associate with the specified tool Parameters ---------- name : string Name of the Tool keys : keys to associate with the Tool z%s not in ToolszKey %s changed from %s to %sN)rKeyErrorr4rrrr)rrr2keyr.r r r update_keymaps     zToolManager.update_keymapcCs^||}|t|ddr*||d||d}t|||}|j|||j|=dS)z Remove tool from `ToolManager` Parameters ---------- name : string Name of the Tool toggledFZ toolmanagerZtool_removed_eventN) get_toolZdestroygetattr trigger_toolr4rrr)r)rrrr%r*r r r remove_tools     zToolManager.remove_toolcOs||}|stdt|||jkrs