Skip to content

Commit 2e20b57

Browse files
jamesdbrockjamesdbrock
committed
docs
1 parent f7afe1e commit 2e20b57

5 files changed

Lines changed: 30 additions & 27 deletions

File tree

‎_modules/edifice/base_components/radio_button.html‎

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -422,7 +422,9 @@ <h1>Source code for edifice.base_components.radio_button</h1><div class="highlig
422422
<span class="sd"> - Underlying Qt Widget</span>
423423
<span class="sd"> `QRadioButton &lt;https://doc.qt.io/qtforpython-6/PySide6/QtWidgets/QRadioButton.html&gt;`_</span>
424424

425-
<span class="sd"> Radio buttons are used to specify a single choice out of many.</span>
425+
<span class="sd"> Radio buttons are used to select a single choice out of many.</span>
426+
427+
<span class="sd"> .. figure:: /image/radio_button.png</span>
426428

427429
<span class="sd"> .. rubric:: Props</span>
428430

@@ -440,11 +442,6 @@ <h1>Source code for edifice.base_components.radio_button</h1><div class="highlig
440442

441443
<span class="sd"> .. rubric:: Usage</span>
442444

443-
<span class="sd"> .. figure:: /image/radio_button.png</span>
444-
<span class="sd"> :width: 300</span>
445-
446-
<span class="sd"> Three RadioButtons</span>
447-
448445
<span class="sd"> Because of the declarative nature of Edifice, we can ignore all of the</span>
449446
<span class="sd"> Qt mechanisms for radio button “groups” and “exclusivity.”</span>
450447
<span class="sd"> Just declare each radio button :code:`checked` prop to depend on the state.</span>
@@ -454,16 +451,16 @@ <h1>Source code for edifice.base_components.radio_button</h1><div class="highlig
454451

455452
<span class="sd"> value, value_set = use_state(cast(Literal[&quot;op1&quot;, &quot;op2&quot;], &quot;op1&quot;))</span>
456453

