Deployed f2add3c with MkDocs version: 1.5.3

Textualize · Jun 29, 2024 · 610351d · 610351d
1 parent 605470b
commit 610351d
Show file tree

Hide file tree

Showing 121 changed files with 17,858 additions and 17,699 deletions.
diff --git a/api/app/index.html b/api/app/index.html
diff --git a/api/await_complete/index.html b/api/await_complete/index.html
@@ -5007,6 +5007,15 @@
     </span>
   </a>
 
+</li>
+
+          <li class="md-nav__item">
+  <a href="#textual.await_complete.AwaitComplete.call_next" class="md-nav__link">
+    <span class="md-ellipsis">
+      call_next()
+    </span>
+  </a>
+
 </li>
 
           <li class="md-nav__item">
@@ -6465,6 +6474,15 @@
     </span>
   </a>
 
+</li>
+
+          <li class="md-nav__item">
+  <a href="#textual.await_complete.AwaitComplete.call_next" class="md-nav__link">
+    <span class="md-ellipsis">
+      call_next()
+    </span>
+  </a>
+
 </li>
 
           <li class="md-nav__item">
@@ -6630,6 +6648,53 @@ <h3 id="textual.await_complete.AwaitComplete.is_done" class="doc doc-heading">
 
 
 
+<h3 id="textual.await_complete.AwaitComplete.call_next" class="doc doc-heading">
+        <span class="doc doc-object-name doc-function-name">call_next</span>
+
+  <span class="doc doc-labels">
+      <small class="doc doc-label doc-label-method"><code>method</code></small>
+  </span>
+
+<a href="#textual.await_complete.AwaitComplete.call_next" class="headerlink" title="Permanent link">&para;</a></h3>
+<div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="k">def</span> <span class="nf">call_next</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">node</span><span class="p">):</span>
+</code></pre></div>
+
+  <div class="doc doc-contents ">
+
+      <p>Await after the next message.</p>
+
+  <h5>Parameters</h5>
+  <table>
+    <thead>
+      <tr>
+        <th>Parameter</th>
+        <th>Default</th>
+        <th>Description</th>
+      </tr>
+    </thead>
+    <tbody>
+        <tr>
+          <td>
+            <strong><code>node</code></strong>
+            <br>
+                <code><a class="autorefs autorefs-internal" title="textual.message_pump.MessagePump" href="../message_pump/#textual.message_pump.MessagePump">MessagePump</a></code>
+          </td>
+          <td>
+            <em>required</em>
+          </td>
+          <td><p>The node which created the object.</p></td>
+        </tr>
+    </tbody>
+  </table>
+
+  </div>
+
+</div>
+
+<div class="doc doc-object doc-function">
+
+
+
 <h3 id="textual.await_complete.AwaitComplete.nothing" class="doc doc-heading">
         <span class="doc doc-object-name doc-function-name">nothing</span>
 

diff --git a/api/binding/index.html b/api/binding/index.html
@@ -6894,8 +6894,8 @@ <h3 id="textual.binding.Binding.description" class="doc doc-heading">
 
 
   <span class="doc doc-labels">
-      <small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
       <small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
+      <small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
   </span>
 
 <a href="#textual.binding.Binding.description" class="headerlink" title="Permanent link">&para;</a></h3>
@@ -6941,8 +6941,8 @@ <h3 id="textual.binding.Binding.key_display" class="doc doc-heading">
 
 
   <span class="doc doc-labels">
-      <small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
       <small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
+      <small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
   </span>
 
 <a href="#textual.binding.Binding.key_display" class="headerlink" title="Permanent link">&para;</a></h3>
@@ -6965,8 +6965,8 @@ <h3 id="textual.binding.Binding.priority" class="doc doc-heading">
 
 
   <span class="doc doc-labels">
-      <small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
       <small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
+      <small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
   </span>
 
 <a href="#textual.binding.Binding.priority" class="headerlink" title="Permanent link">&para;</a></h3>
@@ -6989,8 +6989,8 @@ <h3 id="textual.binding.Binding.show" class="doc doc-heading">
 
 
   <span class="doc doc-labels">
-      <small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
       <small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
+      <small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
   </span>
 
 <a href="#textual.binding.Binding.show" class="headerlink" title="Permanent link">&para;</a></h3>

