3 ƽh#6@szddlZddljZddljZddlmZddljZ ej e Z GdddZ Gddde ZGdddZGd d d ZdS) N)validate_stringlistc@seZdZdZdddZdS) ToolEventz)Event for tool manipulation (add/remove).NcCs||_||_||_||_dS)N)namesendertooldata)selfrrrrr A/tmp/pip-build-7iwl8md4/matplotlib/matplotlib/backend_managers.py__init__ szToolEvent.__init__)N)__name__ __module__ __qualname____doc__r r r r r r src@seZdZdZdddZdS)ToolTriggerEventz/Event to inform that a tool has been triggered.NcCstj|||||||_dS)N)rr canvasevent)rrrrrrr r r r szToolTriggerEvent.__init__)NN)r r rrr r r r r rsrc@seZdZdZddZdS)ToolManagerMessageEventzs 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@seZdZdZd1ddZeddZeddZejd dZd2d d Z d dZ ddZ d3ddZ eddZ ddZddZejddddZddZdd 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. NcCsTtjdd|_i|_i|_i|_tj|_t j |_ t j |_ d|_ |j|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)_logwarning_key_press_handler_id_tools_keys_toggledcbookZCallbackRegistry _callbackswidgetsZLockDraw keypresslockZ messagelock_figure set_figure)rfigurer r r r 5s    zToolManager.__init__cCs|js dS|jjS)z Canvas managed by FigureManager.N)rcanvas)rr r r r"HszToolManager.canvascCs|jS)zFigure that holds the canvas.)r)rr r r r!OszToolManager.figurecCs|j|dS)N)r )rr!r r r r!TsTcCsR|jr|jj|j||_|r0|jjd|j|_|rNx|jjD] }||_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_disconnectrZ mpl_connect _key_pressrvaluesr!)rr!Z update_toolsrr r r r Xs  zToolManager.set_figurecCs|jj||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)rsfuncr r r toolmanager_connectlszToolManager.toolmanager_connectcCs |jj|S)z Disconnect callback id *cid*. Example usage:: cid = toolmanager.toolmanager_connect('tool_trigger_zoom', onpress) #...later toolmanager.toolmanager_disconnect(cid) )rZ disconnect)rZcidr r r toolmanager_disconnects z"ToolManager.toolmanager_disconnectcCs.|dkr |}d}t|||}|jj||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|jjD}|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)rrkeysr )rr get_tool_keymapszToolManager.get_tool_keymapcCs x|j|D] }|j|=q WdS)N)r4r)rrr/r r r _remove_keysszToolManager._remove_keysz3.3argscGs||jkrtd||j|x|f|D]~}t|tr^t||gkr^tjdddt|}t|trn|g}x:|D]2}||jkrtj d||j||f||j|<qtWq,WdS)z Set the keymap to associate with the specified tool. Parameters ---------- name : str Name of the Tool. keys : str or list of str Keys to associate with the tool. z%s not in Toolsz3.3zPassing 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 %s changed from %s to %sN) rKeyErrorr5 isinstancestrrrwarn_deprecatedr_warn_external)rrkeyr6r/r r r update_keymaps       zToolManager.update_keymapcCs^|j|}|jt|ddr*|j|d|j|d}t|||}|jj|||j|=dS)z Remove tool named *name*. Parameters ---------- name : str Name of the tool. toggledFZ toolmanagerZtool_removed_eventN) get_tooldestroygetattr trigger_toolr5rrr*r)rrrr&r+r r r remove_tools     zToolManager.remove_toolcOs|j|}|stdt|||jkr_handle_toggler r!_tool_added_event)rrrr6kwargsZtool_clsZtool_objr r r add_tools&          zToolManager.add_toolcCs"d}t|||}|jj||dS)NZtool_added_event)rrr*)rrr&r+r r r rL*s zToolManager._tool_added_eventcCs|j}|dkrH|j|jdkr2|jdj|jn|jdj|jdS|j||jkr^d}n2|j|dkrt|j}n|j|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)rHrrremoveaddrB)rrrrrrHr>r r r rK/s  zToolManager._handle_togglecCsZt|trF|tkr t|}n&d}t|tt|gd}t||d}t|rR|SdSdS)N backend_toolsF)r8r9globals __import__localsrAcallable)rZcallback_classmodZcurrent_moduler r r rD\s    z#ToolManager._get_cls_to_instantiatecCs\|j|}|dkrdS|dkr"|}|j||||d|}t|||||}|jj||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)r? _trigger_toolrrr*)rrrrrrr&r+r r r rBms zToolManager.trigger_toolcCs8|j|}t|tjr&|j|||||j|||dS)zActually trigger a tool.N)r?r8rFrGrKZtrigger)rrrrrrr r r rXs  zToolManager._trigger_toolcCsF|jdks|jjrdS|jj|jd}|dkr4dS|j||ddS)N)r)r<rlockedrgetrB)rr+rr r r r#s zToolManager._key_presscCs|jS)z,A dict mapping tool name -> controlled tool.)r)rr r r rFszToolManager.toolscCsFt|tjr|j|jkr|S||jkr<|r8tjd|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 %sN)r8rFZToolBaserrrr;)rrwarnr r r r?s zToolManager.get_tool)N)T)N)NNN)NNN)T)r r rrr propertyr"r!setterr r(r)r,r-r4r5rZ_delete_parameterr=rCrNrLrKrDrBrXr#rFr?r r r r r's.      8-   r)loggingZmatplotlib.cbookrZmatplotlib.widgetsrZmatplotlib.rcsetuprZmatplotlib.backend_toolsrQrF getLoggerr rrrrrr r r r s