<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>docs/config/lua/pane/index.markdown - fork/wezterm @ termwiz-0.23.3</title>
<meta name="description" content="docs/config/lua/pane/index.markdown in fork/wezterm at termwiz-0.23.3.">
<meta property="og:title" content="docs/config/lua/pane/index.markdown - fork/wezterm @ termwiz-0.23.3">
<meta property="og:description" content="docs/config/lua/pane/index.markdown in fork/wezterm at termwiz-0.23.3.">
<meta property="og:type" content="website">
<meta property="og:site_name" content="git.julia.blue">
<link rel="stylesheet" href="/css/style.css?v=62">
<script type="module" src="/js/main.js?v=62"></script>
</head>
<body>
<main data-ref="termwiz-0.23.3" data-tip="4bf28e253c0167102f07bfc7e7199c13eed98012">
<noscript>
  <div class="callout">
    <p>
      hey! this is a static git repo viewer. commit diffs, file history,
      older commits and other revisions won't load without javascript.
    </p>
    <p>
      you are still able to view source files on branch/tag tips,
      but the experience is degraded.
    </p>
  </div>
</noscript>
<header class="repo"><div>
<h1>fork/wezterm</h1>
</div>
<pre class="clone">git clone https://git.julia.blue/fork/wezterm</pre>
</header>
<p class="snapshot-commit"><span class="commit-author">gitmpr</span><span class="commit-message" data-commit="1d3a459ca84bb4a05eef257a0ad5a8125d28441c">Bugfix/docs typos (#5571)</span><span class="snapshot-sha sha" data-commit="1d3a459ca84bb4a05eef257a0ad5a8125d28441c">1d3a459ca</span><time datetime="2024-06-16T23:09:42+02:00" title="2024-06-16 23:09:42 +0200">2024-06-16</time></p>
<header class="topbar"><details class="switcher"><summary>termwiz-0.23.3</summary><div class="menu"><strong>branches</strong><a href="/fork/wezterm/ref/main/">main</a><strong>tags</strong><a href="/fork/wezterm/ref/termiz-0.23.1/">termiz-0.23.1</a><a href="/fork/wezterm/ref/termiz-0.23.2/">termiz-0.23.2</a><a href="/fork/wezterm/ref/termiz-0.23.3/">termiz-0.23.3</a><a href="/fork/wezterm/ref/termwiz-0.23.0/">termwiz-0.23.0</a><a href="/fork/wezterm/ref/termwiz-0.23.1/">termwiz-0.23.1</a><a href="/fork/wezterm/ref/termwiz-0.23.2/">termwiz-0.23.2</a><a class="current" href="/fork/wezterm/ref/termwiz-0.23.3/">termwiz-0.23.3</a><a href="/fork/wezterm/ref/vtparse-0.7.0/">vtparse-0.7.0</a><a class="all" href="/fork/wezterm/refs">all refs →</a></div></details><nav class="crumbs"><a href="/fork/wezterm/">wezterm</a> / <a href="/fork/wezterm/ref/termwiz-0.23.3/tree/docs/">docs</a> / <a href="/fork/wezterm/ref/termwiz-0.23.3/tree/docs/config/">config</a> / <a href="/fork/wezterm/ref/termwiz-0.23.3/tree/docs/config/lua/">lua</a> / <a href="/fork/wezterm/ref/termwiz-0.23.3/tree/docs/config/lua/pane/">pane</a> / <span class="cur">index.markdown</span></nav>
<span class="view-stats"><span>784 B</span><span>23 lines</span></span><span class="actions"><a class="raw" href="/fork/wezterm/raw/afe37f6eb220ee9cbd010ddcf194e97c596d657b/docs/config/lua/pane/index.markdown">raw</a></span></header>
<div class="markdown-view"><input type="radio" name="markdown-view" id="markdown-rendered" checked><label for="markdown-rendered">rendered</label><input type="radio" name="markdown-view" id="markdown-code"><label for="markdown-code">code</label><section class="readme rendered"><h1><code>Pane</code> object</h1>
<hr />
<p>{{since('20221119-145034-49b9839f')}}</p>
<h2>In previous releases there were separate <code>MuxPane</code> and <code>Pane</code> objects created
by the mux and gui layers, respectively. This is no longer the case: there is
now just the underlying mux pane which is referred to in these docs as <code>Pane</code>
for the sake of simplicity.</h2>
<p>A Pane object is typically passed to your code via an event callback.  A Pane
object is a handle to a live instance of a Pane that is known to the wezterm
process.  A Pane object tracks the pseudo terminal (or real serial terminal)
and associated process(es) and the parsed screen and scrollback.</p>
<p>A Pane object can be used to send input to the associated processes and
introspect the state of the terminal emulation for that pane.</p>
<h2>Available methods</h2>
</section><div class="code-panel"><pre class="code src language-markdown"><span class="code-line"><a class="ln" id="L1" href="#L1">1</a><span class="code-text"><a-p>#</a-p> <a-tt>`Pane` object</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L2" href="#L2">2</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L3" href="#L3">3</a><span class="code-text"><a-p>---</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L4" href="#L4">4</a><span class="code-text">{{since(&#39;20221119-145034-49b9839f&#39;)}}</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L5" href="#L5">5</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L6" href="#L6">6</a><span class="code-text"><a-tt>In previous releases there were separate `MuxPane` and `Pane` objects created</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L7" href="#L7">7</a><span class="code-text"><a-tt>by the mux and gui layers, respectively. This is no longer the case: there is</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L8" href="#L8">8</a><span class="code-text"><a-tt>now just the underlying mux pane which is referred to in these docs as `Pane`</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L9" href="#L9">9</a><span class="code-text"><a-tt>for the sake of simplicity.</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L10" href="#L10">10</a><span class="code-text"><a-p>---</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L11" href="#L11">11</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L12" href="#L12">12</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L13" href="#L13">13</a><span class="code-text">A Pane object is typically passed to your code via an event callback.  A Pane</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L14" href="#L14">14</a><span class="code-text">object is a handle to a live instance of a Pane that is known to the wezterm</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L15" href="#L15">15</a><span class="code-text">process.  A Pane object tracks the pseudo terminal (or real serial terminal)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L16" href="#L16">16</a><span class="code-text">and associated process(es) and the parsed screen and scrollback.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L17" href="#L17">17</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L18" href="#L18">18</a><span class="code-text">A Pane object can be used to send input to the associated processes and</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L19" href="#L19">19</a><span class="code-text">introspect the state of the terminal emulation for that pane.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L20" href="#L20">20</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L21" href="#L21">21</a><span class="code-text"><a-p>##</a-p> <a-tt>Available methods</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L22" href="#L22">22</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L23" href="#L23">23</a><span class="code-text"></span></span></pre></div></div>
</main>
</body>
</html>