diff --git a/api/color/index.html b/api/color/index.html
@@ -8239,8 +8239,8 @@ <h3 id="textual.color.Color.a" class="doc doc-heading">
 
 
   <span class="doc doc-labels">
-      <small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
       <small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
+      <small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
   </span>
 
 <a href="#textual.color.Color.a" class="headerlink" title="Permanent link">&para;</a></h3>
@@ -9229,8 +9229,8 @@ <h3 id="textual.color.Color.parse" class="doc doc-heading">
         <span class="doc doc-object-name doc-function-name">parse</span>
 
   <span class="doc doc-labels">
-      <small class="doc doc-label doc-label-classmethod"><code>classmethod</code></small>
       <small class="doc doc-label doc-label-cached"><code>cached</code></small>
+      <small class="doc doc-label doc-label-classmethod"><code>classmethod</code></small>
   </span>
 
 <a href="#textual.color.Color.parse" class="headerlink" title="Permanent link">&para;</a></h3>

diff --git a/api/command/index.html b/api/command/index.html
@@ -7654,7 +7654,7 @@ <h2 id="textual.command.CommandPalette" class="doc doc-heading">
 
   <div class="doc doc-contents ">
       <p class="doc doc-class-bases">
-        Bases: <code><span title="textual.screen._SystemModalScreen">_SystemModalScreen</span>[<a class="autorefs autorefs-internal" title="textual.types.CallbackType" href="../types/#textual.types.CallbackType">CallbackType</a>]</code></p>
+        Bases: <code><a class="autorefs autorefs-internal" title="textual.screen.SystemModalScreen" href="../screen/#textual.screen.SystemModalScreen">SystemModalScreen</a>[<a class="autorefs autorefs-internal" title="textual.types.CallbackType" href="../types/#textual.types.CallbackType">CallbackType</a>]</code></p>
 
 
       <p>The Textual command palette.</p>
@@ -8154,8 +8154,8 @@ <h3 id="textual.command.DiscoveryHit.help" class="doc doc-heading">
 
 
   <span class="doc doc-labels">
-      <small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
       <small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
+      <small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
   </span>
 
 <a href="#textual.command.DiscoveryHit.help" class="headerlink" title="Permanent link">&para;</a></h3>
@@ -8201,8 +8201,8 @@ <h3 id="textual.command.DiscoveryHit.text" class="doc doc-heading">
 
 
   <span class="doc doc-labels">
-      <small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
       <small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
+      <small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
   </span>
 
 <a href="#textual.command.DiscoveryHit.text" class="headerlink" title="Permanent link">&para;</a></h3>
@@ -8294,8 +8294,8 @@ <h3 id="textual.command.Hit.help" class="doc doc-heading">
 
 
   <span class="doc doc-labels">
-      <small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
       <small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
+      <small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
   </span>
 
 <a href="#textual.command.Hit.help" class="headerlink" title="Permanent link">&para;</a></h3>
@@ -8388,8 +8388,8 @@ <h3 id="textual.command.Hit.text" class="doc doc-heading">
 
 
   <span class="doc doc-labels">
-      <small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
       <small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
+      <small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
   </span>
 
 <a href="#textual.command.Hit.text" class="headerlink" title="Permanent link">&para;</a></h3>
@@ -9023,8 +9023,8 @@ <h3 id="textual.command.Provider.search" class="doc doc-heading">
         <span class="doc doc-object-name doc-function-name">search</span>
 
   <span class="doc doc-labels">
-      <small class="doc doc-label doc-label-abstractmethod"><code>abstractmethod</code></small>
       <small class="doc doc-label doc-label-async"><code>async</code></small>
+      <small class="doc doc-label doc-label-abstractmethod"><code>abstractmethod</code></small>
   </span>
 
 <a href="#textual.command.Provider.search" class="headerlink" title="Permanent link">&para;</a></h3>
@@ -9181,8 +9181,8 @@ <h3 id="textual.command.SearchIcon.icon" class="doc doc-heading">
 
 
   <span class="doc doc-labels">
-      <small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
       <small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
+      <small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
   </span>
 
 <a href="#textual.command.SearchIcon.icon" class="headerlink" title="Permanent link">&para;</a></h3>

diff --git a/api/containers/index.html b/api/containers/index.html
@@ -5250,6 +5250,15 @@
     </span>
   </a>
 
