U \ a4@sjddlmZmZmZddlmZddlmZGdddZ Gddde Z Gdd d Z Gd d d Z dS) )_apicbookwidgets)validate_stringlistNc@seZdZdZdddZdS) ToolEventz)Event for tool manipulation (add/remove).NcCs||_||_||_||_dSN)namesendertooldata)selfrr r r r ?/tmp/pip-unpacked-wheel-wjyw_3jo/matplotlib/backend_managers.py__init__szToolEvent.__init__)N__name__ __module__ __qualname____doc__rr r r rrsrcs"eZdZdZdfdd ZZS)ToolTriggerEventz/Event to inform that a tool has been triggered.Ncst||||||_dSr)superr canvasevent)r rr r rr  __class__r rrszToolTriggerEvent.__init__)NN)rrrrr __classcell__r r rrrsrc@seZdZdZddZdS)ToolManagerMessageEventzs Event carrying messages from toolmanager. Messages usually get displayed to the user by the toolbar. cCs||_||_||_dSr)rr message)r rr rr r rrsz ToolManagerMessageEvent.__init__Nrr r r rrsrc@seZdZdZd1ddZeddZeddZejd dZd2d d Z d dZ ddZ d3ddZ eddZ ddZddZeddddZddZdd Zd!d"Zd#d$Zd%d&Zd4d'd(Zd5d)d*Zd+d,Zed-d.Zd6d/d0ZdS)7 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|_ | |dSr) _key_press_handler_id_tools_keys_toggledrZCallbackRegistry _callbacksrZLockDraw keypresslockZ messagelock_figure set_figurer figurer r rr0s   zToolManager.__init__cCs|js dS|jjS)z Canvas managed by FigureManager.N)r$canvasr r r rr(@szToolManager.canvascCs|jS)zFigure that holds the canvas.)r$r)r r rr'GszToolManager.figurecCs||dSr)r%r&r r rr'LsTcCsN|jr|j|j||_|r0|jd|j|_|rJ|jD] }||_q>dS)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_toolsr r r rr%Ps 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`. )r"connect)r sfuncr r rtoolmanager_connectdszToolManager.toolmanager_connectcCs |j|S)z Disconnect callback id *cid*. Example usage:: cid = toolmanager.toolmanager_connect('tool_trigger_zoom', onpress) #...later toolmanager.toolmanager_disconnect(cid) )r"Z disconnect)r Zcidr r rtoolmanager_disconnects z"ToolManager.toolmanager_disconnectcCs.|dkr |}d}t|||}|j||dS)z!Emit a `ToolManagerMessageEvent`.NZtool_message_event)rr"process)r rr r-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 ).0kirr r sz/ToolManager.get_tool_keymap..)r items)r rkeysr r8rget_tool_keymapszToolManager.get_tool_keymapcCs||D] }|j|=q dSr)r<r )r rr6r r r _remove_keysszToolManager._remove_keys3.3argsc Gs||jkrtd||||f|D]}t|tr\t||gkr\tjdddt|}t|trl|g}|D]:}||jkrt d|d|j|d|||j|<qpq*dS) 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%s not in Toolsr>zPassing a list of keys as a single comma-separated string is deprecated since %(since)s and support will be removed %(removal)s; pass keys as a list of strings instead.)rzKey z changed from z to N) rKeyErrorr= isinstancestrrrZwarn_deprecatedr warn_external)r rkeyr?r6r 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_toolr=rr"r1r)r rr r-r2r r r remove_tools     zToolManager.remove_toolcOs||}|stdt|||jkr controlled tool.)rr)r r rrNszToolManager.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)rArNZToolBaserrrrC)r rwarnr r rrGs zToolManager.get_tool)N)T)N)NNN)NNN)T)rrrrrpropertyr(r'setterr%r/r0r3r4r<r=rZdelete_parameterrErKrVrTrSrLrJr`r*rNrGr r r rr"s:         8-    r) Z matplotlibrrrZmatplotlib.rcsetuprZmatplotlib.backend_toolsrYrNrrrrr r r rs