-
Notifications
You must be signed in to change notification settings - Fork 60
Expand file tree
/
Copy pathbackend_managers.html
More file actions
575 lines (464 loc) · 54.5 KB
/
backend_managers.html
File metadata and controls
575 lines (464 loc) · 54.5 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>matplotlib.backend_managers — Matplotlib 2.2.5 documentation</title>
<link rel="stylesheet" href="../../_static/mpl.css"
type="text/css" />
<link rel="stylesheet" href="../../_static/pygments.css"
type="text/css" />
<link rel="stylesheet" href="../../_static/graphviz.css" type="text/css" />
<link rel="stylesheet" href="../../_static/gallery.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../../',
VERSION: '2.2.5',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../../_static/jquery.js"></script>
<script type="text/javascript" src="../../_static/underscore.js"></script>
<script type="text/javascript" src="../../_static/doctools.js"></script>
<script type="text/javascript" src="../../_static/language_data.js"></script>
<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
<link rel="search" type="application/opensearchdescription+xml"
title="Search within Matplotlib 2.2.5 documentation"
href="../../_static/opensearch.xml"/>
<link rel="shortcut icon" href="../../_static/favicon.ico"/>
<link rel="index" title="Index" href="../../genindex.html"
/>
<link rel="search" title="Search" href="../../search.html"
/>
<link rel="top" title="Matplotlib 2.2.5 documentation" href="../../index.html" />
<link rel="up" title="matplotlib" href="../matplotlib.html" />
<link rel="canonical" href="https://matplotlib.org/3.4.3/_modules/matplotlib/backend_managers.html" />
<script data-domain="matplotlib.org" defer="defer" src="https://views.scientific-python.org/js/script.js"></script>
</head>
<body>
<div id="unreleased-message"> You are reading an old version of the documentation (v2.2.5). For the latest version see <a href="/stable/">https://matplotlib.org/stable/</a> </div>
<div style="background-color: white; text-align: left; padding: 10px 10px 15px 15px; position: relative;">
<a href="../../index.html">
<div style="float: left; position: absolute; width: 496px; bottom: 0; padding-bottom: 24px"><span style="float: right; color: #789; background: white">Version 2.2.5</span></div>
<img src="../../_static/logo2.png" height="125px" border="0" alt="matplotlib"/></a>
<!-- The "Fork me on github" ribbon -->
<div id="forkongithub"><a href="https://github.com/matplotlib/matplotlib">Fork me on GitHub</a></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li><a href="../../index.html">home</a>| </li>
<li><a href="../../gallery/index.html">examples</a>| </li>
<li><a href="../../tutorials/index.html">tutorials</a>| </li>
<li><a href="../../api/pyplot_summary.html">pyplot</a>| </li>
<li><a href="../../contents.html">docs</a> »</li>
<li><a href="../index.html" >Module code</a> »</li>
<li><a href="../matplotlib.html" accesskey="U">matplotlib</a> »</li>
</ul>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="../../search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script><div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="../../contents.html">Documentation overview</a><ul>
<li><a href="../index.html">Module code</a><ul>
<li><a href="../matplotlib.html">matplotlib</a><ul>
</ul></li>
</ul></li>
</ul></li>
</ul>
</div>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<h1>Source code for matplotlib.backend_managers</h1><div class="highlight"><pre>
<span></span><span class="sd">"""</span>
<span class="sd">`ToolManager`</span>
<span class="sd"> Class that makes the bridge between user interaction (key press,</span>
<span class="sd"> toolbar clicks, ..) and the actions in response to the user inputs.</span>
<span class="sd">"""</span>
<span class="kn">from</span> <span class="nn">__future__</span> <span class="kn">import</span> <span class="p">(</span><span class="n">absolute_import</span><span class="p">,</span> <span class="n">division</span><span class="p">,</span> <span class="n">print_function</span><span class="p">,</span>
<span class="n">unicode_literals</span><span class="p">)</span>
<span class="kn">import</span> <span class="nn">six</span>
<span class="kn">import</span> <span class="nn">warnings</span>
<span class="kn">import</span> <span class="nn">matplotlib.cbook</span> <span class="k">as</span> <span class="nn">cbook</span>
<span class="kn">import</span> <span class="nn">matplotlib.widgets</span> <span class="k">as</span> <span class="nn">widgets</span>
<span class="kn">from</span> <span class="nn">matplotlib.rcsetup</span> <span class="kn">import</span> <span class="n">validate_stringlist</span>
<span class="kn">import</span> <span class="nn">matplotlib.backend_tools</span> <span class="k">as</span> <span class="nn">tools</span>
<div class="viewcode-block" id="ToolEvent"><a class="viewcode-back" href="../../api/backend_managers_api.html#matplotlib.backend_managers.ToolEvent">[docs]</a><span class="k">class</span> <span class="nc">ToolEvent</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="sd">"""Event for tool manipulation (add/remove)"""</span>
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">sender</span><span class="p">,</span> <span class="n">tool</span><span class="p">,</span> <span class="n">data</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">name</span> <span class="o">=</span> <span class="n">name</span>
<span class="bp">self</span><span class="o">.</span><span class="n">sender</span> <span class="o">=</span> <span class="n">sender</span>
<span class="bp">self</span><span class="o">.</span><span class="n">tool</span> <span class="o">=</span> <span class="n">tool</span>
<span class="bp">self</span><span class="o">.</span><span class="n">data</span> <span class="o">=</span> <span class="n">data</span></div>
<div class="viewcode-block" id="ToolTriggerEvent"><a class="viewcode-back" href="../../api/backend_managers_api.html#matplotlib.backend_managers.ToolTriggerEvent">[docs]</a><span class="k">class</span> <span class="nc">ToolTriggerEvent</span><span class="p">(</span><span class="n">ToolEvent</span><span class="p">):</span>
<span class="sd">"""Event to inform that a tool has been triggered"""</span>
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">sender</span><span class="p">,</span> <span class="n">tool</span><span class="p">,</span> <span class="n">canvasevent</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">data</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="n">ToolEvent</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">sender</span><span class="p">,</span> <span class="n">tool</span><span class="p">,</span> <span class="n">data</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">canvasevent</span> <span class="o">=</span> <span class="n">canvasevent</span></div>
<div class="viewcode-block" id="ToolManagerMessageEvent"><a class="viewcode-back" href="../../api/backend_managers_api.html#matplotlib.backend_managers.ToolManagerMessageEvent">[docs]</a><span class="k">class</span> <span class="nc">ToolManagerMessageEvent</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Event carrying messages from toolmanager</span>
<span class="sd"> Messages usually get displayed to the user by the toolbar</span>
<span class="sd"> """</span>
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">sender</span><span class="p">,</span> <span class="n">message</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">name</span> <span class="o">=</span> <span class="n">name</span>
<span class="bp">self</span><span class="o">.</span><span class="n">sender</span> <span class="o">=</span> <span class="n">sender</span>
<span class="bp">self</span><span class="o">.</span><span class="n">message</span> <span class="o">=</span> <span class="n">message</span></div>
<div class="viewcode-block" id="ToolManager"><a class="viewcode-back" href="../../api/backend_managers_api.html#matplotlib.backend_managers.ToolManager">[docs]</a><span class="k">class</span> <span class="nc">ToolManager</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Helper class that groups all the user interactions for a Figure</span>
<span class="sd"> Attributes</span>
<span class="sd"> ----------</span>
<span class="sd"> figure: `Figure`</span>
<span class="sd"> keypresslock: `widgets.LockDraw`</span>
<span class="sd"> `LockDraw` object to know if the `canvas` key_press_event is locked</span>
<span class="sd"> messagelock: `widgets.LockDraw`</span>
<span class="sd"> `LockDraw` object to know if the message is available to write</span>
<span class="sd"> """</span>
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">figure</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="n">warnings</span><span class="o">.</span><span class="n">warn</span><span class="p">(</span><span class="s1">'Treat the new Tool classes introduced in v1.5 as '</span> <span class="o">+</span>
<span class="s1">'experimental for now, the API will likely change in '</span> <span class="o">+</span>
<span class="s1">'version 2.1 and perhaps the rcParam as well'</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_key_press_handler_id</span> <span class="o">=</span> <span class="kc">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_tools</span> <span class="o">=</span> <span class="p">{}</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_keys</span> <span class="o">=</span> <span class="p">{}</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_toggled</span> <span class="o">=</span> <span class="p">{}</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_callbacks</span> <span class="o">=</span> <span class="n">cbook</span><span class="o">.</span><span class="n">CallbackRegistry</span><span class="p">()</span>
<span class="c1"># to process keypress event</span>
<span class="bp">self</span><span class="o">.</span><span class="n">keypresslock</span> <span class="o">=</span> <span class="n">widgets</span><span class="o">.</span><span class="n">LockDraw</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">messagelock</span> <span class="o">=</span> <span class="n">widgets</span><span class="o">.</span><span class="n">LockDraw</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_figure</span> <span class="o">=</span> <span class="kc">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">set_figure</span><span class="p">(</span><span class="n">figure</span><span class="p">)</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">canvas</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Canvas managed by FigureManager"""</span>
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">_figure</span><span class="p">:</span>
<span class="k">return</span> <span class="kc">None</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_figure</span><span class="o">.</span><span class="n">canvas</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">figure</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Figure that holds the canvas"""</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_figure</span>
<span class="nd">@figure</span><span class="o">.</span><span class="n">setter</span>
<span class="k">def</span> <span class="nf">figure</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">figure</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">set_figure</span><span class="p">(</span><span class="n">figure</span><span class="p">)</span>
<div class="viewcode-block" id="ToolManager.set_figure"><a class="viewcode-back" href="../../api/backend_managers_api.html#matplotlib.backend_managers.ToolManager.set_figure">[docs]</a> <span class="k">def</span> <span class="nf">set_figure</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">figure</span><span class="p">,</span> <span class="n">update_tools</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Sets the figure to interact with the tools</span>
<span class="sd"> Parameters</span>
<span class="sd"> ==========</span>
<span class="sd"> figure: `Figure`</span>
<span class="sd"> update_tools: bool</span>
<span class="sd"> Force tools to update figure</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_key_press_handler_id</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">canvas</span><span class="o">.</span><span class="n">mpl_disconnect</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_key_press_handler_id</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_figure</span> <span class="o">=</span> <span class="n">figure</span>
<span class="k">if</span> <span class="n">figure</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_key_press_handler_id</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">canvas</span><span class="o">.</span><span class="n">mpl_connect</span><span class="p">(</span>
<span class="s1">'key_press_event'</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_key_press</span><span class="p">)</span>
<span class="k">if</span> <span class="n">update_tools</span><span class="p">:</span>
<span class="k">for</span> <span class="n">tool</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_tools</span><span class="o">.</span><span class="n">values</span><span class="p">():</span>
<span class="n">tool</span><span class="o">.</span><span class="n">figure</span> <span class="o">=</span> <span class="n">figure</span></div>
<div class="viewcode-block" id="ToolManager.toolmanager_connect"><a class="viewcode-back" href="../../api/backend_managers_api.html#matplotlib.backend_managers.ToolManager.toolmanager_connect">[docs]</a> <span class="k">def</span> <span class="nf">toolmanager_connect</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">s</span><span class="p">,</span> <span class="n">func</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Connect event with string *s* to *func*.</span>
<span class="sd"> Parameters</span>
<span class="sd"> ----------</span>
<span class="sd"> s : String</span>
<span class="sd"> Name of the event</span>
<span class="sd"> The following events are recognized</span>
<span class="sd"> - 'tool_message_event'</span>
<span class="sd"> - 'tool_removed_event'</span>
<span class="sd"> - 'tool_added_event'</span>
<span class="sd"> For every tool added a new event is created</span>
<span class="sd"> - 'tool_trigger_TOOLNAME`</span>
<span class="sd"> Where TOOLNAME is the id of the tool.</span>
<span class="sd"> func : function</span>
<span class="sd"> Function to be called with signature</span>
<span class="sd"> def func(event)</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_callbacks</span><span class="o">.</span><span class="n">connect</span><span class="p">(</span><span class="n">s</span><span class="p">,</span> <span class="n">func</span><span class="p">)</span></div>
<div class="viewcode-block" id="ToolManager.toolmanager_disconnect"><a class="viewcode-back" href="../../api/backend_managers_api.html#matplotlib.backend_managers.ToolManager.toolmanager_disconnect">[docs]</a> <span class="k">def</span> <span class="nf">toolmanager_disconnect</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">cid</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Disconnect callback id *cid*</span>
<span class="sd"> Example usage::</span>
<span class="sd"> cid = toolmanager.toolmanager_connect('tool_trigger_zoom',</span>
<span class="sd"> on_press)</span>
<span class="sd"> #...later</span>
<span class="sd"> toolmanager.toolmanager_disconnect(cid)</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_callbacks</span><span class="o">.</span><span class="n">disconnect</span><span class="p">(</span><span class="n">cid</span><span class="p">)</span></div>
<div class="viewcode-block" id="ToolManager.message_event"><a class="viewcode-back" href="../../api/backend_managers_api.html#matplotlib.backend_managers.ToolManager.message_event">[docs]</a> <span class="k">def</span> <span class="nf">message_event</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">message</span><span class="p">,</span> <span class="n">sender</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="sd">""" Emit a `ToolManagerMessageEvent`"""</span>
<span class="k">if</span> <span class="n">sender</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">sender</span> <span class="o">=</span> <span class="bp">self</span>
<span class="n">s</span> <span class="o">=</span> <span class="s1">'tool_message_event'</span>
<span class="n">event</span> <span class="o">=</span> <span class="n">ToolManagerMessageEvent</span><span class="p">(</span><span class="n">s</span><span class="p">,</span> <span class="n">sender</span><span class="p">,</span> <span class="n">message</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_callbacks</span><span class="o">.</span><span class="n">process</span><span class="p">(</span><span class="n">s</span><span class="p">,</span> <span class="n">event</span><span class="p">)</span></div>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">active_toggle</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Currently toggled tools"""</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_toggled</span>
<div class="viewcode-block" id="ToolManager.get_tool_keymap"><a class="viewcode-back" href="../../api/backend_managers_api.html#matplotlib.backend_managers.ToolManager.get_tool_keymap">[docs]</a> <span class="k">def</span> <span class="nf">get_tool_keymap</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Get the keymap associated with the specified tool</span>
<span class="sd"> Parameters</span>
<span class="sd"> ----------</span>
<span class="sd"> name : string</span>
<span class="sd"> Name of the Tool</span>
<span class="sd"> Returns</span>
<span class="sd"> -------</span>
<span class="sd"> list : list of keys associated with the Tool</span>
<span class="sd"> """</span>
<span class="n">keys</span> <span class="o">=</span> <span class="p">[</span><span class="n">k</span> <span class="k">for</span> <span class="n">k</span><span class="p">,</span> <span class="n">i</span> <span class="ow">in</span> <span class="n">six</span><span class="o">.</span><span class="n">iteritems</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_keys</span><span class="p">)</span> <span class="k">if</span> <span class="n">i</span> <span class="o">==</span> <span class="n">name</span><span class="p">]</span>
<span class="k">return</span> <span class="n">keys</span></div>
<span class="k">def</span> <span class="nf">_remove_keys</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">):</span>
<span class="k">for</span> <span class="n">k</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_tool_keymap</span><span class="p">(</span><span class="n">name</span><span class="p">):</span>
<span class="k">del</span> <span class="bp">self</span><span class="o">.</span><span class="n">_keys</span><span class="p">[</span><span class="n">k</span><span class="p">]</span>
<div class="viewcode-block" id="ToolManager.update_keymap"><a class="viewcode-back" href="../../api/backend_managers_api.html#matplotlib.backend_managers.ToolManager.update_keymap">[docs]</a> <span class="k">def</span> <span class="nf">update_keymap</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="o">*</span><span class="n">keys</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Set the keymap to associate with the specified tool</span>
<span class="sd"> Parameters</span>
<span class="sd"> ----------</span>
<span class="sd"> name : string</span>
<span class="sd"> Name of the Tool</span>
<span class="sd"> keys : keys to associate with the Tool</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="n">name</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_tools</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">KeyError</span><span class="p">(</span><span class="s1">'</span><span class="si">%s</span><span class="s1"> not in Tools'</span> <span class="o">%</span> <span class="n">name</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_remove_keys</span><span class="p">(</span><span class="n">name</span><span class="p">)</span>
<span class="k">for</span> <span class="n">key</span> <span class="ow">in</span> <span class="n">keys</span><span class="p">:</span>
<span class="k">for</span> <span class="n">k</span> <span class="ow">in</span> <span class="n">validate_stringlist</span><span class="p">(</span><span class="n">key</span><span class="p">):</span>
<span class="k">if</span> <span class="n">k</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_keys</span><span class="p">:</span>
<span class="n">warnings</span><span class="o">.</span><span class="n">warn</span><span class="p">(</span><span class="s1">'Key </span><span class="si">%s</span><span class="s1"> changed from </span><span class="si">%s</span><span class="s1"> to </span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span>
<span class="p">(</span><span class="n">k</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_keys</span><span class="p">[</span><span class="n">k</span><span class="p">],</span> <span class="n">name</span><span class="p">))</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_keys</span><span class="p">[</span><span class="n">k</span><span class="p">]</span> <span class="o">=</span> <span class="n">name</span></div>
<div class="viewcode-block" id="ToolManager.remove_tool"><a class="viewcode-back" href="../../api/backend_managers_api.html#matplotlib.backend_managers.ToolManager.remove_tool">[docs]</a> <span class="k">def</span> <span class="nf">remove_tool</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Remove tool from `ToolManager`</span>
<span class="sd"> Parameters</span>
<span class="sd"> ----------</span>
<span class="sd"> name : string</span>
<span class="sd"> Name of the Tool</span>
<span class="sd"> """</span>
<span class="n">tool</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_tool</span><span class="p">(</span><span class="n">name</span><span class="p">)</span>
<span class="n">tool</span><span class="o">.</span><span class="n">destroy</span><span class="p">()</span>
<span class="c1"># If is a toggle tool and toggled, untoggle</span>
<span class="k">if</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">tool</span><span class="p">,</span> <span class="s1">'toggled'</span><span class="p">,</span> <span class="kc">False</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">trigger_tool</span><span class="p">(</span><span class="n">tool</span><span class="p">,</span> <span class="s1">'toolmanager'</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_remove_keys</span><span class="p">(</span><span class="n">name</span><span class="p">)</span>
<span class="n">s</span> <span class="o">=</span> <span class="s1">'tool_removed_event'</span>
<span class="n">event</span> <span class="o">=</span> <span class="n">ToolEvent</span><span class="p">(</span><span class="n">s</span><span class="p">,</span> <span class="bp">self</span><span class="p">,</span> <span class="n">tool</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_callbacks</span><span class="o">.</span><span class="n">process</span><span class="p">(</span><span class="n">s</span><span class="p">,</span> <span class="n">event</span><span class="p">)</span>
<span class="k">del</span> <span class="bp">self</span><span class="o">.</span><span class="n">_tools</span><span class="p">[</span><span class="n">name</span><span class="p">]</span></div>
<div class="viewcode-block" id="ToolManager.add_tool"><a class="viewcode-back" href="../../api/backend_managers_api.html#matplotlib.backend_managers.ToolManager.add_tool">[docs]</a> <span class="k">def</span> <span class="nf">add_tool</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">tool</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Add *tool* to `ToolManager`</span>
<span class="sd"> If successful adds a new event `tool_trigger_name` where **name** is</span>
<span class="sd"> the **name** of the tool, this event is fired everytime</span>
<span class="sd"> the tool is triggered.</span>
<span class="sd"> Parameters</span>
<span class="sd"> ----------</span>
<span class="sd"> name : str</span>
<span class="sd"> Name of the tool, treated as the ID, has to be unique</span>
<span class="sd"> tool : class_like, i.e. str or type</span>
<span class="sd"> Reference to find the class of the Tool to added.</span>
<span class="sd"> Notes</span>
<span class="sd"> -----</span>
<span class="sd"> args and kwargs get passed directly to the tools constructor.</span>
<span class="sd"> See Also</span>
<span class="sd"> --------</span>
<span class="sd"> matplotlib.backend_tools.ToolBase : The base class for tools.</span>
<span class="sd"> """</span>
<span class="n">tool_cls</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_get_cls_to_instantiate</span><span class="p">(</span><span class="n">tool</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">tool_cls</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">'Impossible to find class for </span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="nb">str</span><span class="p">(</span><span class="n">tool</span><span class="p">))</span>
<span class="k">if</span> <span class="n">name</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_tools</span><span class="p">:</span>
<span class="n">warnings</span><span class="o">.</span><span class="n">warn</span><span class="p">(</span><span class="s1">'A "Tool class" with the same name already exists, '</span>
<span class="s1">'not added'</span><span class="p">)</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_tools</span><span class="p">[</span><span class="n">name</span><span class="p">]</span>
<span class="n">tool_obj</span> <span class="o">=</span> <span class="n">tool_cls</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_tools</span><span class="p">[</span><span class="n">name</span><span class="p">]</span> <span class="o">=</span> <span class="n">tool_obj</span>
<span class="k">if</span> <span class="n">tool_cls</span><span class="o">.</span><span class="n">default_keymap</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">update_keymap</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">tool_cls</span><span class="o">.</span><span class="n">default_keymap</span><span class="p">)</span>
<span class="c1"># For toggle tools init the radio_group in self._toggled</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">tool_obj</span><span class="p">,</span> <span class="n">tools</span><span class="o">.</span><span class="n">ToolToggleBase</span><span class="p">):</span>
<span class="c1"># None group is not mutually exclusive, a set is used to keep track</span>
<span class="c1"># of all toggled tools in this group</span>
<span class="k">if</span> <span class="n">tool_obj</span><span class="o">.</span><span class="n">radio_group</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_toggled</span><span class="o">.</span><span class="n">setdefault</span><span class="p">(</span><span class="kc">None</span><span class="p">,</span> <span class="nb">set</span><span class="p">())</span>
<span class="k">else</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_toggled</span><span class="o">.</span><span class="n">setdefault</span><span class="p">(</span><span class="n">tool_obj</span><span class="o">.</span><span class="n">radio_group</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
<span class="c1"># If initially toggled</span>
<span class="k">if</span> <span class="n">tool_obj</span><span class="o">.</span><span class="n">toggled</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_handle_toggle</span><span class="p">(</span><span class="n">tool_obj</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
<span class="n">tool_obj</span><span class="o">.</span><span class="n">set_figure</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">figure</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_tool_added_event</span><span class="p">(</span><span class="n">tool_obj</span><span class="p">)</span>
<span class="k">return</span> <span class="n">tool_obj</span></div>
<span class="k">def</span> <span class="nf">_tool_added_event</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">tool</span><span class="p">):</span>
<span class="n">s</span> <span class="o">=</span> <span class="s1">'tool_added_event'</span>
<span class="n">event</span> <span class="o">=</span> <span class="n">ToolEvent</span><span class="p">(</span><span class="n">s</span><span class="p">,</span> <span class="bp">self</span><span class="p">,</span> <span class="n">tool</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_callbacks</span><span class="o">.</span><span class="n">process</span><span class="p">(</span><span class="n">s</span><span class="p">,</span> <span class="n">event</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">_handle_toggle</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">tool</span><span class="p">,</span> <span class="n">sender</span><span class="p">,</span> <span class="n">canvasevent</span><span class="p">,</span> <span class="n">data</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Toggle tools, need to untoggle prior to using other Toggle tool</span>
<span class="sd"> Called from trigger_tool</span>
<span class="sd"> Parameters</span>
<span class="sd"> ----------</span>
<span class="sd"> tool: Tool object</span>
<span class="sd"> sender: object</span>
<span class="sd"> Object that wishes to trigger the tool</span>
<span class="sd"> canvasevent : Event</span>
<span class="sd"> Original Canvas event or None</span>
<span class="sd"> data : Object</span>
<span class="sd"> Extra data to pass to the tool when triggering</span>
<span class="sd"> """</span>
<span class="n">radio_group</span> <span class="o">=</span> <span class="n">tool</span><span class="o">.</span><span class="n">radio_group</span>
<span class="c1"># radio_group None is not mutually exclusive</span>
<span class="c1"># just keep track of toggled tools in this group</span>
<span class="k">if</span> <span class="n">radio_group</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">if</span> <span class="n">tool</span><span class="o">.</span><span class="n">name</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_toggled</span><span class="p">[</span><span class="kc">None</span><span class="p">]:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_toggled</span><span class="p">[</span><span class="kc">None</span><span class="p">]</span><span class="o">.</span><span class="n">remove</span><span class="p">(</span><span class="n">tool</span><span class="o">.</span><span class="n">name</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_toggled</span><span class="p">[</span><span class="kc">None</span><span class="p">]</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">tool</span><span class="o">.</span><span class="n">name</span><span class="p">)</span>
<span class="k">return</span>
<span class="c1"># If the tool already has a toggled state, untoggle it</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_toggled</span><span class="p">[</span><span class="n">radio_group</span><span class="p">]</span> <span class="o">==</span> <span class="n">tool</span><span class="o">.</span><span class="n">name</span><span class="p">:</span>
<span class="n">toggled</span> <span class="o">=</span> <span class="kc">None</span>
<span class="c1"># If no tool was toggled in the radio_group</span>
<span class="c1"># toggle it</span>
<span class="k">elif</span> <span class="bp">self</span><span class="o">.</span><span class="n">_toggled</span><span class="p">[</span><span class="n">radio_group</span><span class="p">]</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">toggled</span> <span class="o">=</span> <span class="n">tool</span><span class="o">.</span><span class="n">name</span>
<span class="c1"># Other tool in the radio_group is toggled</span>
<span class="k">else</span><span class="p">:</span>
<span class="c1"># Untoggle previously toggled tool</span>
<span class="bp">self</span><span class="o">.</span><span class="n">trigger_tool</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_toggled</span><span class="p">[</span><span class="n">radio_group</span><span class="p">],</span>
<span class="bp">self</span><span class="p">,</span>
<span class="n">canvasevent</span><span class="p">,</span>
<span class="n">data</span><span class="p">)</span>
<span class="n">toggled</span> <span class="o">=</span> <span class="n">tool</span><span class="o">.</span><span class="n">name</span>
<span class="c1"># Keep track of the toggled tool in the radio_group</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_toggled</span><span class="p">[</span><span class="n">radio_group</span><span class="p">]</span> <span class="o">=</span> <span class="n">toggled</span>
<span class="k">def</span> <span class="nf">_get_cls_to_instantiate</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">callback_class</span><span class="p">):</span>
<span class="c1"># Find the class that corresponds to the tool</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">callback_class</span><span class="p">,</span> <span class="n">six</span><span class="o">.</span><span class="n">string_types</span><span class="p">):</span>
<span class="c1"># FIXME: make more complete searching structure</span>
<span class="k">if</span> <span class="n">callback_class</span> <span class="ow">in</span> <span class="nb">globals</span><span class="p">():</span>
<span class="n">callback_class</span> <span class="o">=</span> <span class="nb">globals</span><span class="p">()[</span><span class="n">callback_class</span><span class="p">]</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">mod</span> <span class="o">=</span> <span class="s1">'backend_tools'</span>
<span class="n">current_module</span> <span class="o">=</span> <span class="nb">__import__</span><span class="p">(</span><span class="n">mod</span><span class="p">,</span>
<span class="nb">globals</span><span class="p">(),</span> <span class="nb">locals</span><span class="p">(),</span> <span class="p">[</span><span class="n">mod</span><span class="p">],</span> <span class="mi">1</span><span class="p">)</span>
<span class="n">callback_class</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">current_module</span><span class="p">,</span> <span class="n">callback_class</span><span class="p">,</span> <span class="kc">False</span><span class="p">)</span>
<span class="k">if</span> <span class="n">callable</span><span class="p">(</span><span class="n">callback_class</span><span class="p">):</span>
<span class="k">return</span> <span class="n">callback_class</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">return</span> <span class="kc">None</span>
<div class="viewcode-block" id="ToolManager.trigger_tool"><a class="viewcode-back" href="../../api/backend_managers_api.html#matplotlib.backend_managers.ToolManager.trigger_tool">[docs]</a> <span class="k">def</span> <span class="nf">trigger_tool</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">sender</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">canvasevent</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">data</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Trigger a tool and emit the tool_trigger_[name] event</span>
<span class="sd"> Parameters</span>
<span class="sd"> ----------</span>
<span class="sd"> name : string</span>
<span class="sd"> Name of the tool</span>
<span class="sd"> sender: object</span>
<span class="sd"> Object that wishes to trigger the tool</span>
<span class="sd"> canvasevent : Event</span>
<span class="sd"> Original Canvas event or None</span>
<span class="sd"> data : Object</span>
<span class="sd"> Extra data to pass to the tool when triggering</span>
<span class="sd"> """</span>
<span class="n">tool</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_tool</span><span class="p">(</span><span class="n">name</span><span class="p">)</span>
<span class="k">if</span> <span class="n">tool</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">return</span>
<span class="k">if</span> <span class="n">sender</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">sender</span> <span class="o">=</span> <span class="bp">self</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_trigger_tool</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">sender</span><span class="p">,</span> <span class="n">canvasevent</span><span class="p">,</span> <span class="n">data</span><span class="p">)</span>
<span class="n">s</span> <span class="o">=</span> <span class="s1">'tool_trigger_</span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="n">name</span>
<span class="n">event</span> <span class="o">=</span> <span class="n">ToolTriggerEvent</span><span class="p">(</span><span class="n">s</span><span class="p">,</span> <span class="n">sender</span><span class="p">,</span> <span class="n">tool</span><span class="p">,</span> <span class="n">canvasevent</span><span class="p">,</span> <span class="n">data</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_callbacks</span><span class="o">.</span><span class="n">process</span><span class="p">(</span><span class="n">s</span><span class="p">,</span> <span class="n">event</span><span class="p">)</span></div>
<span class="k">def</span> <span class="nf">_trigger_tool</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">sender</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">canvasevent</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">data</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Trigger on a tool</span>
<span class="sd"> Method to actually trigger the tool</span>
<span class="sd"> """</span>
<span class="n">tool</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_tool</span><span class="p">(</span><span class="n">name</span><span class="p">)</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">tool</span><span class="p">,</span> <span class="n">tools</span><span class="o">.</span><span class="n">ToolToggleBase</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_handle_toggle</span><span class="p">(</span><span class="n">tool</span><span class="p">,</span> <span class="n">sender</span><span class="p">,</span> <span class="n">canvasevent</span><span class="p">,</span> <span class="n">data</span><span class="p">)</span>
<span class="c1"># Important!!!</span>
<span class="c1"># This is where the Tool object gets triggered</span>
<span class="n">tool</span><span class="o">.</span><span class="n">trigger</span><span class="p">(</span><span class="n">sender</span><span class="p">,</span> <span class="n">canvasevent</span><span class="p">,</span> <span class="n">data</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">_key_press</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">event</span><span class="p">):</span>
<span class="k">if</span> <span class="n">event</span><span class="o">.</span><span class="n">key</span> <span class="ow">is</span> <span class="kc">None</span> <span class="ow">or</span> <span class="bp">self</span><span class="o">.</span><span class="n">keypresslock</span><span class="o">.</span><span class="n">locked</span><span class="p">():</span>
<span class="k">return</span>
<span class="n">name</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_keys</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">event</span><span class="o">.</span><span class="n">key</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
<span class="k">if</span> <span class="n">name</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">return</span>
<span class="bp">self</span><span class="o">.</span><span class="n">trigger_tool</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">canvasevent</span><span class="o">=</span><span class="n">event</span><span class="p">)</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">tools</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Return the tools controlled by `ToolManager`"""</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_tools</span>
<div class="viewcode-block" id="ToolManager.get_tool"><a class="viewcode-back" href="../../api/backend_managers_api.html#matplotlib.backend_managers.ToolManager.get_tool">[docs]</a> <span class="k">def</span> <span class="nf">get_tool</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">warn</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Return the tool object, also accepts the actual tool for convenience</span>
<span class="sd"> Parameters</span>
<span class="sd"> ----------</span>
<span class="sd"> name : str, ToolBase</span>
<span class="sd"> Name of the tool, or the tool itself</span>
<span class="sd"> warn : bool, optional</span>
<span class="sd"> If this method should give warnings.</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">tools</span><span class="o">.</span><span class="n">ToolBase</span><span class="p">)</span> <span class="ow">and</span> <span class="n">name</span><span class="o">.</span><span class="n">name</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_tools</span><span class="p">:</span>
<span class="k">return</span> <span class="n">name</span>
<span class="k">if</span> <span class="n">name</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_tools</span><span class="p">:</span>
<span class="k">if</span> <span class="n">warn</span><span class="p">:</span>
<span class="n">warnings</span><span class="o">.</span><span class="n">warn</span><span class="p">(</span><span class="s2">"ToolManager does not control tool </span><span class="si">%s</span><span class="s2">"</span> <span class="o">%</span> <span class="n">name</span><span class="p">)</span>
<span class="k">return</span> <span class="kc">None</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_tools</span><span class="p">[</span><span class="n">name</span><span class="p">]</span></div></div>
</pre></div>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
© Copyright 2002 - 2012 John Hunter, Darren Dale, Eric Firing, Michael Droettboom and the Matplotlib development team; 2012 - 2018 The Matplotlib development team.
<br />
Last updated on Feb 09, 2020.
Created using
<ahref="http://sphinx-doc.org/">Sphinx</a> 1.8.5.
Doc version v2.2.5-2-ga847ffac5.
</div>
</body>
<footer>
</footer>
</html>