B d4@s^ddlmZmZmZddlmZGdddZGdddeZGdddZ Gd d d Z dS) )_apicbookwidgetsNc@seZdZdZdddZdS) ToolEventz)Event for tool manipulation (add/remove).NcCs||_||_||_||_dS)N)namesendertooldata)selfrrrr r h/work/yifan.wang/ringdown/master-ringdown-env/lib/python3.7/site-packages/matplotlib/backend_managers.py__init__szToolEvent.__init__)N)__name__ __module__ __qualname____doc__r r r r r rsrcs"eZdZdZdfdd ZZS)ToolTriggerEventz/Event to inform that a tool has been triggered.Ncst||||||_dS)N)superr canvasevent)r rrrrr ) __class__r r r szToolTriggerEvent.__init__)NN)rrrrr __classcell__r r )rr rsrc@seZdZdZddZdS)ToolManagerMessageEventzs Event carrying messages from toolmanager. Messages usually get displayed to the user by the toolbar. cCs||_||_||_dS)N)rrmessage)r rrrr r r r sz ToolManagerMessageEvent.__init__N)rrrrr 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 ToolManagera Manager for actions triggered by user interactions (key press, toolbar clicks, ...) on a Figure. Attributes ---------- figure : `.Figure` keypresslock : `~matplotlib.widgets.LockDraw` `.LockDraw` object to know if the `canvas` key_press_event is locked. messagelock : `~matplotlib.widgets.LockDraw` `.LockDraw` object to know if the message is available to write. NcCsJd|_i|_i|_i|_t|_t|_ t|_ d|_ | |dS)N) _key_press_handler_id_tools_keys_toggledrZCallbackRegistry _callbacksrZLockDraw keypresslockZ messagelock_figure set_figure)r figurer r r r /s   zToolManager.__init__cCs|js dS|jjS)z Canvas managed by FigureManager.N)r canvas)r r r r r#?szToolManager.canvascCs|jS)zFigure that holds the canvas.)r )r r r r r"FszToolManager.figurecCs||dS)N)r!)r r"r r r r"KsTcCsR|jr|j|j||_|r0|jd|j|_|rNx|jD] }||_q@WdS)z Bind the given figure to the tools. Parameters ---------- figure : `.Figure` update_tools : bool, default: True Force tools to update figure. Zkey_press_eventN) rr#Zmpl_disconnectr Z mpl_connect _key_pressrvaluesr")r r"Z update_toolsrr r r r!Os  zToolManager.set_figurecCs|j||S)a Connect event with string *s* to *func*. Parameters ---------- s : str The 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 : callable Callback function for the toolmanager event with signature:: def func(event: ToolEvent) -> Any Returns ------- cid The callback id for the connection. This can be used in `.toolmanager_disconnect`. )rconnect)r sfuncr r r toolmanager_connectcszToolManager.toolmanager_connectcCs |j|S)z Disconnect callback id *cid*. Example usage:: cid = toolmanager.toolmanager_connect('tool_trigger_zoom', onpress) #...later toolmanager.toolmanager_disconnect(cid) )rZ disconnect)r Zcidr r r toolmanager_disconnects z"ToolManager.toolmanager_disconnectcCs.|dkr |}d}t|||}|j||dS)z!Emit a `ToolManagerMessageEvent`.NZtool_message_event)rrprocess)r rrr'eventr r r message_events  zToolManager.message_eventcCs|jS)zCurrently toggled tools.)r)r r r r active_toggleszToolManager.active_togglecsfdd|jD}|S)a Return the keymap associated with the specified tool. Parameters ---------- name : str Name of the Tool. Returns ------- list of str List of keys associated with the tool. csg|]\}}|kr|qSr r ).0ki)rr r sz/ToolManager.get_tool_keymap..)ritems)r rkeysr )rr get_tool_keymapszToolManager.get_tool_keymapcCs x||D] }|j|=q WdS)N)r5r)r rr0r r r _remove_keysszToolManager._remove_keysc Csz||jkrt|d||t|tr2|g}xB|D]:}||jkrhtd|d|j|d|||j|<q8WdS)z Set the keymap to associate with the specified tool. Parameters ---------- name : str Name of the Tool. key : str or list of str Keys to associate with the tool. z not in ToolszKey z changed from z to N)rKeyErrorr6 isinstancestrrr warn_external)r rkeyr0r r r update_keymaps     zToolManager.update_keymapcCs^||}|t|ddr*||d||d}t|||}|j|||j|=dS)z Remove tool named *name*. Parameters ---------- name : str Name of the tool. toggledFZ toolmanagerZtool_removed_eventN) get_tooldestroygetattr trigger_toolr6rrr+r)r rrr'r,r r r remove_tools     zToolManager.remove_toolcOs ||}|stdt|||jkr _trigger_toolrrr+)r rrrr rr'r,r r r rAes zToolManager.trigger_toolcCs8||}t|tjr&|||||||||dS)zActually trigger a tool.N)r>r8rFrGrKtrigger)r rrrr rr r r rYs  zToolManager._trigger_toolcCsF|jdks|jrdS|j|jd}|dkr4dS|j||ddS)N)r)r;rlockedrgetrA)r r,rr r r r$s zToolManager._key_presscCs|jS)z,A dict mapping tool name -> controlled tool.)r)r r r r rFszToolManager.toolscCsHt|tjr|j|jkr|S||jkr>|r:td|dS|j|S)a Return the tool object with the given name. For convenience, this passes tool objects through. Parameters ---------- name : str or `.ToolBase` Name of the tool, or the tool itself. warn : bool, default: True Whether a warning should be emitted it no tool with the given name exists. Returns ------- `.ToolBase` or None The tool or None if no tool with the given name exists. z"ToolManager does not control tool N)r8rFZToolBaserrrr:)r rwarnr r r r>s zToolManager.get_tool)N)T)N)NNN)NNN)T)rrrrr propertyr#r"setterr!r)r*r-r.r5r6r<rBrOrLrKrDrArYr$rFr>r r r r r!s.      B-   r) Z matplotlibrrrZmatplotlib.backend_toolsrRrFrrrrr r r r s