<divid="unreleased-message"> You are reading an old version of the documentation (v2.0.0). For the latest version see <ahref="https://matplotlib.org/stable/api/backend_managers_api.html">https://matplotlib.org/stable/api/backend_managers_api.html</a></div>
<dd>Class that makes the bridge between user interaction (key press,
toolbar clicks, ..) and the actions in response to the user inputs.</dd>
</dl>
<dlclass="class">
<dtid="matplotlib.backend_managers.ToolEvent">
<emclass="property">class </em><codeclass="descclassname">matplotlib.backend_managers.</code><codeclass="descname">ToolEvent</code><spanclass="sig-paren">(</span><em>name</em>, <em>sender</em>, <em>tool</em>, <em>data=None</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.backend_managers.ToolEvent" title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">matplotlib.backend_managers.</code><codeclass="descname">ToolManager</code><spanclass="sig-paren">(</span><em>canvas</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.backend_managers.ToolManager" title="Permalink to this definition">¶</a></dt>
<td><codeclass="xref py py-obj docutils literal"><spanclass="pre">LockDraw</span></code> object to know if the <codeclass="xref py py-obj docutils literal"><spanclass="pre">canvas</span></code> key_press_event is locked</td>
<codeclass="descname">active_toggle</code><aclass="headerlink" href="#matplotlib.backend_managers.ToolManager.active_toggle" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">add_tool</code><spanclass="sig-paren">(</span><em>name</em>, <em>tool</em>, <em>*args</em>, <em>**kwargs</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.backend_managers.ToolManager.add_tool" title="Permalink to this definition">¶</a></dt>
<p>If successful adds a new event <codeclass="xref py py-obj docutils literal"><spanclass="pre">tool_trigger_name</span></code> where <strong>name</strong> is
the <strong>name</strong> of the tool, this event is fired everytime
<codeclass="descname">get_tool</code><spanclass="sig-paren">(</span><em>name</em>, <em>warn=True</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.backend_managers.ToolManager.get_tool" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the tool object, also accepts the actual tool for convenience</p>
<codeclass="descname">get_tool_keymap</code><spanclass="sig-paren">(</span><em>name</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.backend_managers.ToolManager.get_tool_keymap" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the keymap associated with the specified tool</p>
<trclass="field-even field"><thclass="field-name">Returns:</th><tdclass="field-body"><pclass="first last"><strong>list</strong> : list of keys associated with the Tool</p>
<codeclass="descname">message_event</code><spanclass="sig-paren">(</span><em>message</em>, <em>sender=None</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.backend_managers.ToolManager.message_event" title="Permalink to this definition">¶</a></dt>
<dd><p>Emit a <aclass="reference internal" href="#matplotlib.backend_managers.ToolManagerMessageEvent" title="matplotlib.backend_managers.ToolManagerMessageEvent"><codeclass="xref py py-obj docutils literal"><spanclass="pre">ToolManagerMessageEvent</span></code></a></p>
<codeclass="descname">remove_tool</code><spanclass="sig-paren">(</span><em>name</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.backend_managers.ToolManager.remove_tool" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">toolmanager_connect</code><spanclass="sig-paren">(</span><em>s</em>, <em>func</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.backend_managers.ToolManager.toolmanager_connect" title="Permalink to this definition">¶</a></dt>
<dd><p>Connect event with string <em>s</em> to <em>func</em>.</p>
<codeclass="descname">toolmanager_disconnect</code><spanclass="sig-paren">(</span><em>cid</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.backend_managers.ToolManager.toolmanager_disconnect" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">tools</code><aclass="headerlink" href="#matplotlib.backend_managers.ToolManager.tools" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the tools controlled by <aclass="reference internal" href="#matplotlib.backend_managers.ToolManager" title="matplotlib.backend_managers.ToolManager"><codeclass="xref py py-obj docutils literal"><spanclass="pre">ToolManager</span></code></a></p>
<codeclass="descname">trigger_tool</code><spanclass="sig-paren">(</span><em>name</em>, <em>sender=None</em>, <em>canvasevent=None</em>, <em>data=None</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.backend_managers.ToolManager.trigger_tool" title="Permalink to this definition">¶</a></dt>
<dd><p>Trigger a tool and emit the tool_trigger_[name] event</p>
<codeclass="descname">update_keymap</code><spanclass="sig-paren">(</span><em>name</em>, <em>*keys</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.backend_managers.ToolManager.update_keymap" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the keymap to associate with the specified tool</p>
<emclass="property">class </em><codeclass="descclassname">matplotlib.backend_managers.</code><codeclass="descname">ToolManagerMessageEvent</code><spanclass="sig-paren">(</span><em>name</em>, <em>sender</em>, <em>message</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.backend_managers.ToolManagerMessageEvent" title="Permalink to this definition">¶</a></dt>