Repository navigation
Expand file tree
/
Copy pathGuiTutorialFramework.html
More file actions
743 lines (591 loc) · 48.1 KB
/
Copy pathGuiTutorialFramework.html
File metadata and controls
743 lines (591 loc) · 48.1 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
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
<!DOCTYPE html>
<html lang="en" data-content_root="./" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>GUI Tutorial Framework — MantidProject main documentation</title>
<script data-cfasync="false">
document.documentElement.dataset.mode = localStorage.getItem("mode") || "";
document.documentElement.dataset.theme = localStorage.getItem("theme") || "";
</script>
<!--
this give us a css class that will be invisible only if js is disabled
-->
<noscript>
<style>
.pst-js-only { display: none !important; }
</style>
</noscript>
<!-- Loaded before other Sphinx assets -->
<link href="_static/styles/theme.css?digest=18bd87630a240e9c25be" rel="stylesheet" />
<link href="_static/styles/pydata-sphinx-theme.css?digest=18bd87630a240e9c25be" rel="stylesheet" />
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=03e43079" />
<link rel="stylesheet" type="text/css" href="_static/css/style.css?v=562d7d41" />
<!-- So that users can add custom icons -->
<script defer src="_static/scripts/fontawesome.js?digest=18bd87630a240e9c25be"></script>
<!-- Pre-loaded scripts that we'll load fully later -->
<link rel="preload" as="script" href="_static/scripts/bootstrap.js?digest=18bd87630a240e9c25be" />
<link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=18bd87630a240e9c25be" />
<script src="_static/documentation_options.js?v=a8da1a53"></script>
<script src="_static/doctools.js?v=fd6eb6e6"></script>
<script src="_static/sphinx_highlight.js?v=6ffebe34"></script>
<script>DOCUMENTATION_OPTIONS.pagename = 'GuiTutorialFramework';</script>
<script>DOCUMENTATION_OPTIONS.search_as_you_type = false;</script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Mockups with Balsamiq Wireframes" href="BalsamiqWireframes.html" />
<link rel="prev" title="Qt Designer for Python" href="QtDesignerForPython.html" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="docsearch:language" content="en">
<link rel="icon" sizes="32x32" href="_static/images/favicon.ico">
</head>
<body data-default-mode="">
<div id="pst-skip-link" class="skip-link d-print-none"><a href="#main-content">Skip to main content</a></div>
<div id="pst-scroll-pixel-helper"></div>
<button type="button" class="btn rounded-pill" id="pst-back-to-top">
<i class="fa-solid fa-arrow-up"></i>Back to top</button>
<dialog id="pst-search-dialog">
<form class="bd-search d-flex align-items-center"
action="search.html"
method="get">
<i class="fa-solid fa-magnifying-glass"></i>
<input type="search"
class="form-control"
name="q"
placeholder="Search the docs ..."
aria-label="Search the docs ..."
autocomplete="off"
autocorrect="off"
autocapitalize="off"
spellcheck="false"/>
<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd>K</kbd></span>
</form>
</dialog>
<div class="pst-async-banner-revealer d-none">
<aside id="bd-header-version-warning" class="d-none d-print-none" aria-label="Version warning"></aside>
</div>
<header id="pst-header" class="bd-header navbar navbar-expand-lg bd-navbar d-print-none">
<div class="bd-header__inner bd-page-width">
<button type="button" class="pst-navbar-icon sidebar-toggle primary-toggle" aria-label="Site navigation">
<span class="fa-solid fa-bars"></span>
</button>
<div class="col-lg-3 navbar-header-items__start">
<div class="navbar-item">
<a class="navbar-brand logo" href="index.html">
<img src="_static/images/mantid_logo_light.png" class="logo__image only-light" alt="Logo image">
<img src="_static/images/mantid_logo_dark.png" class="logo__image only-dark" alt="Logo image">
</a></div>
</div>
<div class="col-lg-9 navbar-header-items">
<div class="me-auto navbar-header-items__center">
<div class="navbar-item"><ul id="navbar-main-elements" class="navbar-nav">
<li class="nav-item">
<a class="reference internal nav-link" href="https://download.mantidproject.org">Downloads</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="https://docs.mantidproject.org/nightly/tutorials/">Tutorials</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="https://docs.mantidproject.org">User Docs</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="https://developer.mantidproject.org">Develop</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="https://docs.mantidproject.org/release/">Release notes</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="https://www.mantidproject.org/contact">Contact Us</a>
</li>
</ul></div>
</div>
<div class="navbar-header-items__end">
<div class="navbar-item navbar-persistent--container">
<button type="button" class="btn search-button-field search-button__button pst-js-only" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="fa-solid fa-magnifying-glass"></i>
<span class="search-button__default-text">Search</span>
<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd class="kbd-shortcut__modifier">K</kbd></span>
</button>
</div>
<div class="navbar-item">
<div class="theme-switch-container dropdown pst-js-only" data-bs-toggle="tooltip" data-bs-placement="bottom" title="Color mode">
<button type="button" class="btn btn-sm nav-link pst-navbar-icon theme-switch-button dropdown-toggle" aria-label="Color mode" data-bs-toggle="dropdown">
<i class="theme-switch fa-solid fa-sun fa-lg fa-fw" data-mode="light" title="Light"></i>
<i class="theme-switch fa-solid fa-moon fa-lg fa-fw" data-mode="dark" title="Dark"></i>
<i class="theme-switch fa-solid fa-circle-half-stroke fa-lg fa-fw" data-mode="auto" title="System Settings"></i>
</button>
<ul class="dropdown-menu dropdown-menu-end">
<li><button type="button" class="dropdown-item d-flex align-items-center theme-change-button" data-mode="auto"><i class="fa-solid fa-circle-half-stroke fa-lg fa-fw me-1"></i>System Settings</button></li>
<li><button type="button" class="dropdown-item d-flex align-items-center theme-change-button" data-mode="light"><i class="fa-solid fa-sun fa-lg fa-fw me-1"></i>Light</button></li>
<li><button type="button" class="dropdown-item d-flex align-items-center theme-change-button" data-mode="dark"><i class="fa-solid fa-moon fa-lg fa-fw me-1"></i>Dark</button></li>
</ul>
</div></div>
<div class="navbar-item"><ul id="navbar-icon-links" class="navbar-nav" aria-label="Icon Links">
<li class="nav-item">
<a class="nav-link" href="https://github.com/mantidproject/mantid" rel="noopener" target="_blank" title="GitHub">
<span><i class="fab fa-github-square"></i></span>
<label class="sr-only">GitHub</label>
</a>
</li>
</ul></div>
</div>
</div>
<div class="navbar-persistent--mobile">
<button type="button" class="btn search-button-field search-button__button pst-js-only" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="fa-solid fa-magnifying-glass"></i>
<span class="search-button__default-text">Search</span>
<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd class="kbd-shortcut__modifier">K</kbd></span>
</button>
</div>
<button type="button" class="pst-navbar-icon sidebar-toggle secondary-toggle" aria-label="On this page">
<span class="fa-solid fa-outdent"></span>
</button>
</div>
</header>
<div class="bd-container">
<div class="bd-container__inner bd-page-width">
<dialog id="pst-primary-sidebar-modal"></dialog>
<div id="pst-primary-sidebar" class="bd-sidebar-primary bd-sidebar">
<div class="sidebar-header-items sidebar-primary__section">
<div class="sidebar-header-items__center">
<div class="navbar-item"><ul id="navbar-main-elements" class="navbar-nav">
<li class="nav-item">
<a class="reference internal nav-link" href="https://download.mantidproject.org">Downloads</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="https://docs.mantidproject.org/nightly/tutorials/">Tutorials</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="https://docs.mantidproject.org">User Docs</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="https://developer.mantidproject.org">Develop</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="https://docs.mantidproject.org/release/">Release notes</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="https://www.mantidproject.org/contact">Contact Us</a>
</li>
</ul></div>
</div>
<div class="sidebar-header-items__end">
<div class="navbar-item">
<div class="theme-switch-container dropdown pst-js-only" data-bs-toggle="tooltip" data-bs-placement="bottom" title="Color mode">
<button type="button" class="btn btn-sm nav-link pst-navbar-icon theme-switch-button dropdown-toggle" aria-label="Color mode" data-bs-toggle="dropdown">
<i class="theme-switch fa-solid fa-sun fa-lg fa-fw" data-mode="light" title="Light"></i>
<i class="theme-switch fa-solid fa-moon fa-lg fa-fw" data-mode="dark" title="Dark"></i>
<i class="theme-switch fa-solid fa-circle-half-stroke fa-lg fa-fw" data-mode="auto" title="System Settings"></i>
</button>
<ul class="dropdown-menu dropdown-menu-end">
<li><button type="button" class="dropdown-item d-flex align-items-center theme-change-button" data-mode="auto"><i class="fa-solid fa-circle-half-stroke fa-lg fa-fw me-1"></i>System Settings</button></li>
<li><button type="button" class="dropdown-item d-flex align-items-center theme-change-button" data-mode="light"><i class="fa-solid fa-sun fa-lg fa-fw me-1"></i>Light</button></li>
<li><button type="button" class="dropdown-item d-flex align-items-center theme-change-button" data-mode="dark"><i class="fa-solid fa-moon fa-lg fa-fw me-1"></i>Dark</button></li>
</ul>
</div></div>
<div class="navbar-item"><ul id="navbar-icon-links" class="navbar-nav" aria-label="Icon Links">
<li class="nav-item">
<a class="nav-link" href="https://github.com/mantidproject/mantid" rel="noopener" target="_blank" title="GitHub">
<span><i class="fab fa-github-square"></i></span>
<label class="sr-only">GitHub</label>
</a>
</li>
</ul></div>
</div>
</div>
<div class="sidebar-primary-items__start sidebar-primary__section">
<div class="sidebar-primary-item pst-sidebar-collapse"><button type="button" id="pst-collapse-sidebar-button" aria-expanded="true" aria-controls="pst-primary-sidebar">
<svg class="pst-icon" role="img" aria-hidden="true" focusable="false" viewBox="0 0 16 16" xmlns="http://www.w3.org/2000/svg">
<path fill="currentColor" d="M3 15.5C2.36232 15.5 1.74874 15.2564 1.28478 14.8189C0.820828 14.3815 0.541576 13.7832 0.504167 13.1467L0.5 13L0.5 3C0.499965 2.36232 0.743605 1.74874 1.18107 1.28478C1.61854 0.820828 2.21676 0.541576 2.85333 0.504167L3 0.5L13 0.5C13.6377 0.499965 14.2513 0.743605 14.7152 1.18107C15.1792 1.61854 15.4584 2.21676 15.4958 2.85333L15.5 3L15.5 13C15.5 13.6377 15.2564 14.2513 14.8189 14.7152C14.3815 15.1792 13.7832 15.4584 13.1467 15.4958L13 15.5L3 15.5ZM3 13.8333L10.5 13.8333L10.5 2.16667L3 2.16667C2.79589 2.16669 2.59889 2.24163 2.44636 2.37726C2.29383 2.5129 2.19638 2.69979 2.1725 2.9025L2.16667 3L2.16667 13C2.16669 13.2041 2.24163 13.4011 2.37726 13.5536C2.5129 13.7062 2.69979 13.8036 2.9025 13.8275L3 13.8333ZM6.65583 10.325L6.5775 10.2558L4.91083 8.58917C4.76735 8.44567 4.68116 8.25476 4.66843 8.05223C4.65569 7.84971 4.71729 7.6495 4.84167 7.48917L4.91083 7.41083L6.5775 5.74417C6.72747 5.59471 6.9287 5.50794 7.14032 5.50148C7.35194 5.49502 7.55809 5.56935 7.7169 5.70937C7.8757 5.8494 7.97525 6.04463 7.99533 6.25539C8.01541 6.46616 7.95451 6.67667 7.825 6.84417L7.75583 6.9225L6.67917 8L7.75583 9.0775C7.89931 9.22099 7.98551 9.41191 7.99824 9.61443C8.01097 9.81695 7.94938 10.0172 7.825 10.1775L7.75583 10.2558C7.61234 10.3993 7.42142 10.4855 7.2189 10.4982C7.01638 10.511 6.81617 10.4494 6.65583 10.325Z"/>
</svg>
<span class="pst-collapse-sidebar-label">Collapse Sidebar</span>
<span class="pst-expand-sidebar-label">Expand Sidebar</span>
</button></div>
<div class="sidebar-primary-item">
<nav class="bd-docs-nav bd-links"
aria-label="Section Navigation">
<p class="bd-links__title" role="heading" aria-level="1">Section Navigation</p>
<div class="bd-toc-item navbar-nav"></div>
</nav></div>
</div>
<div class="sidebar-primary-items__end sidebar-primary__section">
<div class="sidebar-primary-item">
<div id="ethical-ad-placement"
class="flat"
data-ea-publisher="readthedocs"
data-ea-type="readthedocs-sidebar"
data-ea-manual="true">
</div></div>
</div>
</div>
<main id="main-content" class="bd-main" role="main">
<div class="bd-content">
<div class="bd-article-container">
<div class="bd-header-article d-print-none">
<div class="header-article-items header-article__inner">
<div class="header-article-items__start">
<div class="header-article-item">
<nav aria-label="Breadcrumb" class="d-print-none">
<ul class="bd-breadcrumbs">
<li class="breadcrumb-item breadcrumb-home">
<a href="index.html" class="nav-link" aria-label="Home">
<i class="fa-solid fa-home"></i>
</a>
</li>
<li class="breadcrumb-item active" aria-current="page"><span class="ellipsis">GUI Tutorial Framework</span></li>
</ul>
</nav>
</div>
</div>
</div>
</div>
<div id="searchbox"></div>
<article class="bd-article">
<section id="gui-tutorial-framework">
<span id="guitutorialframework"></span><h1>GUI Tutorial Framework<a class="headerlink" href="#gui-tutorial-framework" title="Link to this heading">#</a></h1>
<nav class="contents local" id="contents">
<ul class="simple">
<li><p><a class="reference internal" href="#overview" id="id1">Overview</a></p></li>
<li><p><a class="reference internal" href="#the-sandbox-why-the-tour-never-drives-the-user-s-window" id="id2">The sandbox: why the tour never drives the user’s window</a></p></li>
<li><p><a class="reference internal" href="#writing-steps" id="id3">Writing steps</a></p></li>
<li><p><a class="reference internal" href="#where-the-controls-live" id="id4">Where the controls live</a></p></li>
<li><p><a class="reference internal" href="#never-block" id="id5">Never block</a></p></li>
<li><p><a class="reference internal" href="#driving-widgets" id="id6">Driving widgets</a></p></li>
<li><p><a class="reference internal" href="#launching-it" id="id7">Launching it</a></p></li>
<li><p><a class="reference internal" href="#testing-a-tour" id="id8">Testing a tour</a></p></li>
</ul>
</nav>
<section id="overview">
<h2><a class="toc-backref" href="#id1" role="doc-backlink">Overview</a><a class="headerlink" href="#overview" title="Link to this heading">#</a></h2>
<p><code class="docutils literal notranslate"><span class="pre">mantidqt.widgets.tutorial</span></code> runs a guided walkthrough of a Qt interface: it dims the window,
spotlights one widget at a time, explains what it does, and <strong>performs the interaction itself</strong> so
the user watches a real workflow run rather than reading about one.</p>
<p><strong>Explain first, act second.</strong> A step opens whatever it points at, spotlights it and shows its
caption, and then waits. The action runs when the user presses <em>Show me</em>, so they are reading the
explanation of a control at the moment they watch it being used.</p>
<p><em>Next</em> performs the step’s action first if <em>Show me</em> was not pressed,
since chapters are cumulative and a skipped action would leave every later step describing an
interface that never reached the state it assumes.</p>
<p>An interface supplies two things — a factory that builds a copy of itself, and a list of steps.
Everything else is handled by the framework.</p>
<p>The first user of it is the <a class="reference external" href="https://docs.mantidproject.org/nightly/interfaces/diffraction/Texture%20Planner.html#texture-planner-ref" title="(in MantidProject v6.16)"><span class="xref std std-ref">Texture Planner</span></a>
(<code class="docutils literal notranslate"><span class="pre">mantidqtinterfaces/TexturePlanner/tutorial/</span></code>), which is the working example to read alongside
this page.</p>
</section>
<section id="the-sandbox-why-the-tour-never-drives-the-user-s-window">
<h2><a class="toc-backref" href="#id2" role="doc-backlink">The sandbox: why the tour never drives the user’s window</a><a class="headerlink" href="#the-sandbox-why-the-tour-never-drives-the-user-s-window" title="Link to this heading">#</a></h2>
<p>A tour that typed into the interface the user had open would be unusable — it would overwrite a
half-finished setup, and could not be offered on startup without risking someone’s work. So the
tour builds and drives <strong>a second, throwaway instance</strong> of the interface, and closes it at the end.</p>
<p>Consequences of this:</p>
<ul class="simple">
<li><p>The tour can perform genuinely destructive-looking actions — loading files, running algorithms,
writing exports — because none of it touches anything the user owns.</p></li>
<li><p>Jumping to a chapter is a <em>rebuild</em>, not an undo. There is no need for a step to know how to
reverse itself.</p></li>
<li><p>Your interface must be safe to instantiate twice. In practice that means workspace names must be
unique per instance, and closing the window must clean up after itself.</p></li>
</ul>
<p>A sandbox is any object with a <code class="docutils literal notranslate"><span class="pre">window</span></code> attribute and a <code class="docutils literal notranslate"><span class="pre">teardown()</span></code> method; subclassing
<code class="docutils literal notranslate"><span class="pre">mantidqt.widgets.tutorial.sandbox_base.InterfaceSandbox</span></code> provides both. It is also passed to every
step as the <em>context</em>, so put on it whatever the steps need to reach:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="k">class</span><span class="w"> </span><span class="nc">TutorialSandbox</span><span class="p">(</span><span class="n">InterfaceSandbox</span><span class="p">):</span>
<span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">parent</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">data</span> <span class="o">=</span> <span class="n">DemoData</span><span class="p">()</span> <span class="c1"># generated demo files</span>
<span class="n">model</span> <span class="o">=</span> <span class="n">MyModel</span><span class="p">()</span>
<span class="n">view</span> <span class="o">=</span> <span class="n">MyView</span><span class="p">(</span><span class="n">parent</span><span class="o">=</span><span class="n">parent</span><span class="p">,</span> <span class="n">register_usage</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
<span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">view</span><span class="p">,</span> <span class="n">MyPresenter</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">view</span><span class="p">,</span> <span class="n">offer_tutorial</span><span class="o">=</span><span class="kc">False</span><span class="p">))</span>
<span class="k">def</span><span class="w"> </span><span class="nf">_cleanup</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> <span class="c1"># after the view is closed</span>
<span class="bp">self</span><span class="o">.</span><span class="n">data</span><span class="o">.</span><span class="n">cleanup</span><span class="p">()</span>
</pre></div>
</div>
<p>Two traps of this pattern:</p>
<ul class="simple">
<li><p><strong>Usage reporting.</strong> If the view registers a feature usage in its constructor, the sandbox will
double-count every real launch. Give the view a flag to skip it.</p></li>
<li><p><strong>Recursion.</strong> Any method the presenter has of starting the tutorial, the sandbox’s presenter also has.
Give the presenter a flag to suppress it, these methods so tutorials can’t be launched by tutorials.</p></li>
</ul>
</section>
<section id="writing-steps">
<h2><a class="toc-backref" href="#id3" role="doc-backlink">Writing steps</a><a class="headerlink" href="#writing-steps" title="Link to this heading">#</a></h2>
<p>A tour is a sequence of <code class="docutils literal notranslate"><span class="pre">TutorialChapter</span></code>, each a sequence of <code class="docutils literal notranslate"><span class="pre">TutorialStep</span></code>:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span><span class="w"> </span><span class="nn">mantidqt.widgets.tutorial.interaction</span><span class="w"> </span><span class="kn">import</span> <span class="n">click</span><span class="p">,</span> <span class="n">select_combo</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">mantidqt.widgets.tutorial.step</span><span class="w"> </span><span class="kn">import</span> <span class="n">TutorialChapter</span><span class="p">,</span> <span class="n">TutorialStep</span>
<span class="n">SETUP</span> <span class="o">=</span> <span class="n">TutorialChapter</span><span class="p">(</span>
<span class="n">name</span><span class="o">=</span><span class="s2">"Sample setup"</span><span class="p">,</span>
<span class="n">description</span><span class="o">=</span><span class="s2">"Load a sample and give it a material."</span><span class="p">,</span>
<span class="n">steps</span><span class="o">=</span><span class="p">[</span>
<span class="n">TutorialStep</span><span class="p">(</span>
<span class="n">title</span><span class="o">=</span><span class="s2">"Load a sample shape"</span><span class="p">,</span>
<span class="n">text</span><span class="o">=</span><span class="s2">"The shape comes from an <b>STL mesh</b> or a <b>CSG description</b>."</span><span class="p">,</span>
<span class="n">target</span><span class="o">=</span><span class="k">lambda</span> <span class="n">sandbox</span><span class="p">:</span> <span class="n">sandbox</span><span class="o">.</span><span class="n">view</span><span class="o">.</span><span class="n">finder_xml</span><span class="p">,</span>
<span class="n">action</span><span class="o">=</span><span class="k">lambda</span> <span class="n">sandbox</span><span class="p">:</span> <span class="n">set_finder</span><span class="p">(</span><span class="n">sandbox</span><span class="o">.</span><span class="n">view</span><span class="o">.</span><span class="n">finder_xml</span><span class="p">,</span> <span class="n">sandbox</span><span class="o">.</span><span class="n">data</span><span class="o">.</span><span class="n">path</span><span class="p">),</span>
<span class="n">await_</span><span class="o">=</span><span class="k">lambda</span> <span class="n">sandbox</span><span class="p">:</span> <span class="ow">not</span> <span class="n">sandbox</span><span class="o">.</span><span class="n">view</span><span class="o">.</span><span class="n">finder_xml</span><span class="o">.</span><span class="n">isSearching</span><span class="p">(),</span>
<span class="n">await_timeout_s</span><span class="o">=</span><span class="mf">60.0</span><span class="p">,</span>
<span class="n">await_text</span><span class="o">=</span><span class="s2">"Looking for the sample file…"</span><span class="p">,</span>
<span class="p">),</span>
<span class="p">],</span>
<span class="p">)</span>
</pre></div>
</div>
<p><code class="docutils literal notranslate"><span class="pre">target</span></code> and <code class="docutils literal notranslate"><span class="pre">action</span></code> are <strong>callables taking the sandbox</strong>, never captured widgets. There are
two good reasons for this: some widgets do not exist for access when the tour is written (a matplotlib
canvas injected into a placeholder, a table cell widget that appears once there are rows), and a
chapter is replayed against a freshly built interface whenever the user jumps to it.</p>
<p><code class="docutils literal notranslate"><span class="pre">await_</span></code> is polled after the action until it holds — this is how a step waits for slow work
without blocking, and the step is not reported as done until it does. Give it an explicit
<code class="docutils literal notranslate"><span class="pre">await_timeout_s</span></code>: how long is reasonable depends entirely on what is being waited for.</p>
<p>A step’s target is opened up <em>before</em> its action runs — the containing tab selected, a collapsed
group box expanded, including the target itself when it is one. A value set inside a shut section
changes nothing the user can see. A target that does not exist until the action has run is
allowed: it is simply not highlighted while the step is being explained, and is only reported as
missing if it is still absent afterwards.</p>
</section>
<section id="where-the-controls-live">
<h2><a class="toc-backref" href="#id4" role="doc-backlink">Where the controls live</a><a class="headerlink" href="#where-the-controls-live" title="Link to this heading">#</a></h2>
<p>Two main interface components:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">TutorialShell</span></code> wraps the interface. Chapter tabs along the top, <code class="docutils literal notranslate"><span class="pre">Back</span></code> / <code class="docutils literal notranslate"><span class="pre">Show</span> <span class="pre">me</span></code> /
<code class="docutils literal notranslate"><span class="pre">Next</span></code> / <code class="docutils literal notranslate"><span class="pre">End</span> <span class="pre">tutorial</span></code> and a step counter along the bottom, with the interface reparented in
between. It does not move. <code class="docutils literal notranslate"><span class="pre">Show</span> <span class="pre">me</span></code> is hidden for a step that only explains something, and
disabled once the step has been performed.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">TutorialBubble</span></code> is the caption beside the highlight, and carries <strong>no controls at all</strong>. It
chases whatever is being spotlighted, so a button on it would be somewhere different on every
step.</p></li>
</ul>
<p>Because the interface becomes a child of the shell, the dimming overlay covers only the interface:
the tabs and buttons stay bright and usable while everything they act on is dimmed.</p>
<p><strong>Pointing into another window.</strong> An interface is rarely one window, and a tour that explains a
settings dialog has to annotate something the interface’s own overlay cannot reach into.
<code class="docutils literal notranslate"><span class="pre">TutorialAnnotator</span></code> handles that: it owns an overlay and a caption <em>per window</em>, builds them as
they are needed, and shows only the pair belonging to whatever is currently spotlighted. The player
is given the annotator in place of an overlay and a bubble and never learns how many windows are
involved.</p>
<p>One rule inside it is worth knowing before changing it: anything inside the primary widget is
annotated on the <strong>primary itself</strong>, not on its window. The interface is a child of the shell, so
dimming its window would put the dimmer over the chapter tabs and the navigation - the controls the
user needs to drive the tour. Everything else is annotated on its own window, which is what reaches
a dialog.</p>
<p>No shipped tour points into a dialog yet. Two things to check before one does. The dialog must be
made <strong>non-modal</strong>, in the sandbox and never in the interface itself, or it blocks the tutorial’s
own controls until the user closes something they did not ask for. And mind what applying it
writes: a settings dialog that saves to Mantid’s shared <code class="docutils literal notranslate"><span class="pre">QSettings</span></code> is <em>not</em> isolated by the
sandbox, so such a tour must dismiss it rather than accept it - Ok or Apply would change the real
interface’s saved settings on the user’s behalf.</p>
<p>Give a step an action only when it <em>does</em> something the user can watch. <code class="docutils literal notranslate"><span class="pre">Show</span> <span class="pre">me</span></code> is offered
whenever a step has one, so an action whose effect is invisible - re-expanding a section the reveal
has already opened, say - puts a button on screen that appears to do nothing when pressed.</p>
<p>Where a step’s effect shows up somewhere other than where the annotation is pointing, name that somewhere
in <code class="docutils literal notranslate"><span class="pre">avoid</span></code>. The caption is placed clear of it as well as of the spotlight, so a step that ticks a
check box while the values it changes are displayed elsewhere does not end up explaining a change that
is blocked from view:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">TutorialStep</span><span class="p">(</span>
<span class="n">title</span><span class="o">=</span><span class="s2">"Seeing them in the lab frame"</span><span class="p">,</span>
<span class="n">text</span><span class="o">=</span><span class="s2">"The fields go read-only, because these values are derived."</span><span class="p">,</span>
<span class="n">target</span><span class="o">=</span><span class="k">lambda</span> <span class="n">sandbox</span><span class="p">:</span> <span class="n">sandbox</span><span class="o">.</span><span class="n">view</span><span class="o">.</span><span class="n">chkLabDirs</span><span class="p">,</span>
<span class="n">avoid</span><span class="o">=</span><span class="k">lambda</span> <span class="n">sandbox</span><span class="p">:</span> <span class="n">sandbox</span><span class="o">.</span><span class="n">view</span><span class="o">.</span><span class="n">groupBox_textureVectors</span><span class="p">,</span>
<span class="n">action</span><span class="o">=</span><span class="k">lambda</span> <span class="n">sandbox</span><span class="p">:</span> <span class="n">set_check_state</span><span class="p">(</span><span class="n">sandbox</span><span class="o">.</span><span class="n">view</span><span class="o">.</span><span class="n">chkLabDirs</span><span class="p">,</span> <span class="kc">True</span><span class="p">),</span>
<span class="p">)</span>
</pre></div>
</div>
<p><code class="docutils literal notranslate"><span class="pre">avoid</span></code> takes one widget or a sequence of them, and a miss is ignored - keeping out of the way is
a courtesy, not something worth interrupting the tour over.</p>
<p>Navigation is refused while a step is settling or working (<code class="docutils literal notranslate"><span class="pre">busy_changed</span></code>). Without that, Next
pressed mid-calculation would run the following step’s action against an interface that had not
finished reacting to this one - and Next pressed during the settle would skip the step’s caption
while its action had already run.</p>
</section>
<section id="never-block">
<h2><a class="toc-backref" href="#id5" role="doc-backlink">Never block</a><a class="headerlink" href="#never-block" title="Link to this heading">#</a></h2>
<p>Everything the tour shows — the spotlight, the caption, the interface reacting — is painted by the
event loop, so a tour that waits by blocking freezes the demonstration it is giving. Two rules
follow:</p>
<ul class="simple">
<li><p>Wait with <code class="docutils literal notranslate"><span class="pre">interaction.wait_for(predicate,</span> <span class="pre">on_ready,</span> <span class="pre">timeout_s)</span></code>, which polls on a <code class="docutils literal notranslate"><span class="pre">QTimer</span></code>
and calls back. Never <code class="docutils literal notranslate"><span class="pre">time.sleep</span></code>, <code class="docutils literal notranslate"><span class="pre">QTest.qWait</span></code>, or a spin loop around <code class="docutils literal notranslate"><span class="pre">processEvents</span></code>.</p></li>
<li><p>Actions must <strong>finish before they return</strong>. <code class="docutils literal notranslate"><span class="pre">interaction.click</span></code> deliberately does not use
<code class="docutils literal notranslate"><span class="pre">animateClick</span></code> for this reason: that releases the button from a timer ~100 ms later, so the
press can still be pending after the tour has moved on — or after the tour has ended and the
interface it belonged to has been torn down, at which point the handler runs against workspaces
that no longer exist.</p></li>
</ul>
</section>
<section id="driving-widgets">
<h2><a class="toc-backref" href="#id6" role="doc-backlink">Driving widgets</a><a class="headerlink" href="#driving-widgets" title="Link to this heading">#</a></h2>
<p><code class="docutils literal notranslate"><span class="pre">mantidqt.widgets.tutorial.interaction</span></code> holds the helpers, which exist because the naive Qt call
usually does not do what you want:</p>
<div class="pst-scrollable-table-container"><table class="table">
<thead>
<tr class="row-odd"><th class="head"><p>Helper</p></th>
<th class="head"><p>Why not the obvious call</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">set_text</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">setText</span></code> emits none of <code class="docutils literal notranslate"><span class="pre">textEdited</span></code> / <code class="docutils literal notranslate"><span class="pre">editingFinished</span></code> / <code class="docutils literal notranslate"><span class="pre">returnPressed</span></code>, so the
interface never notices the value.</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">select_combo</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">setCurrentText</span></code> on a non-editable combo silently does nothing when the text is absent.</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">select_tab</span></code></p></td>
<td><p>By title, not index — indices move when tabs are added conditionally.</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">set_spin_box</span></code></p></td>
<td><p>Spin boxes clamp and round silently.</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">set_check_state</span></code></p></td>
<td><p>Synchronous, unlike <code class="docutils literal notranslate"><span class="pre">click</span></code>, because the caller asked for a <em>state</em>.</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">ensure_visible</span></code></p></td>
<td><p>Selects the containing tab, expands a collapsed group box, and scrolls the widget into view.
A target that is not on screen has a geometry that is meaningless to point at.</p></td>
</tr>
</tbody>
</table>
</div>
<p>These overlap with <code class="docutils literal notranslate"><span class="pre">Testing/AutomatedUITests/qt_interaction_helpers.py</span></code>, which solves the same
problems for tests. They are deliberately <em>not</em> shared: the test helpers raise <code class="docutils literal notranslate"><span class="pre">AssertionError</span></code>
(right for a test, wrong for production) and wait by blocking (right for a test, fatal here).</p>
</section>
<section id="launching-it">
<h2><a class="toc-backref" href="#id7" role="doc-backlink">Launching it</a><a class="headerlink" href="#launching-it" title="Link to this heading">#</a></h2>
<p>The presenter inherits <code class="docutils literal notranslate"><span class="pre">TutorialPresenter</span></code> and the view <code class="docutils literal notranslate"><span class="pre">TutorialViewMixin</span></code>, which between them
provide the tutorial button, opening (or raising) the tour, offering it on a first open, and closing
it with the interface:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span><span class="w"> </span><span class="nn">mantidqt.widgets.tutorial.presenter</span><span class="w"> </span><span class="kn">import</span> <span class="n">TutorialPresenter</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">mantidqt.widgets.tutorial.view</span><span class="w"> </span><span class="kn">import</span> <span class="n">TutorialViewMixin</span>
<span class="k">class</span><span class="w"> </span><span class="nc">MyView</span><span class="p">(</span><span class="n">TutorialViewMixin</span><span class="p">,</span> <span class="n">QMainWindow</span><span class="p">):</span>
<span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">parent</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="o">...</span>
<span class="bp">self</span><span class="o">.</span><span class="n">add_tutorial_button</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">toolbar</span><span class="p">)</span> <span class="c1"># a QToolBar or a QLayout</span>
<span class="k">class</span><span class="w"> </span><span class="nc">MyPresenter</span><span class="p">(</span><span class="n">TutorialPresenter</span><span class="p">):</span>
<span class="n">TUTORIAL_SETTINGS_KEY</span> <span class="o">=</span> <span class="s2">"MyInterface"</span>
<span class="n">TUTORIAL_TITLE</span> <span class="o">=</span> <span class="s2">"My Interface — Tutorial"</span>
<span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">model</span><span class="p">,</span> <span class="n">view</span><span class="p">,</span> <span class="n">offer_tutorial</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
<span class="o">...</span>
<span class="bp">self</span><span class="o">.</span><span class="n">setup_tutorial</span><span class="p">(</span><span class="n">view</span><span class="p">,</span> <span class="n">offer_tutorial</span><span class="p">)</span> <span class="c1"># last, once the view is populated</span>
<span class="k">def</span><span class="w"> </span><span class="nf">on_close</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">close_tutorial</span><span class="p">()</span>
<span class="o">...</span>
<span class="k">def</span><span class="w"> </span><span class="nf">tutorial_chapters</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="n">CHAPTERS</span>
<span class="k">def</span><span class="w"> </span><span class="nf">make_tutorial_sandbox_factory</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">myinterface.tutorial.sandbox</span><span class="w"> </span><span class="kn">import</span> <span class="n">make_sandbox_factory</span> <span class="c1"># avoids an import cycle</span>
<span class="k">return</span> <span class="n">make_sandbox_factory</span><span class="p">(</span><span class="n">parent</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">view</span><span class="p">)</span>
</pre></div>
</div>
<p><code class="docutils literal notranslate"><span class="pre">TutorialPresenter</span></code> has no <code class="docutils literal notranslate"><span class="pre">__init__</span></code> of its own, so it combines with other bases such as
<code class="docutils literal notranslate"><span class="pre">AlgorithmObserver</span></code>. Under the hood it calls <code class="docutils literal notranslate"><span class="pre">run_tutorial</span></code> from
<code class="docutils literal notranslate"><span class="pre">mantidqt.widgets.tutorial.launcher</span></code>, and keeps the returned session alive for as long as the
tour runs — it owns the sandbox window.</p>
<p><code class="docutils literal notranslate"><span class="pre">should_show_on_startup(key)</span></code> / <code class="docutils literal notranslate"><span class="pre">mark_seen(key)</span></code> store a flag under
<code class="docutils literal notranslate"><span class="pre">CustomInterfaces/<key>/tutorial_seen</span></code>. The flag is set when the tutorial is <em>offered</em>, not when
it is completed: someone who closes it immediately has made their decision, and the toolbar button
keeps it available. <code class="docutils literal notranslate"><span class="pre">TutorialPresenter</span></code> offers it from the event loop rather than from the
presenter’s constructor, or the window it should appear over would not have been laid out yet.</p>
</section>
<section id="testing-a-tour">
<h2><a class="toc-backref" href="#id8" role="doc-backlink">Testing a tour</a><a class="headerlink" href="#testing-a-tour" title="Link to this heading">#</a></h2>
<p>A tour is written against widget names and presenter methods, so it drifts the moment either is
renamed — silently, because nothing else imports it. Write a test that plays the tour against a real
interface, pressing Next as each step becomes ready and cutting <code class="docutils literal notranslate"><span class="pre">settle_ms</span></code> to the minimum, and
assert that no step failed and that every step found what it points at. See
<code class="docutils literal notranslate"><span class="pre">mantidqtinterfaces/TexturePlanner/tutorial/test/test_chapters.py</span></code>.</p>
<p>Put each step’s observation in its own <code class="docutils literal notranslate"><span class="pre">subTest</span></code> so one broken step does not hide the rest, and
assert that the sandbox leaves no workspaces behind once it is closed. Playing the tour runs the
interface for real, so play it as few times as its distinct paths require - once through, and once
per chapter entered by itself, since a chapter jump reaches its starting state by fast-forwarding
rather than by walking - and assert everything else against what that recorded. Build the hurried
copy of the tour with <code class="docutils literal notranslate"><span class="pre">dataclasses.replace</span></code> rather than by listing the fields, or the test will
quietly stop matching the real steps the next time <code class="docutils literal notranslate"><span class="pre">TutorialStep</span></code> gains one.</p>
</section>
</section>
</article>
<footer class="prev-next-footer d-print-none">
<div class="prev-next-area">
<a class="left-prev"
href="QtDesignerForPython.html"
title="previous page">
<i class="fa-solid fa-angle-left"></i>
<div class="prev-next-info">
<p class="prev-next-subtitle">previous</p>
<p class="prev-next-title">Qt Designer for Python</p>
</div>
</a>
<a class="right-next"
href="BalsamiqWireframes.html"
title="next page">
<div class="prev-next-info">
<p class="prev-next-subtitle">next</p>
<p class="prev-next-title">Mockups with Balsamiq Wireframes</p>
</div>
<i class="fa-solid fa-angle-right"></i>
</a>
</div>
</footer>
</div>
<dialog id="pst-secondary-sidebar-modal"></dialog>
<div id="pst-secondary-sidebar" class="bd-sidebar-secondary bd-toc"><div class="sidebar-secondary-items sidebar-secondary__inner">
<div class="sidebar-secondary-item">
<div
id="pst-page-navigation-heading-2"
class="page-toc tocsection onthispage">
<i class="fa-solid fa-list"></i> On this page
</div>
<nav id="pst-page-toc-nav" class="page-toc" aria-labelledby="pst-page-navigation-heading-2">
<ul class="pst-show_toc_level nav section-nav flex-column">
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#overview">Overview</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#the-sandbox-why-the-tour-never-drives-the-user-s-window">The sandbox: why the tour never drives the user’s window</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#writing-steps">Writing steps</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#where-the-controls-live">Where the controls live</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#never-block">Never block</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#driving-widgets">Driving widgets</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#launching-it">Launching it</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#testing-a-tour">Testing a tour</a></li>
</ul>
</nav></div>
<div class="sidebar-secondary-item">
<div class="tocsection sourcelink">
<a href="_sources/GuiTutorialFramework.rst.txt">
<i class="fa-solid fa-file-lines"></i> Show Source
</a>
</div>
</div>
</div></div>
</div>
<footer class="bd-footer-content">
</footer>
</main>
</div>
</div>
<!-- Scripts loaded after <body> so the DOM is not blocked -->
<script defer src="_static/scripts/bootstrap.js?digest=18bd87630a240e9c25be"></script>
<script defer src="_static/scripts/pydata-sphinx-theme.js?digest=18bd87630a240e9c25be"></script>
<footer class="bd-footer">
<div class="bd-footer__inner bd-page-width">
<div class="footer-items__start">
<div class="footer-item">
<p class="copyright">
© Copyright 2007-2026, Mantid.
<br/>
</p>
</div>
<div class="footer-item">
<p class="sphinx-version">
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 9.1.0.
</p>
</div>
</div>
<div class="footer-items__end">
<div class="footer-item">
<p class="theme-version">
<!-- # L10n: Setting the PST URL as an argument as this does not need to be localized -->
Built with the <a href="https://pydata-sphinx-theme.readthedocs.io/en/stable/index.html">PyData Sphinx Theme</a> 0.23.0.
</p></div>
</div>
</div>
</footer>
</body>
</html>