Home /Modules/api/guidoc.html

guidoc.html

api/sleela/3.1/version-031/package/guidoc.html · 711 line(s) · html

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>Package guidoc — SleelaDoc API</title>
<link rel="stylesheet" href="../style.css">

</head>
<body>
<header class="top">
  <div class="brand"><a href="../index.html">SleelaDoc API</a></div>
  <div class="tag">HTML documentation for the SLeeLa standard library (/lib)</div>
</header>
<div class="wrap">
<nav class="side">
  <a href="../index.html"><strong>Home</strong></a>
  <a href="../packages.html"><strong>All packages</strong></a>
  <a href="../glossary.html"><strong>Glossary</strong></a>
  <a href="../authorship.html"><strong>Authorship</strong></a>
  <h2>Packages</h2><ul>
<li><a href="../package/advantage.html">advantage</a></li>
<li><a href="../package/alphabet.html">alphabet</a></li>
<li><a href="../package/antivirus.html">antivirus</a></li>
<li><a href="../package/api.html">api</a></li>
<li><a href="../package/array.html">array</a></li>
<li><a href="../package/audio.html">audio</a></li>
<li><a href="../package/autocad.html">autocad</a></li>
<li><a href="../package/ballum.html">ballum</a></li>
<li><a href="../package/bash.html">bash</a></li>
<li><a href="../package/boolean.html">boolean</a></li>
<li><a href="../package/cdma.html">cdma</a></li>
<li><a href="../package/char.html">char</a></li>
<li><a href="../package/character.html">character</a></li>
<li><a href="../package/character-recognition.html">character-recognition</a></li>
<li><a href="../package/churn.html">churn</a></li>
<li><a href="../package/citizen.html">citizen</a></li>
<li><a href="../package/codecs.html">codecs</a></li>
<li><a href="../package/collections.html">collections</a></li>
<li><a href="../package/common-rails.html">common-rails</a></li>
<li><a href="../package/compiler.html">compiler</a></li>
<li><a href="../package/compression.html">compression</a></li>
<li><a href="../package/config.html">config</a></li>
<li><a href="../package/connector.html">connector</a></li>
<li><a href="../package/coorenagraph.html">coorenagraph</a></li>
<li><a href="../package/core.html">core</a></li>
<li><a href="../package/cpu.html">cpu</a></li>
<li><a href="../package/crypto.html">crypto</a></li>
<li><a href="../package/data.html">data</a></li>
<li><a href="../package/data-structures.html">data-structures</a></li>
<li><a href="../package/database.html">database</a></li>
<li><a href="../package/debugger.html">debugger</a></li>
<li><a href="../package/decompiler.html">decompiler</a></li>
<li><a href="../package/deliberation.html">deliberation</a></li>
<li><a href="../package/drivers.html">drivers</a></li>
<li><a href="../package/examples.html">examples</a></li>
<li><a href="../package/filesystem.html">filesystem</a></li>
<li><a href="../package/gameplay.html">gameplay</a></li>
<li><a href="../package/governance.html">governance</a></li>
<li><a href="../package/gui.html">gui</a></li>
<li><a href="../package/guidoc.html">guidoc</a></li>
<li><a href="../package/hotlink.html">hotlink</a></li>
<li><a href="../package/html.html">html</a></li>
<li><a href="../package/http.html">http</a></li>
<li><a href="../package/http-1.0.html">http-1.0</a></li>
<li><a href="../package/http-2.0.html">http-2.0</a></li>
<li><a href="../package/http-3.0.html">http-3.0</a></li>
<li><a href="../package/http-4.0.html">http-4.0</a></li>
<li><a href="../package/http-5.0.html">http-5.0</a></li>
<li><a href="../package/http-6.0.html">http-6.0</a></li>
<li><a href="../package/http-7.0.html">http-7.0</a></li>
<li><a href="../package/http-8.0.html">http-8.0</a></li>
<li><a href="../package/http-9.0.html">http-9.0</a></li>
<li><a href="../package/http-servers.html">http-servers</a></li>
<li><a href="../package/ide.html">ide</a></li>
<li><a href="../package/ide-workbench.html">ide-workbench</a></li>
<li><a href="../package/idea.html">idea</a></li>
<li><a href="../package/inference-model.html">inference-model</a></li>
<li><a href="../package/inputs.html">inputs</a></li>
<li><a href="../package/international-criminal-court.html">international-criminal-court</a></li>
<li><a href="../package/io.html">io</a></li>
<li><a href="../package/java.html">java</a></li>
<li><a href="../package/java28.html">java28</a></li>
<li><a href="../package/journey.html">journey</a></li>
<li><a href="../package/languages.html">languages</a></li>
<li><a href="../package/large-language-models.html">large-language-models</a></li>
<li><a href="../package/ledger.html">ledger</a></li>
<li><a href="../package/linux-editors.html">linux-editors</a></li>
<li><a href="../package/manifesto.html">manifesto</a></li>
<li><a href="../package/math.html">math</a></li>
<li><a href="../package/memory.html">memory</a></li>
<li><a href="../package/modules.html">modules</a></li>
<li><a href="../package/moral-capacitor.html">moral-capacitor</a></li>
<li><a href="../package/munction.html">munction</a></li>
<li><a href="../package/native.html">native</a></li>
<li><a href="../package/net.html">net</a></li>
<li><a href="../package/neural-nets.html">neural-nets</a></li>
<li><a href="../package/nordshrift.html">nordshrift</a></li>
<li><a href="../package/observer.html">observer</a></li>
<li><a href="../package/opcodes.html">opcodes</a></li>
<li><a href="../package/operating-system.html">operating-system</a></li>
<li><a href="../package/os-level-support.html">os-level-support</a></li>
<li><a href="../package/philosophers.html">philosophers</a></li>
<li><a href="../package/philosophy.html">philosophy</a></li>
<li><a href="../package/politico.html">politico</a></li>
<li><a href="../package/process.html">process</a></li>
<li><a href="../package/psychiatry.html">psychiatry</a></li>
<li><a href="../package/public.html">public</a></li>
<li><a href="../package/reflection.html">reflection</a></li>
<li><a href="../package/regex.html">regex</a></li>
<li><a href="../package/registry.html">registry</a></li>
<li><a href="../package/rmi.html">rmi</a></li>
<li><a href="../package/rrs.html">rrs</a></li>
<li><a href="../package/runtime.html">runtime</a></li>
<li><a href="../package/security.html">security</a></li>
<li><a href="../package/server-edition.html">server-edition</a></li>
<li><a href="../package/signal-processing.html">signal-processing</a></li>
<li><a href="../package/sldocument.html">sldocument</a></li>
<li><a href="../package/sleela.html">sleela</a></li>
<li><a href="../package/sleela-sql.html">sleela-sql</a></li>
<li><a href="../package/sleela-terminal.html">sleela-terminal</a></li>
<li><a href="../package/sleeladoc.html">sleeladoc</a></li>
<li><a href="../package/slrtp.html">slrtp</a></li>
<li><a href="../package/social-model.html">social-model</a></li>
<li><a href="../package/softlisten.html">softlisten</a></li>
<li><a href="../package/sommeliers.html">sommeliers</a></li>
<li><a href="../package/spatial.html">spatial</a></li>
<li><a href="../package/sst.html">sst</a></li>
<li><a href="../package/synchro.html">synchro</a></li>
<li><a href="../package/systems.html">systems</a></li>
<li><a href="../package/telephony-skya.html">telephony-skya</a></li>
<li><a href="../package/terminal.html">terminal</a></li>
<li><a href="../package/terminal_pixel.html">terminal_pixel</a></li>
<li><a href="../package/text.html">text</a></li>
<li><a href="../package/ui.html">ui</a></li>
<li><a href="../package/us-infrastructure.html">us-infrastructure</a></li>
<li><a href="../package/user-interface.html">user-interface</a></li>
<li><a href="../package/video.html">video</a></li>
<li><a href="../package/vm.html">vm</a></li>
<li><a href="../package/web-server-technology.html">web-server-technology</a></li>
<li><a href="../package/website.html">website</a></li>
<li><a href="../package/wifi.html">wifi</a></li>
<li><a href="../package/xlt.html">xlt</a></li>
<li><a href="../package/xml.html">xml</a></li>
</ul>
</nav>
<main>
<div class="crumbs"><a href="../index.html">Home</a> &rsaquo; <a href="../packages.html">Packages</a> &rsaquo; guidoc</div>
<h1>Package <code>guidoc</code></h1>
<div class="lead">This package contains <strong>11</strong> source unit(s) defining <strong>12</strong> class(es) / struct(s). Each unit below lists its fields (the values it stores) and methods (the actions it performs), with a plain explanation of each.</div>
<input class="search" placeholder="Filter on this page (Ctrl+F also works)…" oninput="flt(this.value)">
<h2 class="section" data-u="guidoc">guidoc <span class="pill syntax">#sleela 3.0</span> <span class="muted" style="font-size:13px">(lib/guidoc/guidoc.sleela)</span></h2>
<div data-u="guidoc guidoc">
<h3 id="GuiDoc">GuiDoc <span class="pill">class</span></h3>
<p class="desc">The launcher of the document GUI. It builds the GUI from its spec, runs the readiness gate, optionally opens the file named by the environment variable SLEELA_GUIDOC_OPEN, prints the screen as a text outline and says whether the GUI is ready. SLEELA_GUIDOC_ADMIN=1 makes the session an admin and SLEELA_GUIDOC_LOCK=1 (admin only) locks the system before the screen is printed. With SLEELA_GUIDOC_PLAN=1 it also prints the mount plan a windowing host consumes. On a host with no display it stops there; a windowing host drives the same SLGuiDocApp through click(), type() and accelerate(). Output ends with GUIDOC READY or GUIDOC NOT READY (SLeeLa 3.0 main cannot set an exit status, so scripts match that line).</p>
<div class="meta-note">Carries the standard <strong>Metadata Class record</strong> — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.</div>
<p class="muted"><strong>Methods</strong> — the actions this unit can perform.</p>
<table class="members"><tr><th>Method</th><th>Signature</th><th>What it does</th></tr>
<tr><td><code>main</code></td><td><span class="sig">void main()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
</table>
</div>
<h2 class="section" data-u="guidoc-demo">guidoc-demo <span class="pill syntax">#sleela 3.0</span> <span class="muted" style="font-size:13px">(lib/guidoc/guidoc-demo.sleela)</span></h2>
<div data-u="guidoc-demo guidocdemo">
<h3 id="GuiDocDemo">GuiDocDemo <span class="pill">class</span></h3>
<p class="desc">Runnable, self-checking demonstrator for the document GUI in white: menus and accelerators, tabs, the line editor, the open and save-as dialogs, load and save to real files, the discard confirmations, the 14-tab limit, read-only unsplit files, external changes seen by the GUI document listener, and the white theme. It drives the widget tree with scripted presses (the same calls a host makes from real widgets) and verifies the screen after each step. Prints PASS or FAIL per check and a tally.</p>
<div class="meta-note">Carries the standard <strong>Metadata Class record</strong> — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.</div>
<p class="muted"><strong>Fields</strong> — the named values this unit stores.</p>
<table class="members"><tr><th>Field</th><th>Declaration</th><th>What it holds</th></tr>
<tr><td><code>passed</code></td><td><span class="sig">int passed</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>failed</code></td><td><span class="sig">int failed</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>app</code></td><td><span class="sig">SLGuiDocApp app</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>v</code></td><td><span class="sig">SLGuiDocView v</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
</table>
<p class="muted"><strong>Methods</strong> — the actions this unit can perform.</p>
<table class="members"><tr><th>Method</th><th>Signature</th><th>What it does</th></tr>
<tr><td><code>check</code></td><td><span class="sig">void check(String label, boolean ok)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>banner</code></td><td><span class="sig">void banner(String t)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>t</code></td><td><span class="sig">String t(String id)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>vis</code></td><td><span class="sig">boolean vis(String id)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>en</code></td><td><span class="sig">boolean en(String id)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>cur</code></td><td><span class="sig">SLGuiDocTab cur()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>menuClick</code></td><td><span class="sig">int menuClick(String menu, String item)</span></td><td class="desc">Click a menu then one of its items, the way a user would.</td></tr>
<tr><td><code>menuClickOn</code></td><td><span class="sig">int menuClickOn(SLGuiDocApp a, String menu, String item)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>auditHas</code></td><td><span class="sig">boolean auditHas(SLGuiDocApp a, String entry)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>outlineHas</code></td><td><span class="sig">boolean outlineHas(String line)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>slurp</code></td><td><span class="sig">String slurp(String path)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>dump</code></td><td><span class="sig">void dump(String path, String data)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>main</code></td><td><span class="sig">void main()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>notesCleanup</code></td><td><span class="sig">void notesCleanup(String base, String a, String b, String c)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
</table>
</div>
<h2 class="section" data-u="slguidocapp">SLGuiDocApp <span class="pill syntax">#sleela 3.0</span> <span class="muted" style="font-size:13px">(lib/guidoc/SLGuiDocApp.sleela)</span></h2>
<div data-u="slguidocapp slguidocapp">
<h3 id="SLGuiDocApp">SLGuiDocApp <span class="pill">class</span></h3>
<p class="desc">Defines SLGuiDocApp — the controller of the document GUI, in white. It builds the widget tree from the spec (SLGuiDocSpec, mirrored by gui-document.xml), keeps up to 14 tabs (each a standing document with its own observer and white GUI listener), runs the menu commands, handles keyboard accelerators, the open and save-as dialogs and the discard-changes confirmations, and repaints the view whenever a command or an external change to a document calls for it. Load and save go through SLGuiDocFile.</p>
<div class="meta-note">Carries the standard <strong>Metadata Class record</strong> — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.</div>
<p class="muted"><strong>Fields</strong> — the named values this unit stores.</p>
<table class="members"><tr><th>Field</th><th>Declaration</th><th>What it holds</th></tr>
<tr><td><code>spec</code></td><td><span class="sig">SLGuiDocSpec spec</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>white</code></td><td><span class="sig">SLGuiDocWhite white</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>file</code></td><td><span class="sig">SLGuiDocFile file</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>view</code></td><td><span class="sig">SLGuiDocView view</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>tabs</code></td><td><span class="sig">SLGuiDocTab[] tabs</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>tabCount</code></td><td><span class="sig">int tabCount</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>active</code></td><td><span class="sig">int active</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>untitled</code></td><td><span class="sig">int untitled</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>dialog</code></td><td><span class="sig">int dialog</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>pendingTab</code></td><td><span class="sig">int pendingTab</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>quitFlag</code></td><td><span class="sig">int quitFlag</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>status</code></td><td><span class="sig">String status</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>statusError</code></td><td><span class="sig">int statusError</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>openMenu</code></td><td><span class="sig">String openMenu</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>executed</code></td><td><span class="sig">int executed</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>refusedCommands</code></td><td><span class="sig">int refusedCommands</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>ready</code></td><td><span class="sig">SLGuiDocReady ready</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>cmdRuns</code></td><td><span class="sig">int[] cmdRuns</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>itemClicks</code></td><td><span class="sig">int[] itemClicks</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>admin</code></td><td><span class="sig">int admin</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>locked</code></td><td><span class="sig">int locked</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>choiceTab</code></td><td><span class="sig">int choiceTab</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>trail</code></td><td><span class="sig">String[] trail</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>trailCount</code></td><td><span class="sig">int trailCount</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>trailLost</code></td><td><span class="sig">int trailLost</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
</table>
<p class="muted"><strong>Methods</strong> — the actions this unit can perform.</p>
<table class="members"><tr><th>Method</th><th>Signature</th><th>What it does</th></tr>
<tr><td><code>configure</code></td><td><span class="sig">boolean configure()</span></td><td class="desc">Build everything from the spec. False if the spec or the white theme is inconsistent (nothing is half-built).</td></tr>
<tr><td><code>lifecycle</code></td><td><span class="sig">SLGuiDocReady lifecycle()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>isReady</code></td><td><span class="sig">boolean isReady()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>isCertified</code></td><td><span class="sig">boolean isCertified()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>whenReady</code></td><td><span class="sig">boolean whenReady(String subscriber)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>takeReady</code></td><td><span class="sig">boolean takeReady(String subscriber)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>audit</code></td><td><span class="sig">void audit(String entry)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>auditSize</code></td><td><span class="sig">int auditSize()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>auditAt</code></td><td><span class="sig">String auditAt(int i)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>isAdmin</code></td><td><span class="sig">boolean isAdmin()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>isLocked</code></td><td><span class="sig">boolean isLocked()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>choiceIndex</code></td><td><span class="sig">int choiceIndex()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>inChoice</code></td><td><span class="sig">boolean inChoice()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>setAdmin</code></td><td><span class="sig">void setAdmin(boolean on)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>lockAllows</code></td><td><span class="sig">boolean lockAllows(String command)</span></td><td class="desc">Does the lock let this command run right now?</td></tr>
<tr><td><code>lockAllTabs</code></td><td><span class="sig">void lockAllTabs(boolean on)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>endChoice</code></td><td><span class="sig">boolean endChoice(String reason)</span></td><td class="desc">End the editor choice session, if any. Returns true when edits were reverted. Callers set their own status text.</td></tr>
<tr><td><code>applySettings</code></td><td><span class="sig">void applySettings()</span></td><td class="desc">Re-read the settings that are copied at build time (the file limits and the sidecar suffix). New tabs also read the listener flag from the spec when they are made. Call after changing the spec at run time.</td></tr>
<tr><td><code>requestClose</code></td><td><span class="sig">boolean requestClose()</span></td><td class="desc">The window was asked to close (the host reports its close button). With a dialog open that cancels the dialog; otherwise it is Quit, which asks first if the spec says so. Returns true only if quitting went ahead or a confirmation was opened.</td></tr>
<tr><td><code>expectedNodes</code></td><td><span class="sig">int expectedNodes()</span></td><td class="desc">The node count the spec implies: window, menubar, menus, items, tab bar, tabs, new-tab button, editor, two nodes per row, entry, three status labels and the five dialog nodes.</td></tr>
<tr><td><code>start</code></td><td><span class="sig">boolean start()</span></td><td class="desc">Run the self-checks. Returns true when the GUI is READY. Can be retried after a failure.</td></tr>
<tr><td><code>specification</code></td><td><span class="sig">SLGuiDocSpec specification()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>look</code></td><td><span class="sig">SLGuiDocWhite look()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>widgets</code></td><td><span class="sig">SLGuiDocView widgets()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>files</code></td><td><span class="sig">SLGuiDocFile files()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>tabTotal</code></td><td><span class="sig">int tabTotal()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>activeIndex</code></td><td><span class="sig">int activeIndex()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>tabAt</code></td><td><span class="sig">SLGuiDocTab tabAt(int i)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>activeTab</code></td><td><span class="sig">SLGuiDocTab activeTab()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>quitRequested</code></td><td><span class="sig">boolean quitRequested()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>statusText</code></td><td><span class="sig">String statusText()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>statusIsError</code></td><td><span class="sig">boolean statusIsError()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>dialogMode</code></td><td><span class="sig">int dialogMode()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>menuOpen</code></td><td><span class="sig">String menuOpen()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>executedCount</code></td><td><span class="sig">int executedCount()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>refusedCount</code></td><td><span class="sig">int refusedCount()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>itemText</code></td><td><span class="sig">String itemText(int i, boolean paintedState)</span></td><td class="desc">The text of a menu item: its label (or, for a toggle that is on, its active label) and its accelerator.</td></tr>
<tr><td><code>buildView</code></td><td><span class="sig">void buildView()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>whenHolds</code></td><td><span class="sig">boolean whenHolds(String when)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>say</code></td><td><span class="sig">void say(String text)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>complain</code></td><td><span class="sig">void complain(String text)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>tabLabel</code></td><td><span class="sig">String tabLabel(SLGuiDocTab t)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>paint</code></td><td><span class="sig">void paint()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>paintEditor</code></td><td><span class="sig">void paintEditor(SLGuiDocTab cur)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>paintStatus</code></td><td><span class="sig">void paintStatus(SLGuiDocTab cur)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>paintDialog</code></td><td><span class="sig">void paintDialog(SLGuiDocTab cur)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>refresh</code></td><td><span class="sig">boolean refresh()</span></td><td class="desc">Called by the host loop after anything outside the GUI may have changed a document: repaint if any tab listener latched a repaint.</td></tr>
<tr><td><code>type</code></td><td><span class="sig">void type(String id, String text)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>click</code></td><td><span class="sig">int click(String id)</span></td><td class="desc">Report a node activation and service it. Returns commands executed.</td></tr>
<tr><td><code>pump</code></td><td><span class="sig">int pump()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>handle</code></td><td><span class="sig">void handle(String command, int arg)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>accelerate</code></td><td><span class="sig">boolean accelerate(String accel)</span></td><td class="desc">A keyboard accelerator such as Ctrl+S.</td></tr>
<tr><td><code>runKeyAction</code></td><td><span class="sig">boolean runKeyAction(String action)</span></td><td class="desc">Enter and Esc while a dialog or a menu is open.</td></tr>
<tr><td><code>execute</code></td><td><span class="sig">boolean execute(String command)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>dispatch</code></td><td><span class="sig">int dispatch(String command, boolean run)</span></td><td class="desc">The one command table. run=false only asks whether the command has a handler. Returns 1 ran and succeeded, 0 ran and was refused, -1 unknown.</td></tr>
<tr><td><code>flag</code></td><td><span class="sig">int flag(boolean b)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>commandRunCount</code></td><td><span class="sig">int commandRunCount(String command)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>itemClickCount</code></td><td><span class="sig">int itemClickCount(String itemId)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>commandsCovered</code></td><td><span class="sig">int commandsCovered()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>itemsCovered</code></td><td><span class="sig">int itemsCovered()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>coverageComplete</code></td><td><span class="sig">boolean coverageComplete()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>printCoverage</code></td><td><span class="sig">void printCoverage()</span></td><td class="desc">Machine-readable coverage lines, one per command and per item.</td></tr>
<tr><td><code>addTab</code></td><td><span class="sig">boolean addTab(SLGuiDocTab t)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>cmdNew</code></td><td><span class="sig">boolean cmdNew()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>cmdOpen</code></td><td><span class="sig">boolean cmdOpen()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>cmdSaveAs</code></td><td><span class="sig">boolean cmdSaveAs()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>cmdSave</code></td><td><span class="sig">boolean cmdSave()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>cmdCloseTab</code></td><td><span class="sig">boolean cmdCloseTab()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>cmdQuit</code></td><td><span class="sig">boolean cmdQuit()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>cmdInsertLine</code></td><td><span class="sig">boolean cmdInsertLine()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>cmdReplaceLine</code></td><td><span class="sig">boolean cmdReplaceLine()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>cmdDeleteLine</code></td><td><span class="sig">boolean cmdDeleteLine()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>moveTo</code></td><td><span class="sig">boolean moveTo(int to)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>cmdSelectPrev</code></td><td><span class="sig">boolean cmdSelectPrev()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>cmdSelectNext</code></td><td><span class="sig">boolean cmdSelectNext()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>cmdPageUp</code></td><td><span class="sig">boolean cmdPageUp()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>cmdPageDown</code></td><td><span class="sig">boolean cmdPageDown()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>cmdLoadLine</code></td><td><span class="sig">boolean cmdLoadLine()</span></td><td class="desc">Copy the selected line into the entry box so it can be changed and put back with Replace Line. Needs the same rights as editing.</td></tr>
<tr><td><code>cmdLock</code></td><td><span class="sig">boolean cmdLock()</span></td><td class="desc">Admin only (the menu item is enabled only for an admin). Locking refuses every command that adds content; unlocking ends any editor choice session.</td></tr>
<tr><td><code>cmdChoice</code></td><td><span class="sig">boolean cmdChoice()</span></td><td class="desc">Admin only, and only while the system is locked: start an editor choice session on the active tab, or end the one that is running.</td></tr>
<tr><td><code>cmdNextTab</code></td><td><span class="sig">boolean cmdNextTab()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>cmdPrevTab</code></td><td><span class="sig">boolean cmdPrevTab()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>cmdAbout</code></td><td><span class="sig">boolean cmdAbout()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>gotoTab</code></td><td><span class="sig">void gotoTab(int i)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>selectRow</code></td><td><span class="sig">void selectRow(int row)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>saveActiveTo</code></td><td><span class="sig">boolean saveActiveTo(String path)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>openPath</code></td><td><span class="sig">boolean openPath(String path)</span></td><td class="desc">Open a path in a new tab (or switch to the tab that already has it).</td></tr>
<tr><td><code>closeTab</code></td><td><span class="sig">boolean closeTab(int idx)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>dialogOk</code></td><td><span class="sig">void dialogOk()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>dialogCancel</code></td><td><span class="sig">void dialogCancel()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
</table>
</div>
<h2 class="section" data-u="slguidocfile">SLGuiDocFile <span class="pill syntax">#sleela 3.0</span> <span class="muted" style="font-size:13px">(lib/guidoc/SLGuiDocFile.sleela)</span></h2>
<div data-u="slguidocfile slguidocfile">
<h3 id="SLGuiDocFile">SLGuiDocFile <span class="pill">class</span></h3>
<p class="desc">Defines SLGuiDocFile — load and save for the document GUI over the openFile / read / write / close, osRename, osMakeDir and osRemove bridge. Save writes the document as plain text (lines joined by newline, with a trailing newline) through a temporary file and a rename, then writes a sidecar directory holding one file per line. Load never trusts a split: SLeeLa cannot cut a String into lines, so it reads the whole file and accepts the sidecar lines only if joining them reproduces the file EXACTLY. Otherwise the file is opened unsplit (one block) and the GUI keeps it read-only. Nothing is ever loaded that the file does not literally contain.</p>
<div class="meta-note">Carries the standard <strong>Metadata Class record</strong> — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.</div>
<p class="muted"><strong>Fields</strong> — the named values this unit stores.</p>
<table class="members"><tr><th>Field</th><th>Declaration</th><th>What it holds</th></tr>
<tr><td><code>maxBytes</code></td><td><span class="sig">int maxBytes</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>maxLines</code></td><td><span class="sig">int maxLines</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>suffix</code></td><td><span class="sig">String suffix</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>lastCode</code></td><td><span class="sig">int lastCode</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
</table>
<p class="muted"><strong>Methods</strong> — the actions this unit can perform.</p>
<table class="members"><tr><th>Method</th><th>Signature</th><th>What it does</th></tr>
<tr><td><code>configure</code></td><td><span class="sig">void configure(String sidecarSuffix, int byteLimit, int lineLimit)</span></td><td class="desc">The line limit can be lowered below the document capacity (64) but never raised above it.</td></tr>
<tr><td><code>getMaxLines</code></td><td><span class="sig">int getMaxLines()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>getLastCode</code></td><td><span class="sig">int getLastCode()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>getSidecarSuffixValue</code></td><td><span class="sig">String getSidecarSuffixValue()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>sidecarDir</code></td><td><span class="sig">String sidecarDir(String path)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>pad4</code></td><td><span class="sig">String pad4(int i)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>lineFile</code></td><td><span class="sig">String lineFile(String path, int i)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>joinDocument</code></td><td><span class="sig">String joinDocument(SLObserverDocument doc, boolean trailing)</span></td><td class="desc">The document as text: lines joined by newline, optionally ending in one.</td></tr>
<tr><td><code>exists</code></td><td><span class="sig">boolean exists(String p)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>writeWhole</code></td><td><span class="sig">boolean writeWhole(String path, String data)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>readWhole</code></td><td><span class="sig">String readWhole(String path)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>save</code></td><td><span class="sig">int save(String path, SLObserverDocument doc)</span></td><td class="desc">Save the document. The plain-text file is replaced atomically (temporary file then rename). A stale or missing sidecar is harmless: load will simply open the file unsplit.</td></tr>
<tr><td><code>load</code></td><td><span class="sig">int load(String path, SLObserverDocument into)</span></td><td class="desc">Load into an EMPTY document. 0 = exact lines, 10 = opened unsplit.</td></tr>
<tr><td><code>forget</code></td><td><span class="sig">void forget(String path)</span></td><td class="desc">Remove a saved file and its sidecar (used by tests and by a host cleanup).</td></tr>
</table>
</div>
<h2 class="section" data-u="slguidochost">SLGuiDocHost <span class="pill syntax">#sleela 3.0</span> <span class="muted" style="font-size:13px">(lib/guidoc/SLGuiDocHost.sleela)</span></h2>
<div data-u="slguidochost slguidochost">
<h3 id="SLGuiDocHost">SLGuiDocHost <span class="pill">class</span></h3>
<p class="desc">Defines SLGuiDocHost — the host side of the document GUI: how a host sees the screen. outline() renders the visible GUI as plain text lines (the terminal and headless view: window, menus, tabs, editor rows, entry, status, dialog), and mountPlan() lists every visible node in tree order with its tag, parent, background and foreground colour tokens, enabled flag and text, which is exactly what a windowing host needs to mount real widgets. Every node carries its white role, and colours are resolved by role through SLGuiDocWhite, so no style string is ever parsed.</p>
<div class="meta-note">Carries the standard <strong>Metadata Class record</strong> — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.</div>
<p class="muted"><strong>Methods</strong> — the actions this unit can perform.</p>
<table class="members"><tr><th>Method</th><th>Signature</th><th>What it does</th></tr>
<tr><td><code>emit</code></td><td><span class="sig">int emit(String[] out, int cap, int n, String line)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>outline</code></td><td><span class="sig">int outline(SLGuiDocApp app, String[] out, int cap)</span></td><td class="desc">The visible GUI as text. Returns the number of lines written.</td></tr>
<tr><td><code>mountPlan</code></td><td><span class="sig">int mountPlan(SLGuiDocApp app, String[] out, int cap)</span></td><td class="desc">Every visible node in tree order, as a mount instruction for a host.</td></tr>
<tr><td><code>event</code></td><td><span class="sig">int event(SLGuiDocApp app, String kind, String id, String value)</span></td><td class="desc">The single entry point for a windowing host. Everything a real window can report is one of these events, and nothing else reaches the GUI: press id a widget was activated (menu, menu item, tab, row, button) type id value the user typed into an entry widget key value a key chord, e.g. Ctrl+S, Up, Enter, Esc close the window close button tick a turn of the host loop: repaint if a document changed Returns the number of commands run (press), 1 or 0 (key, close, tick), 0 (type), or -1 for an unknown event kind.</td></tr>
<tr><td><code>visibleNodes</code></td><td><span class="sig">int visibleNodes(SLGuiDocApp app)</span></td><td class="desc">How many nodes mountPlan() would list (visible nodes).</td></tr>
</table>
</div>
<h2 class="section" data-u="slguidoclistener">SLGuiDocListener <span class="pill syntax">#sleela 3.0</span> <span class="muted" style="font-size:13px">(lib/guidoc/SLGuiDocListener.sleela)</span></h2>
<div data-u="slguidoclistener slguidoclistener">
<h3 id="SLGuiDocListener">SLGuiDocListener <span class="pill">class</span></h3>
<p class="desc">Defines SLGuiDocListener — the GUI document listener, in white. Its nested Responder is an observer module (a drop-in, admitted through a bounded port) that listens to the standing document of one tab. Every change latches a repaint, and the listener tells changes made through the GUI apart from changes made by someone else (an external change is flagged, shown in the status line, and never silently absorbed). It speaks the white theme through SLGuiDocWhite.</p>
<div class="meta-note">Carries the standard <strong>Metadata Class record</strong> — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.</div>
</div>
<div data-u="slguidoclistener responder">
<h3 id="Responder">Responder <span class="pill">class</span></h3>
<p class="muted"><strong>Fields</strong> — the named values this unit stores.</p>
<table class="members"><tr><th>Field</th><th>Declaration</th><th>What it holds</th></tr>
<tr><td><code>port</code></td><td><span class="sig">SLObserverPort port</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>white</code></td><td><span class="sig">SLGuiDocWhite white</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>lastRevision</code></td><td><span class="sig">int lastRevision</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>changes</code></td><td><span class="sig">int changes</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>externalChanges</code></td><td><span class="sig">int externalChanges</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>lastSource</code></td><td><span class="sig">String lastSource</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>lastExternal</code></td><td><span class="sig">String lastExternal</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>repaint</code></td><td><span class="sig">int repaint</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>seenNotes</code></td><td><span class="sig">int seenNotes</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>flagging</code></td><td><span class="sig">int flagging</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>quietChanges</code></td><td><span class="sig">int quietChanges</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
</table>
<p class="muted"><strong>Methods</strong> — the actions this unit can perform.</p>
<table class="members"><tr><th>Method</th><th>Signature</th><th>What it does</th></tr>
<tr><td><code>attach</code></td><td><span class="sig">void attach(String portName, SLGuiDocWhite look, boolean flagExternal)</span></td><td class="desc">flagExternal=false still counts every change but never flags one as external: it stays quiet in the status line.</td></tr>
<tr><td><code>portOf</code></td><td><span class="sig">SLObserverPort portOf()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>revisionSeen</code></td><td><span class="sig">int revisionSeen()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>changeCount</code></td><td><span class="sig">int changeCount()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>externalCount</code></td><td><span class="sig">int externalCount()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>latestSource</code></td><td><span class="sig">String latestSource()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>latestExternal</code></td><td><span class="sig">String latestExternal()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>noteCount</code></td><td><span class="sig">int noteCount()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>quietCount</code></td><td><span class="sig">int quietCount()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>flagsExternal</code></td><td><span class="sig">boolean flagsExternal()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>pump</code></td><td><span class="sig">int pump()</span></td><td class="desc">Read the mailbox. Returns the number of messages handled.</td></tr>
<tr><td><code>takeRepaint</code></td><td><span class="sig">boolean takeRepaint()</span></td><td class="desc">Take-the-latch: true once per batch of changes.</td></tr>
<tr><td><code>syncTo</code></td><td><span class="sig">void syncTo(int revision)</span></td><td class="desc">After a load fills the document directly, bring the listener level with its revision (no change message was sent for the load).</td></tr>
<tr><td><code>hasExternal</code></td><td><span class="sig">boolean hasExternal()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>acknowledgeExternal</code></td><td><span class="sig">void acknowledgeExternal()</span></td><td class="desc">Forget the external flag (the user has seen it).</td></tr>
<tr><td><code>statusRole</code></td><td><span class="sig">String statusRole()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>statusStyle</code></td><td><span class="sig">String statusStyle()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>statusText</code></td><td><span class="sig">String statusText()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
</table>
</div>
<h2 class="section" data-u="slguidocready">SLGuiDocReady <span class="pill syntax">#sleela 3.0</span> <span class="muted" style="font-size:13px">(lib/guidoc/SLGuiDocReady.sleela)</span></h2>
<div data-u="slguidocready slguidocready">
<h3 id="SLGuiDocReady">SLGuiDocReady <span class="pill">class</span></h3>
<p class="desc">Defines SLGuiDocReady — the readiness gate and ready lifecycle of the document GUI. Like a document-ready event, the GUI is CREATED, then CHECKING while named self-checks run, then READY (every check passed) or FAILED (the first failure is kept). Nothing may act on the GUI before it is ready. Subscribers register by name with whenReady() and take a one-shot latch once the GUI is ready; a subscriber that registers late still gets its latch. A failed gate never fires a subscriber, and begin() can retry.</p>
<div class="meta-note">Carries the standard <strong>Metadata Class record</strong> — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.</div>
<p class="muted"><strong>Fields</strong> — the named values this unit stores.</p>
<table class="members"><tr><th>Field</th><th>Declaration</th><th>What it holds</th></tr>
<tr><td><code>state</code></td><td><span class="sig">int state</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>names</code></td><td><span class="sig">String[] names</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>passedFlag</code></td><td><span class="sig">int[] passedFlag</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>details</code></td><td><span class="sig">String[] details</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>count</code></td><td><span class="sig">int count</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>failures</code></td><td><span class="sig">int failures</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>firstFailure</code></td><td><span class="sig">String firstFailure</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>subscribers</code></td><td><span class="sig">String[] subscribers</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>latched</code></td><td><span class="sig">int[] latched</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>subscriberCount</code></td><td><span class="sig">int subscriberCount</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
</table>
<p class="muted"><strong>Methods</strong> — the actions this unit can perform.</p>
<table class="members"><tr><th>Method</th><th>Signature</th><th>What it does</th></tr>
<tr><td><code>configure</code></td><td><span class="sig">void configure()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>getState</code></td><td><span class="sig">int getState()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>isReady</code></td><td><span class="sig">boolean isReady()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>hasFailed</code></td><td><span class="sig">boolean hasFailed()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>checkTotal</code></td><td><span class="sig">int checkTotal()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>failureTotal</code></td><td><span class="sig">int failureTotal()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>firstFailureText</code></td><td><span class="sig">String firstFailureText()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>checkName</code></td><td><span class="sig">String checkName(int i)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>checkPassed</code></td><td><span class="sig">boolean checkPassed(int i)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>checkDetail</code></td><td><span class="sig">String checkDetail(int i)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>stateName</code></td><td><span class="sig">String stateName()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>begin</code></td><td><span class="sig">boolean begin()</span></td><td class="desc">Start (or restart) the checks. Subscribers that already fired stay fired.</td></tr>
<tr><td><code>noteCheck</code></td><td><span class="sig">boolean noteCheck(String name, boolean ok, String detail)</span></td><td class="desc">Note one named check. Only valid while checking. A 25th check is a failure: an overflowing gate is not trusted.</td></tr>
<tr><td><code>finish</code></td><td><span class="sig">boolean finish()</span></td><td class="desc">Close the gate: READY only if at least one check ran and none failed.</td></tr>
<tr><td><code>subscriberIndex</code></td><td><span class="sig">int subscriberIndex(String name)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>whenReady</code></td><td><span class="sig">boolean whenReady(String name)</span></td><td class="desc">Register for the ready event. Late subscribers are latched at once.</td></tr>
<tr><td><code>takeReady</code></td><td><span class="sig">boolean takeReady(String name)</span></td><td class="desc">Take-the-latch: true once per subscriber, and only once the GUI is ready.</td></tr>
<tr><td><code>subscriberTotal</code></td><td><span class="sig">int subscriberTotal()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
</table>
</div>
<h2 class="section" data-u="slguidocspec">SLGuiDocSpec <span class="pill syntax">#sleela 3.0</span> <span class="muted" style="font-size:13px">(lib/guidoc/SLGuiDocSpec.sleela)</span></h2>
<div data-u="slguidocspec slguidocspec">
<h3 id="SLGuiDocSpec">SLGuiDocSpec <span class="pill">class</span></h3>
<p class="desc">Defines SLGuiDocSpec — the executable copy of gui-document.xml: the window and theme, the commands, the menus and their items (with accelerators and enabled-when conditions), the tab strip, the editor, the file dialog and the listener. The GUI is built from this spec, and tools/validate_gui_document.py fails if the XML and standard() drift. Every addition is validated and refused (fail closed) when out of vocabulary, duplicated or over a cap.</p>
<div class="meta-note">Carries the standard <strong>Metadata Class record</strong> — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.</div>
<p class="muted"><strong>Fields</strong> — the named values this unit stores.</p>
<table class="members"><tr><th>Field</th><th>Declaration</th><th>What it holds</th></tr>
<tr><td><code>winTitle</code></td><td><span class="sig">String winTitle</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>winTheme</code></td><td><span class="sig">String winTheme</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>maxTabs</code></td><td><span class="sig">int maxTabs</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>dirtyMarker</code></td><td><span class="sig">String dirtyMarker</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>newTabTitle</code></td><td><span class="sig">String newTabTitle</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>editorRows</code></td><td><span class="sig">int editorRows</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>lineNumbers</code></td><td><span class="sig">int lineNumbers</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>readOnlyWhenUnsplit</code></td><td><span class="sig">int readOnlyWhenUnsplit</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>sidecarSuffix</code></td><td><span class="sig">String sidecarSuffix</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>maxLines</code></td><td><span class="sig">int maxLines</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>maxBytes</code></td><td><span class="sig">int maxBytes</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>listenerPort</code></td><td><span class="sig">String listenerPort</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>flagExternal</code></td><td><span class="sig">int flagExternal</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>readiness</code></td><td><span class="sig">String readiness</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>release</code></td><td><span class="sig">String release</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>mId</code></td><td><span class="sig">String[] mId</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>mLabel</code></td><td><span class="sig">String[] mLabel</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>mCount</code></td><td><span class="sig">int mCount</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>iMenu</code></td><td><span class="sig">String[] iMenu</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>iId</code></td><td><span class="sig">String[] iId</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>iLabel</code></td><td><span class="sig">String[] iLabel</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>iCommand</code></td><td><span class="sig">String[] iCommand</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>iAccel</code></td><td><span class="sig">String[] iAccel</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>iWhen</code></td><td><span class="sig">String[] iWhen</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>iCount</code></td><td><span class="sig">int iCount</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>cId</code></td><td><span class="sig">String[] cId</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>cHandler</code></td><td><span class="sig">String[] cHandler</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>cConfirm</code></td><td><span class="sig">int[] cConfirm</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>cLock</code></td><td><span class="sig">String[] cLock</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>cCount</code></td><td><span class="sig">int cCount</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>tItem</code></td><td><span class="sig">String[] tItem</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>tKind</code></td><td><span class="sig">String[] tKind</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>tActive</code></td><td><span class="sig">String[] tActive</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>tCount</code></td><td><span class="sig">int tCount</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>choiceEdits</code></td><td><span class="sig">String choiceEdits</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>kAccel</code></td><td><span class="sig">String[] kAccel</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>kScope</code></td><td><span class="sig">String[] kScope</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>kAction</code></td><td><span class="sig">String[] kAction</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>kCount</code></td><td><span class="sig">int kCount</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>refused</code></td><td><span class="sig">int refused</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
</table>
<p class="muted"><strong>Methods</strong> — the actions this unit can perform.</p>
<table class="members"><tr><th>Method</th><th>Signature</th><th>What it does</th></tr>
<tr><td><code>configure</code></td><td><span class="sig">void configure()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>refusedCount</code></td><td><span class="sig">int refusedCount()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>no</code></td><td><span class="sig">boolean no()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>knownTheme</code></td><td><span class="sig">boolean knownTheme(String t)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>knownWhen</code></td><td><span class="sig">boolean knownWhen(String w)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>setWindow</code></td><td><span class="sig">boolean setWindow(String title, String theme)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>setTabs</code></td><td><span class="sig">boolean setTabs(int max, String marker, String newTitle)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>setEditor</code></td><td><span class="sig">boolean setEditor(int rows, int numbers, int readOnlyUnsplit)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>setFileDialog</code></td><td><span class="sig">boolean setFileDialog(String suffix, int lines, int bytes)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>setListener</code></td><td><span class="sig">boolean setListener(String port, int external)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>setReadiness</code></td><td><span class="sig">boolean setReadiness(String status, String version)</span></td><td class="desc">The document is draft or ready. Ready is a claim that tools/ validate_gui_document.py --gate checks against the demo.</td></tr>
<tr><td><code>getReadiness</code></td><td><span class="sig">String getReadiness()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>getRelease</code></td><td><span class="sig">String getRelease()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>isCertified</code></td><td><span class="sig">boolean isCertified()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>commandIndex</code></td><td><span class="sig">int commandIndex(String id)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>menuIndex</code></td><td><span class="sig">int menuIndex(String id)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>itemIndex</code></td><td><span class="sig">int itemIndex(String id)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>addCommand</code></td><td><span class="sig">boolean addCommand(String id, String handler, int confirms, String lockPolicy)</span></td><td class="desc">lockPolicy: allowed (runs while the system is locked), blocked (refused while locked), choice (refused while locked unless the active tab is in an editor choice session).</td></tr>
<tr><td><code>addToggle</code></td><td><span class="sig">boolean addToggle(String itemId, String kind, String activeLabel)</span></td><td class="desc">A toggle item shows its label when the state is off and activeLabel when on. kind is lock (the system lock) or choice (an editor choice session).</td></tr>
<tr><td><code>setConfirms</code></td><td><span class="sig">boolean setConfirms(String command, boolean on)</span></td><td class="desc">Change whether a command asks before it discards unsaved work.</td></tr>
<tr><td><code>addKey</code></td><td><span class="sig">boolean addKey(String accel, String scope, String action)</span></td><td class="desc">A modal key: Enter or Esc, meaningful only while a dialog (ok, cancel) or a menu (close) is open.</td></tr>
<tr><td><code>keyTotal</code></td><td><span class="sig">int keyTotal()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>keyAccelAt</code></td><td><span class="sig">String keyAccelAt(int i)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>keyScopeAt</code></td><td><span class="sig">String keyScopeAt(int i)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>keyActionAt</code></td><td><span class="sig">String keyActionAt(int i)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>actionForKey</code></td><td><span class="sig">String actionForKey(String accel, String scope)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>setLock</code></td><td><span class="sig">boolean setLock(String choiceEditsPolicy)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>lockPolicyOf</code></td><td><span class="sig">String lockPolicyOf(String command)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>toggleTotal</code></td><td><span class="sig">int toggleTotal()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>toggleItemAt</code></td><td><span class="sig">String toggleItemAt(int i)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>toggleKindAt</code></td><td><span class="sig">String toggleKindAt(int i)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>toggleActiveLabelAt</code></td><td><span class="sig">String toggleActiveLabelAt(int i)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>toggleKindOf</code></td><td><span class="sig">String toggleKindOf(String itemId)</span></td><td class="desc">The toggle kind of an item (&quot;&quot; if it is not a toggle).</td></tr>
<tr><td><code>toggleLabelOf</code></td><td><span class="sig">String toggleLabelOf(String itemId)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>getChoiceEdits</code></td><td><span class="sig">String getChoiceEdits()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>choiceReverts</code></td><td><span class="sig">boolean choiceReverts()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>commandsWithPolicy</code></td><td><span class="sig">int commandsWithPolicy(String policy)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>addMenu</code></td><td><span class="sig">boolean addMenu(String id, String label)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>addItem</code></td><td><span class="sig">boolean addItem(String menu, String id, String label, String command, String accel, String when)</span></td><td class="desc">An item needs an existing menu and command, a unique id, a known enabled-when condition, and an accelerator no other item uses.</td></tr>
<tr><td><code>menuTotal</code></td><td><span class="sig">int menuTotal()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>menuIdAt</code></td><td><span class="sig">String menuIdAt(int i)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>menuLabelAt</code></td><td><span class="sig">String menuLabelAt(int i)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>itemTotal</code></td><td><span class="sig">int itemTotal()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>itemMenuAt</code></td><td><span class="sig">String itemMenuAt(int i)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>itemIdAt</code></td><td><span class="sig">String itemIdAt(int i)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>itemLabelAt</code></td><td><span class="sig">String itemLabelAt(int i)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>itemCommandAt</code></td><td><span class="sig">String itemCommandAt(int i)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>itemAccelAt</code></td><td><span class="sig">String itemAccelAt(int i)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>itemWhenAt</code></td><td><span class="sig">String itemWhenAt(int i)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>commandTotal</code></td><td><span class="sig">int commandTotal()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>commandIdAt</code></td><td><span class="sig">String commandIdAt(int i)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>handlerOf</code></td><td><span class="sig">String handlerOf(String command)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>confirmsDiscard</code></td><td><span class="sig">boolean confirmsDiscard(String command)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>commandForAccel</code></td><td><span class="sig">String commandForAccel(String accel)</span></td><td class="desc">The command an accelerator runs, or &quot;&quot; if none.</td></tr>
<tr><td><code>whenForCommand</code></td><td><span class="sig">String whenForCommand(String command)</span></td><td class="desc">The enabled-when condition of the first item that runs a command.</td></tr>
<tr><td><code>getTitle</code></td><td><span class="sig">String getTitle()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>getTheme</code></td><td><span class="sig">String getTheme()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>getMaxTabs</code></td><td><span class="sig">int getMaxTabs()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>getDirtyMarker</code></td><td><span class="sig">String getDirtyMarker()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>getNewTabTitle</code></td><td><span class="sig">String getNewTabTitle()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>getEditorRows</code></td><td><span class="sig">int getEditorRows()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>showsLineNumbers</code></td><td><span class="sig">boolean showsLineNumbers()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>lockUnsplit</code></td><td><span class="sig">boolean lockUnsplit()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>getSidecarSuffix</code></td><td><span class="sig">String getSidecarSuffix()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>getMaxLines</code></td><td><span class="sig">int getMaxLines()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>getMaxBytes</code></td><td><span class="sig">int getMaxBytes()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>getListenerPort</code></td><td><span class="sig">String getListenerPort()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>flagsExternal</code></td><td><span class="sig">boolean flagsExternal()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>standard</code></td><td><span class="sig">int standard()</span></td><td class="desc">Seed the spec declared in gui-document.xml. Returns the number of seeds refused (0 when everything is consistent).</td></tr>
</table>
</div>
<h2 class="section" data-u="slguidoctab">SLGuiDocTab <span class="pill syntax">#sleela 3.0</span> <span class="muted" style="font-size:13px">(lib/guidoc/SLGuiDocTab.sleela)</span></h2>
<div data-u="slguidoctab slguidoctab">
<h3 id="SLGuiDocTab">SLGuiDocTab <span class="pill">class</span></h3>
<p class="desc">Defines SLGuiDocTab — one open document in the GUI: its standing document, its own dynamic observer, the white GUI listener admitted to that observer, the path it was loaded from or saved to, the saved revision (dirty means the revision moved since), the selected line and the editor scroll position. A tab opened unsplit is read-only.</p>
<div class="meta-note">Carries the standard <strong>Metadata Class record</strong> — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.</div>
<p class="muted"><strong>Fields</strong> — the named values this unit stores.</p>
<table class="members"><tr><th>Field</th><th>Declaration</th><th>What it holds</th></tr>
<tr><td><code>title</code></td><td><span class="sig">String title</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>path</code></td><td><span class="sig">String path</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>doc</code></td><td><span class="sig">SLObserverDocument doc</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>obs</code></td><td><span class="sig">SLDocumentObserver obs</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>savedRevision</code></td><td><span class="sig">int savedRevision</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>readOnly</code></td><td><span class="sig">int readOnly</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>selected</code></td><td><span class="sig">int selected</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>viewTop</code></td><td><span class="sig">int viewTop</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>locked</code></td><td><span class="sig">int locked</span></td><td class="desc">system lock: 1 while the system is locked</td></tr>
<tr><td><code>choice</code></td><td><span class="sig">int choice</span></td><td class="desc">editor choice: 1 while an admin session may edit this tab despite the lock</td></tr>
<tr><td><code>snapLines</code></td><td><span class="sig">String[] snapLines</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>snapCount</code></td><td><span class="sig">int snapCount</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>snapRevision</code></td><td><span class="sig">int snapRevision</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>snapSaved</code></td><td><span class="sig">int snapSaved</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>snapSelected</code></td><td><span class="sig">int snapSelected</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>snapTop</code></td><td><span class="sig">int snapTop</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>snapTaken</code></td><td><span class="sig">int snapTaken</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
</table>
<p class="muted"><strong>Methods</strong> — the actions this unit can perform.</p>
<table class="members"><tr><th>Method</th><th>Signature</th><th>What it does</th></tr>
<tr><td><code>configure</code></td><td><span class="sig">void configure(String name, SLGuiDocWhite white, String listenerPort, boolean flagExternal)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>getTitle</code></td><td><span class="sig">String getTitle()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>setTitle</code></td><td><span class="sig">void setTitle(String t)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>getPath</code></td><td><span class="sig">String getPath()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>setPath</code></td><td><span class="sig">void setPath(String p)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>body</code></td><td><span class="sig">SLObserverDocument body()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>observer</code></td><td><span class="sig">SLDocumentObserver observer()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>isReadOnly</code></td><td><span class="sig">boolean isReadOnly()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>lock</code></td><td><span class="sig">void lock()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>selectedLine</code></td><td><span class="sig">int selectedLine()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>topLine</code></td><td><span class="sig">int topLine()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>hasSelection</code></td><td><span class="sig">boolean hasSelection()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>settle</code></td><td><span class="sig">void settle()</span></td><td class="desc">The host cycle for this tab: deliver, let the listener read, route.</td></tr>
<tr><td><code>isLocked</code></td><td><span class="sig">boolean isLocked()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>inChoice</code></td><td><span class="sig">boolean inChoice()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>setLocked</code></td><td><span class="sig">void setLocked(boolean on)</span></td><td class="desc">Locking the tab freezes its observer, so the lock holds against any other writer too, not just the menu.</td></tr>
<tr><td><code>edit</code></td><td><span class="sig">int edit(int op, int line, String text, String source)</span></td><td class="desc">Edit through the observer. Refused when the tab is read-only, and refused while the system is locked unless an editor choice session is running on this tab (checked here as well as in the menu, so no path around the lock).</td></tr>
<tr><td><code>editAs</code></td><td><span class="sig">int editAs(int op, int line, String text, String source)</span></td><td class="desc">Someone else changes the document (used for external changes). While the system is locked this is refused even during an editor choice session: the exemption is for the admin editing through the GUI only.</td></tr>
<tr><td><code>beginChoice</code></td><td><span class="sig">boolean beginChoice()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>endChoice</code></td><td><span class="sig">boolean endChoice(boolean revert)</span></td><td class="desc">End the session. With revert=true the document is put back exactly as it was when the session began. Returns true when something was reverted.</td></tr>
<tr><td><code>isDirty</code></td><td><span class="sig">boolean isDirty()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>markSaved</code></td><td><span class="sig">void markSaved()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>select</code></td><td><span class="sig">void select(int line)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>clampSelection</code></td><td><span class="sig">void clampSelection()</span></td><td class="desc">Keep the selection on a real line after the document changed.</td></tr>
<tr><td><code>ensureVisible</code></td><td><span class="sig">void ensureVisible(int rows)</span></td><td class="desc">Scroll so the selected line is inside a window of `rows` rows.</td></tr>
<tr><td><code>loadFrom</code></td><td><span class="sig">int loadFrom(SLGuiDocFile file, String filePath, boolean lockUnsplit)</span></td><td class="desc">Load a file into this (still empty) tab. Returns the load code.</td></tr>
<tr><td><code>saveTo</code></td><td><span class="sig">int saveTo(SLGuiDocFile file, String filePath)</span></td><td class="desc">Save to a path. Refused for a read-only tab. Returns the save code.</td></tr>
</table>
</div>
<h2 class="section" data-u="slguidocview">SLGuiDocView <span class="pill syntax">#sleela 3.0</span> <span class="muted" style="font-size:13px">(lib/guidoc/SLGuiDocView.sleela)</span></h2>
<div data-u="slguidocview slguidocview">
<h3 id="SLGuiDocView">SLGuiDocView <span class="pill">class</span></h3>
<p class="desc">Defines SLGuiDocView — the widget tree of the document GUI: the window, menu bar and menus, tab strip, editor (line gutter and rows), entry, status line and file dialog. Each node has a tag, text, white role (and so a style), visibility, enabled flag and a command; pressing a node latches it and the controller takes the latch. It is self-contained on purpose: a host walks nodeCount() / idAt() / tagAt() / textAt() / styleAt() to mount it on real widgets, and calls press(id) when one is activated.</p>
<div class="meta-note">Carries the standard <strong>Metadata Class record</strong> — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.</div>
<p class="muted"><strong>Fields</strong> — the named values this unit stores.</p>
<table class="members"><tr><th>Field</th><th>Declaration</th><th>What it holds</th></tr>
<tr><td><code>MAX_NODES</code></td><td><span class="sig">int MAX_NODES = 128</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>ids</code></td><td><span class="sig">String[] ids</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>tags</code></td><td><span class="sig">String[] tags</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>texts</code></td><td><span class="sig">String[] texts</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>roles</code></td><td><span class="sig">String[] roles</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>parents</code></td><td><span class="sig">String[] parents</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>cmds</code></td><td><span class="sig">String[] cmds</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>args</code></td><td><span class="sig">int[] args</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>enabled</code></td><td><span class="sig">int[] enabled</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>visible</code></td><td><span class="sig">int[] visible</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>latch</code></td><td><span class="sig">int[] latch</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>count</code></td><td><span class="sig">int count</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>white</code></td><td><span class="sig">SLGuiDocWhite white</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
</table>
<p class="muted"><strong>Methods</strong> — the actions this unit can perform.</p>
<table class="members"><tr><th>Method</th><th>Signature</th><th>What it does</th></tr>
<tr><td><code>configure</code></td><td><span class="sig">void configure(SLGuiDocWhite look)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>nodeCount</code></td><td><span class="sig">int nodeCount()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>idAt</code></td><td><span class="sig">String idAt(int i)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>tagAt</code></td><td><span class="sig">String tagAt(int i)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>textAt</code></td><td><span class="sig">String textAt(int i)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>roleAt</code></td><td><span class="sig">String roleAt(int i)</span></td><td class="desc">The white role of a node and the style string made from it.</td></tr>
<tr><td><code>styleAt</code></td><td><span class="sig">String styleAt(int i)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>parentAt</code></td><td><span class="sig">String parentAt(int i)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>commandAt</code></td><td><span class="sig">String commandAt(int i)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>argAt</code></td><td><span class="sig">int argAt(int i)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>visibleAt</code></td><td><span class="sig">boolean visibleAt(int i)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>enabledAt</code></td><td><span class="sig">boolean enabledAt(int i)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>indexOf</code></td><td><span class="sig">int indexOf(String id)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>add</code></td><td><span class="sig">boolean add(String parent, String tag, String id, String text, String role)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>bind</code></td><td><span class="sig">void bind(String id, String command, int arg)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>setText</code></td><td><span class="sig">void setText(String id, String t)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>textOf</code></td><td><span class="sig">String textOf(String id)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>setStyle</code></td><td><span class="sig">void setStyle(String id, String role)</span></td><td class="desc">Give a node a white role (its style follows).</td></tr>
<tr><td><code>roleOf</code></td><td><span class="sig">String roleOf(String id)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>styleOf</code></td><td><span class="sig">String styleOf(String id)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>setVisible</code></td><td><span class="sig">void setVisible(String id, boolean on)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>isVisible</code></td><td><span class="sig">boolean isVisible(String id)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>setEnabled</code></td><td><span class="sig">void setEnabled(String id, boolean on)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>isEnabled</code></td><td><span class="sig">boolean isEnabled(String id)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>type</code></td><td><span class="sig">void type(String id, String t)</span></td><td class="desc">A host reports the user typed into an entry.</td></tr>
<tr><td><code>press</code></td><td><span class="sig">boolean press(String id)</span></td><td class="desc">A host reports a node was activated. Only an enabled, visible node with a command latches; anything else is ignored.</td></tr>
<tr><td><code>takePress</code></td><td><span class="sig">int takePress()</span></td><td class="desc">Take one latched press (the lowest node index), or -1 when idle.</td></tr>
<tr><td><code>clearPresses</code></td><td><span class="sig">void clearPresses()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
</table>
</div>
<h2 class="section" data-u="slguidocwhite">SLGuiDocWhite <span class="pill syntax">#sleela 3.0</span> <span class="muted" style="font-size:13px">(lib/guidoc/SLGuiDocWhite.sleela)</span></h2>
<div data-u="slguidocwhite slguidocwhite">
<h3 id="SLGuiDocWhite">SLGuiDocWhite <span class="pill">class</span></h3>
<p class="desc">Defines SLGuiDocWhite — the white look of the document GUI. It takes the White flavor of the standard UI themes (lib/ui SLThemeFlavor: off-white background, white surfaces, dark ink, a single blue accent) and answers a style string for each role the GUI draws (window, menubar, tab, editor row, status, dialog ...). Every widget style in the document GUI comes from here, so the whole GUI stays white and consistent.</p>
<div class="meta-note">Carries the standard <strong>Metadata Class record</strong> — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.</div>
<p class="muted"><strong>Fields</strong> — the named values this unit stores.</p>
<table class="members"><tr><th>Field</th><th>Declaration</th><th>What it holds</th></tr>
<tr><td><code>theme</code></td><td><span class="sig">SLStandardTheme theme</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
</table>
<p class="muted"><strong>Methods</strong> — the actions this unit can perform.</p>
<table class="members"><tr><th>Method</th><th>Signature</th><th>What it does</th></tr>
<tr><td><code>configure</code></td><td><span class="sig">void configure()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>standardTheme</code></td><td><span class="sig">SLStandardTheme standardTheme()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>isWhite</code></td><td><span class="sig">boolean isWhite()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>name</code></td><td><span class="sig">String name()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>accentColor</code></td><td><span class="sig">String accentColor()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>roleAt</code></td><td><span class="sig">String roleAt(int i)</span></td><td class="desc">Every role the GUI draws, in a fixed order.</td></tr>
<tr><td><code>roleTotal</code></td><td><span class="sig">int roleTotal()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>bgOf</code></td><td><span class="sig">String bgOf(String role)</span></td><td class="desc">The background colour token of a role. Unknown roles use the surface.</td></tr>
<tr><td><code>fgOf</code></td><td><span class="sig">String fgOf(String role)</span></td><td class="desc">The foreground (ink) colour token of a role.</td></tr>
<tr><td><code>style</code></td><td><span class="sig">String style(String role)</span></td><td class="desc">The style for a role: bg:#RRGGBB;fg:#RRGGBB;</td></tr>
<tr><td><code>roleOfStyle</code></td><td><span class="sig">String roleOfStyle(String s)</span></td><td class="desc">The role a style string was made from, or &quot;&quot; if it is none of ours. A host uses this with bgOf and fgOf to get colour tokens without parsing text.</td></tr>
</table>
</div>
<script>function flt(q){q=q.toLowerCase();document.querySelectorAll('[data-u]').forEach(function(el){el.style.display = el.getAttribute('data-u').indexOf(q)>=0||q==''?'':'none';});}</script>
<footer>
Generated by <code>tools/generate-sleeladoc-api.py</code> from the live
<code>/lib</code> tree on 2026-11-16 00:48 UTC.
SleelaDoc — the SLeeLa documentation brand. SLeeLa — MEARVK LLC · Max Rupplin · UNCW, NCSU, Harvard · 2026 · George Soros 2507-2608.
</footer>
</main>
</div>
</body>
</html>