<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>docs/config/lua/TabInformation.md - fork/wezterm @ termiz-0.23.2</title>
<meta name="description" content="docs/config/lua/TabInformation.md in fork/wezterm at termiz-0.23.2.">
<meta property="og:title" content="docs/config/lua/TabInformation.md - fork/wezterm @ termiz-0.23.2">
<meta property="og:description" content="docs/config/lua/TabInformation.md in fork/wezterm at termiz-0.23.2.">
<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="termiz-0.23.2" data-tip="8b7ca454b5e0a65b69b1b736db54eae3c195384b">
<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">Wez Furlong</span><span class="commit-message" data-commit="40081cb5737da32058a3c87e14b84d8f2bfefdc4">docs: update a bunch of since lines to new macro</span><span class="snapshot-sha sha" data-commit="40081cb5737da32058a3c87e14b84d8f2bfefdc4">40081cb57</span><time datetime="2023-03-20T22:01:24-07:00" title="2023-03-20 22:01:24 -0700">2023-03-20</time></p>
<header class="topbar"><details class="switcher"><summary>termiz-0.23.2</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 class="current" 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 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/termiz-0.23.2/tree/docs/">docs</a> / <a href="/fork/wezterm/ref/termiz-0.23.2/tree/docs/config/">config</a> / <a href="/fork/wezterm/ref/termiz-0.23.2/tree/docs/config/lua/">lua</a> / <span class="cur">TabInformation.md</span></nav>
<span class="view-stats"><span>939 B</span><span>18 lines</span></span><span class="actions"><a class="raw" href="/fork/wezterm/raw/864bb85a9401e3ad31137792dbbfe45266f1341f/docs/config/lua/TabInformation.md">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>TabInformation</h1>
<p>The <code>TabInformation</code> struct describes a tab.  <code>TabInformation</code> is purely a
snapshot of some of the key characteristics of the tab, intended for use in
synchronous, fast, event callbacks that format GUI elements such as the window
and tab title bars.</p>
<p>The <code>TabInformation</code> struct contains the following fields:</p>
<ul>
<li><code>tab_id</code> - the identifier for the tab</li>
<li><code>tab_index</code> - the logical tab position within its containing window, with 0 indicating the leftmost tab</li>
<li><code>is_active</code> - is true if this tab is the active tab</li>
<li><code>active_pane</code> - the <a href="/fork/wezterm/ref/termiz-0.23.2/blob/docs/config/lua/PaneInformation.md">PaneInformation</a> for the active pane in this tab</li>
<li><code>window_id</code> - the ID of the window that contains this tab {{since('20220807-113146-c2fee766', inline=True)}}</li>
<li><code>window_title</code> - the title of the window that contains this tab {{since('20220807-113146-c2fee766', inline=True)}}</li>
<li><code>tab_title</code> - the title of the tab {{since('20220807-113146-c2fee766', inline=True)}}</li>
</ul>
</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>TabInformation</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">The `TabInformation` struct describes a tab.  `TabInformation` is purely a</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L4" href="#L4">4</a><span class="code-text">snapshot of some of the key characteristics of the tab, intended for use in</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L5" href="#L5">5</a><span class="code-text">synchronous, fast, event callbacks that format GUI elements such as the window</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L6" href="#L6">6</a><span class="code-text">and tab title bars.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L7" href="#L7">7</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L8" href="#L8">8</a><span class="code-text">The `TabInformation` struct contains the following fields:</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L9" href="#L9">9</a><span class="code-text"></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>`tab_id` - the identifier for the tab</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L11" href="#L11">11</a><span class="code-text"><a-p>* </a-p>`tab_index` - the logical tab position within its containing window, with 0 indicating the leftmost tab</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L12" href="#L12">12</a><span class="code-text"><a-p>* </a-p>`is_active` - is true if this tab is the active tab</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-p>* </a-p>`active_pane` - the [PaneInformation](PaneInformation.md) for the active pane in this tab</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L14" href="#L14">14</a><span class="code-text"><a-p>* </a-p>`window_id` - the ID of the window that contains this tab {{since(&#39;20220807-113146-c2fee766&#39;, inline=True)}}</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L15" href="#L15">15</a><span class="code-text"><a-p>* </a-p>`window_title` - the title of the window that contains this tab {{since(&#39;20220807-113146-c2fee766&#39;, inline=True)}}</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L16" href="#L16">16</a><span class="code-text"><a-p>* </a-p>`tab_title` - the title of the tab {{since(&#39;20220807-113146-c2fee766&#39;, inline=True)}}</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"></span></span></pre></div></div>
</main>
</body>
</html>
