U Ev f.@sVddlmZmZmZmZGdddZGdddeZGdddZGdd d Zd S) )_api backend_toolscbookwidgetsc@seZdZdZdddZdS) ToolEventz)Event for tool manipulation (add/remove).NcCs||_||_||_||_dSN)namesendertooldata)selfrr r r r ?/tmp/pip-unpacked-wheel-7vhvci0g/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 rrr src@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@seZdZdZd)ddZeddZeddZejd dZd*d d Z d dZ ddZ d+ddZ eddZ ddZddZddZddZddZdd Zd,d!d"Zd#d$Zed%d&Zd-d'd(ZdS). 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 rr.s   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'EszToolManager.figurecCs||dSr)r%r&r r rr'JsTcCsN|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%Ns 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_connectbszToolManager.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_keysc Csv||jkrt|d||t|tr2|g}|D]:}||jkrftd|d|j|d|||j|<q6dS)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)rKeyErrorr= isinstancestrr r warn_external)r rkeyr6r r r update_keymaps    zToolManager.update_keymapcCsx||}tjtjj|ddd}|dk r.|t|ddrF||d||t d||}|j |j ||j |=dS)z Remove tool named *name*. Parameters ---------- name : str Name of the tool. z3.6Ztool_removed_event)Zsince alternativeNtoggledFZ toolmanager)get_toolrZdeprecate_method_overriderToolBasedestroygetattr trigger_toolr=rr"r1rr)r rr rHr2r r r remove_tools     zToolManager.remove_toolcOstt|j|}|s&tdt|||jkrDtd|j|S|||f||}||j|<|j dk rx| ||j t |tj r|j dkr|jdtn|j|j d|jr||dd||jtd||}|j|j||S)a Add *tool* to `ToolManager`. If successful, adds a new event ``tool_trigger_{name}`` where ``{name}`` is the *name* of the tool; the event is fired every time the tool is triggered. Parameters ---------- name : str Name of the tool, treated as the ID, has to be unique. tool : type Class of the tool to be added. A subclass will be used instead if one was registered for the current canvas class. *args, **kwargs Passed to the *tool*'s constructor. See Also -------- matplotlib.backend_tools.ToolBase : The base class for tools. zImpossible to find class for %sz;A "Tool class" with the same name already exists, not addedNZtool_added_event)rZ_find_tool_classtyper( ValueErrorr@rrrAZdefault_keymaprCr?ToolToggleBase radio_groupr! setdefaultsetrE_handle_toggler%r'rr"r1r)r rr argskwargsZtool_clsZtool_objr2r r radd_tools(         zToolManager.add_toolcCs|j}|dkrH|j|jdkr2|jd|jn|jd|jdS|j||jkr^d}n2|j|dkrt|j}n||j|||||j}||j|<dS)aO Toggle tools, need to untoggle prior to using other Toggle tool. Called from trigger_tool. Parameters ---------- tool : `.ToolBase` canvasevent : Event Original Canvas event or None. data : object Extra data to pass to the tool when triggering. N)rOrr!removeaddrJ)r r rr rOrEr r rrRs" zToolManager._handle_togglecCst||}|dkrdS|dkr"|}t|tjr<||||||||d|}t|||||}|j||dS)a Trigger a tool and emit the ``tool_trigger_{name}`` event. Parameters ---------- name : str Name of the tool. 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. Nztool_trigger_%s) rFr?rrNrRZtriggerrr"r1)r rr rr r r-r2r r rrJFs  zToolManager.trigger_toolcCsF|jdks|jrdS|j|jd}|dkr4dS|j||ddS)N)r)rBr#lockedr getrJ)r r2rr r rr*es zToolManager._key_presscCs|jS)z,A dict mapping tool name -> controlled tool.)rr)r r rtoolsnszToolManager.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)r?rrGrrrrA)r rwarnr r rrFss   zToolManager.get_tool)N)T)N)NNN)T)rrrrrpropertyr(r'setterr%r/r0r3r4r<r=rCrKrUrRrJr*rZrFr r r rr s2       9+   rN) Z matplotlibrrrrrrrrr r r rs