457-
<span class="sd"> with ed.VBoxView():</span>
458-
<span class="sd"> with ed.VBoxView():</span>
459-
<span class="sd"> ed.RadioButton(</span>
454+
<span class="sd"> with VBoxView():</span>
455+
<span class="sd"> with VBoxView():</span>
456+
<span class="sd"> RadioButton(</span>
460457
<span class="sd"> checked = value == &quot;op1&quot;,</span>
461458
<span class="sd"> on_change = lambda checked: value_set(&quot;op1&quot;) if checked else None,</span>
462459
<span class="sd"> text = &quot;Option 1&quot;,</span>
463460
<span class="sd"> style = {} if value == &quot;op1&quot; else { &quot;color&quot;: &quot;grey&quot; },</span>
464461
<span class="sd"> )</span>
465-
<span class="sd"> with ed.VBoxView():</span>
466-
<span class="sd"> ed.RadioButton(</span>
462+
<span class="sd"> with VBoxView():</span>
463+
<span class="sd"> RadioButton(</span>
467464
<span class="sd"> checked = value == &quot;op2&quot;,</span>
468465
<span class="sd"> on_change = lambda checked: value_set(&quot;op2&quot;) if checked else None,</span>
469466
<span class="sd"> text = &quot;Option 2&quot;,</span>

‎_modules/edifice/run_subprocess_with_callback.html‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -649,8 +649,13 @@ <h1>Source code for edifice.run_subprocess_with_callback</h1><div class="highlig
649649

650650
<span class="sd"> # In this example we use gather() to run these 2 functions</span>
651651
<span class="sd"> # concurrently (“at the same time”).</span>
652+
<span class="sd"> #</span>
652653
<span class="sd"> # 1. run_subprocess_with_callback()</span>
653654
<span class="sd"> # 2. send_messages()</span>
655+
<span class="sd"> #</span>
656+
<span class="sd"> # In your code you will probably instead want to send_messages()</span>
657+
<span class="sd"> # in reaction to some event.</span>
658+
<span class="sd"> #</span>
654659
<span class="sd"> y, _ = await asyncio.gather(</span>
655660
<span class="sd"> run_subprocess_with_callback(</span>
656661
<span class="sd"> functools.partial(my_subprocess, msg_queue),</span>

‎run_subprocess_with_callback.html‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -530,8 +530,13 @@ <h2>Messaging to the subprocess<a class="headerlink" href="#messaging-to-the-sub
530530

531531
<span class="c1"># In this example we use gather() to run these 2 functions</span>
532532
<span class="c1"># concurrently (“at the same time”).</span>
533+
<span class="c1">#</span>
533534
<span class="c1"># 1. run_subprocess_with_callback()</span>
534535
<span class="c1"># 2. send_messages()</span>
536+
<span class="c1">#</span>
537+
<span class="c1"># In your code you will probably instead want to send_messages()</span>
538+
<span class="c1"># in reaction to some event.</span>
539+
<span class="c1">#</span>
535540
<span class="n">y</span><span class="p">,</span> <span class="n">_</span> <span class="o">=</span> <span class="k">await</span> <span class="n">asyncio</span><span class="o">.</span><span class="n">gather</span><span class="p">(</span>
536541
<span class="n">run_subprocess_with_callback</span><span class="p">(</span>
537542
<span class="n">functools</span><span class="o">.</span><span class="n">partial</span><span class="p">(</span><span class="n">my_subprocess</span><span class="p">,</span> <span class="n">msg_queue</span><span class="p">),</span>

‎searchindex.js‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎stubs/edifice.RadioButton.html‎

Lines changed: 11 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -397,7 +397,10 @@ <h1>edifice.RadioButton<a class="headerlink" href="#edifice-radiobutton" title="
397397
<a class="reference external" href="https://doc.qt.io/qtforpython-6/PySide6/QtWidgets/QRadioButton.html">QRadioButton</a></p></li>
398398
</ul>
399399
</div></blockquote>
400-
<p>Radio buttons are used to specify a single choice out of many.</p>
400+
<p>Radio buttons are used to select a single choice out of many.</p>
401+
<figure class="align-default">
402+
<img alt="../_images/radio_button.png" src="../_images/radio_button.png" />
403+
</figure>
401404
<p class="rubric">Props</p>
402405
<p>All <strong>props</strong> from <a class="reference internal" href="edifice.QtWidgetElement.html#edifice.QtWidgetElement" title="edifice.QtWidgetElement"><code class="xref py py-class docutils literal notranslate"><span class="pre">QtWidgetElement</span></code></a> plus:</p>
403406
<dl class="field-list simple">
@@ -412,30 +415,23 @@ <h1>edifice.RadioButton<a class="headerlink" href="#edifice-radiobutton" title="
412415
</dd>
413416
</dl>
414417
<p class="rubric">Usage</p>
415-
<figure class="align-default" id="id1">
416-
<a class="reference internal image-reference" href="../_images/radio_button.png"><img alt="../_images/radio_button.png" src="../_images/radio_button.png" style="width: 300px;" />
417-
</a>
418-
<figcaption>
419-
<p><span class="caption-text">Three RadioButtons</span><a class="headerlink" href="#id1" title="Link to this image">#</a></p>
420-
</figcaption>
421-
</figure>
422418
<p>Because of the declarative nature of Edifice, we can ignore all of the
423419
Qt mechanisms for radio button “groups” and “exclusivity.”
424420
Just declare each radio button <code class="code docutils literal notranslate"><span class="pre">checked</span></code> prop to depend on the state.</p>
425-
<div class="literal-block-wrapper docutils container" id="id2">
426-
<div class="code-block-caption"><span class="caption-text">Exclusive RadioButtons with different parents</span><a class="headerlink" href="#id2" title="Link to this code">#</a></div>
421+
<div class="literal-block-wrapper docutils container" id="id1">
422+
<div class="code-block-caption"><span class="caption-text">Exclusive RadioButtons with different parents</span><a class="headerlink" href="#id1" title="Link to this code">#</a></div>
427423
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">value</span><span class="p">,</span> <span class="n">value_set</span> <span class="o">=</span> <span class="n">use_state</span><span class="p">(</span><span class="n">cast</span><span class="p">(</span><span class="n">Literal</span><span class="p">[</span><span class="s2">&quot;op1&quot;</span><span class="p">,</span> <span class="s2">&quot;op2&quot;</span><span class="p">],</span> <span class="s2">&quot;op1&quot;</span><span class="p">))</span>
428424

429-
<span class="k">with</span> <span class="n">ed</span><span class="o">.</span><span class="n">VBoxView</span><span class="p">():</span>
430-
<span class="k">with</span> <span class="n">ed</span><span class="o">.</span><span class="n">VBoxView</span><span class="p">():</span>
431-
<span class="n">ed</span><span class="o">.</span><span class="n">RadioButton</span><span class="p">(</span>
425+
<span class="k">with</span> <span class="n">VBoxView</span><span class="p">():</span>
426+
<span class="k">with</span> <span class="n">VBoxView</span><span class="p">():</span>
427+
<span class="n">RadioButton</span><span class="p">(</span>
432428
<span class="n">checked</span> <span class="o">=</span> <span class="n">value</span> <span class="o">==</span> <span class="s2">&quot;op1&quot;</span><span class="p">,</span>
433429
<span class="n">on_change</span> <span class="o">=</span> <span class="k">lambda</span> <span class="n">checked</span><span class="p">:</span> <span class="n">value_set</span><span class="p">(</span><span class="s2">&quot;op1&quot;</span><span class="p">)</span> <span class="k">if</span> <span class="n">checked</span> <span class="k">else</span> <span class="kc">None</span><span class="p">,</span>
434430
<span class="n">text</span> <span class="o">=</span> <span class="s2">&quot;Option 1&quot;</span><span class="p">,</span>
435431
<span class="n">style</span> <span class="o">=</span> <span class="p">{}</span> <span class="k">if</span> <span class="n">value</span> <span class="o">==</span> <span class="s2">&quot;op1&quot;</span> <span class="k">else</span> <span class="p">{</span> <span class="s2">&quot;color&quot;</span><span class="p">:</span> <span class="s2">&quot;grey&quot;</span> <span class="p">},</span>
436432
<span class="p">)</span>
437-
<span class="k">with</span> <span class="n">ed</span><span class="o">.</span><span class="n">VBoxView</span><span class="p">():</span>
438-
<span class="n">ed</span><span class="o">.</span><span class="n">RadioButton</span><span class="p">(</span>
433+
<span class="k">with</span> <span class="n">VBoxView</span><span class="p">():</span>
434+
<span class="n">RadioButton</span><span class="p">(</span>
439435
<span class="n">checked</span> <span class="o">=</span> <span class="n">value</span> <span class="o">==</span> <span class="s2">&quot;op2&quot;</span><span class="p">,</span>
440436
<span class="n">on_change</span> <span class="o">=</span> <span class="k">lambda</span> <span class="n">checked</span><span class="p">:</span> <span class="n">value_set</span><span class="p">(</span><span class="s2">&quot;op2&quot;</span><span class="p">)</span> <span class="k">if</span> <span class="n">checked</span> <span class="k">else</span> <span class="kc">None</span><span class="p">,</span>
441437
<span class="n">text</span> <span class="o">=</span> <span class="s2">&quot;Option 2&quot;</span><span class="p">,</span>

0 commit comments

Comments
 (0)