o :a4@s^ddlmZmZmZddlmZGdddZGdddeZGdddZ Gd d d Z dS) )_apicbookwidgetsNc@seZdZdZdddZdS) ToolEventz)Event for tool manipulation (add/remove).NcCs||_||_||_||_dSN)namesendertooldata)selfrrr r r =/usr/lib/python3/dist-packages/matplotlib/backend_managers.py__init__s zToolEvent.__init__r__name__ __module__ __qualname____doc__rr r r r rsrcs"eZdZdZdfdd ZZS)ToolTriggerEventz/Event to inform that a tool has been triggered.Ncst||||||_dSr)superr canvasevent)r rrr rr  __class__r r rs zToolTriggerEvent.__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||_||_||_dSr)rrmessage)r rrrr r r rs z ToolManagerMessageEvent.__init__Nrr r r r rs rc@seZdZdZd/ddZeddZeddZejd dZd0d d Z d dZ ddZ d/ddZ eddZ ddZddZddZddZddZdd Zd!d"Zd#d$Zd1d%d&Zd1d'd(Zd)d*Zed+d,Zd0d-d.ZdS)2 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 r r/s   zToolManager.__init__cCs|jsdS|jjS)z Canvas managed by FigureManager.N)r#canvasr r r r r'?szToolManager.canvascC|jS)zFigure that holds the canvas.)r#r(r r r r&FzToolManager.figurecCs||dSr)r$r%r r r r&KsTcCsR|jr |j|j||_|r|jd|j|_|r%|jD]}||_qdSdS)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 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`. )r!Zconnect)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) )r!Z disconnect)r Zcidr r r toolmanager_disconnects z"ToolManager.toolmanager_disconnectcCs.|dur|}d}t|||}|j||dS)z!Emit a `ToolManagerMessageEvent`.NZtool_message_event)rr!process)r rrr-eventr r r message_events  zToolManager.message_eventcCr))zCurrently toggled tools.)r r(r r r active_toggler*zToolManager.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..)ritems)r rkeysr r8r get_tool_keymapszToolManager.get_tool_keymapcCs||D]}|j|=qdSr)r<r)r rr6r r r _remove_keyss zToolManager._remove_keysc Csv||jvr t|d||t|tr|g}|D]}||jvr3td|d|j|d|||j|<qdS)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= isinstancestrrr warn_external)r rkeyr6r 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_toolZdestroygetattr trigger_toolr=rr!r1r)r rr r-r2r r r remove_tools      zToolManager.remove_toolcOs||}|stdt|||jvrtd|j|S|dkr7|tjkr7tjdd|j d|j dd|||g|Ri|}||j|<|j d urT| ||j t |tjr{|jd urh|jd tn|j|jd |jr{||d d d ||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 : class_like, i.e. str or type Reference to find the class of the Tool to added. Notes ----- args and kwargs get passed directly to the tools 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 addedZcursorz3.5zOverriding ToolSetCursor with z was only necessary to provide the .set_cursor() method, which is deprecated since %(since)s and will be removed %(removal)s. Please report this to the z author.)rN)_get_cls_to_instantiate ValueErrorr@rrrAtoolsZ SetCursorBaseZwarn_deprecatedrrZdefault_keymaprCr?ToolToggleBase radio_groupr setdefaultsetrD_handle_toggler$r&_tool_added_event)r rr argskwargsZtool_clsZtool_objr r r add_tools6          zToolManager.add_toolcCs"d}t|||}|j||dS)NZtool_added_event)rr!r1)r r r-r2r r r rQ"s zToolManager._tool_added_eventcCs|j}|dur%|j|jdvr|jd|jdS|jd|jdS|j||jkr0d}n|j|dur;|j}n||j|||||j}||j|<dS)a Toggle tools, need to untoggle prior to using other Toggle tool. Called from trigger_tool. Parameters ---------- tool : `.ToolBase` 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. N)rMrr removeaddrG)r r rrr rMrDr r r rP's$ zToolManager._handle_togglecCsVt|tr#|tvrt|}nd}t|tt|gd}t||d}t|r)|SdS)N backend_toolsF)r?r@globals __import__localsrFcallable)r Zcallback_classmodZcurrent_moduler r r rITs    z#ToolManager._get_cls_to_instantiatecCs\||}|dur dS|dur|}|||||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)rE _trigger_toolrr!r1)r rrrr r r-r2r r r rGes zToolManager.trigger_toolcCs8||}t|tjr|||||||||dS)zActually trigger a tool.N)rEr?rKrLrPZtrigger)r rrrr r r r r r^s  zToolManager._trigger_toolcCsF|jdus |jr dS|j|jd}|durdS|j||ddS)N)r)rBr"lockedrgetrG)r r2rr r r r+s zToolManager._key_presscCr))z,A dict mapping tool name -> controlled tool.)rr(r r r rKr*zToolManager.toolscCsHt|tjr|j|jvr|S||jvr|rtd|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?rKZToolBaserrrrA)r rwarnr r r rEs  zToolManager.get_toolr)T)NNN)rrrrrpropertyr'r&setterr$r/r0r3r4r<r=rCrHrTrQrPrIrGr^r+rKrEr r r r r!s:       B-    r) Z matplotlibrrrZmatplotlib.backend_toolsrWrKrrrrr r r r s