+</li>
+
+          <li class="md-nav__item">
+  <a href="#textual.widgets._content_switcher.ContentSwitcher.add_content" class="md-nav__link">
+    <span class="md-ellipsis">
+      add_content()
+    </span>
+  </a>
+
 </li>
 
           <li class="md-nav__item">
@@ -6657,6 +6666,15 @@
     </span>
   </a>
 
+</li>
+
+          <li class="md-nav__item">
+  <a href="#textual.widgets._content_switcher.ContentSwitcher.add_content" class="md-nav__link">
+    <span class="md-ellipsis">
+      add_content()
+    </span>
+  </a>
+
 </li>
 
           <li class="md-nav__item">
@@ -7378,8 +7396,8 @@ <h3 id="textual.widgets._content_switcher.ContentSwitcher.current" class="doc do
 
 
   <span class="doc doc-labels">
-      <small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
       <small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
+      <small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
   </span>
 
 <a href="#textual.widgets._content_switcher.ContentSwitcher.current" class="headerlink" title="Permanent link">&para;</a></h3>
@@ -7431,6 +7449,93 @@ <h3 id="textual.widgets._content_switcher.ContentSwitcher.visible_content" class
 
 
 
+<h3 id="textual.widgets._content_switcher.ContentSwitcher.add_content" class="doc doc-heading">
+        <span class="doc doc-object-name doc-function-name">add_content</span>
+
+  <span class="doc doc-labels">
+      <small class="doc doc-label doc-label-method"><code>method</code></small>
+  </span>
+
+<a href="#textual.widgets._content_switcher.ContentSwitcher.add_content" class="headerlink" title="Permanent link">&para;</a></h3>
+<div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="k">def</span> <span class="nf">add_content</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">widget</span><span class="p">,</span> <span class="o">*</span><span class="p">,</span> <span class="nb">id</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">set_current</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
+</code></pre></div>
+
+  <div class="doc doc-contents ">
+
+      <p>Add new content to the <code>ContentSwitcher</code>.</p>
+
+  <h5>Parameters</h5>
+  <table>
+    <thead>
+      <tr>
+        <th>Parameter</th>
+        <th>Default</th>
+        <th>Description</th>
+      </tr>
+    </thead>
+    <tbody>
+        <tr>
+          <td>
+            <strong><code>widget</code></strong>
+            <br>
+                <code><a class="autorefs autorefs-internal" title="textual.widget.Widget" href="../widget/#textual.widget.Widget">Widget</a></code>
+          </td>
+          <td>
+            <em>required</em>
+          </td>
+          <td><p>A Widget to add.</p></td>
+        </tr>
+        <tr>
+          <td>
+            <strong><code>id</code></strong>
+            <br>
+                <code><a class="autorefs autorefs-external" href="https://docs.python.org/3/library/stdtypes.html#str">str</a> | None</code>
+          </td>
+          <td>
+            <code>None</code>
+          </td>
+          <td><p>ID for the widget, or <code>None</code> if the widget already has an ID.</p></td>
+        </tr>
+        <tr>
+          <td>
+            <strong><code>set_current</code></strong>
+            <br>
+                <code><a class="autorefs autorefs-external" href="https://docs.python.org/3/library/functions.html#bool">bool</a></code>
+          </td>
+          <td>
+            <code>False</code>
+          </td>
+          <td><p>Set the new widget as current (which will cause it to display).</p></td>
+        </tr>
+    </tbody>
+  </table>
+
+  <h5>Returns</h5>
+  <table>
+    <thead>
+      <tr>
+        <th>Type</th>
+        <th>Description</th>
+      </tr>
+    </thead>
+    <tbody>
+        <tr>
+          <td>
+                <code><a class="autorefs autorefs-internal" title="textual.await_complete.AwaitComplete" href="../await_complete/#textual.await_complete.AwaitComplete">AwaitComplete</a></code>
+          </td>
+          <td><p>An awaitable to wait for the new content to be mounted.</p></td>
+        </tr>
+    </tbody>
+  </table>
+
+  </div>
+
+</div>
+
+<div class="doc doc-object doc-function">
+
+
+
 <h3 id="textual.widgets._content_switcher.ContentSwitcher.watch_current" class="doc doc-heading">
         <span class="doc doc-object-name doc-function-name">watch_current</span>