Publishing from martanne/vis 1d37e5c

doc/index.html

@@ -61,7 +61,7 @@ <h1>Module <code>vis</code></h1>
 </p>
     <h3>Info:</h3>
     <ul>
-        <li><strong>Release</strong>: 8be1f68</li>
+        <li><strong>Release</strong>: 1d37e5c</li>
         <li><strong>License</strong>: ISC</li>
         <li><strong>Author</strong>: Marc André Tanner</li>
     </ul>
@@ -324,6 +324,10 @@ <h2><a href="#Class_Window">Class Window </a></h2>
 	<td class="summary">Define a display style.</td>
 	</tr>
 	<tr>
+	<td class="name" nowrap><a href="#Window:style_pos">Window:style_pos(id, x, y)</a></td>
+	<td class="summary">Style the single terminal cell at the given coordinates, relative to this window.</td>
+	</tr>
+	<tr>
 	<td class="name" nowrap><a href="#Window:unmap">Window:unmap(...)</a></td>
 	<td class="summary">Remove a window local key mapping.</td>
 	</tr>
@@ -513,6 +517,10 @@ <h2><a href="#Core_Events">Core Events </a></h2>
 	<td class="summary">CSI command received from terminal.</td>
 	</tr>
 	<tr>
+	<td class="name" nowrap><a href="#ui_draw">ui_draw()</a></td>
+	<td class="summary">Emitted immediately before the UI is drawn to the screen.</td>
+	</tr>
+	<tr>
 	<td class="name" nowrap><a href="#win_close">win_close(win)</a></td>
 	<td class="summary">Window close.</td>
 	</tr>
@@ -2158,11 +2166,19 @@ <h3>Fields:</h3>
     <ul>
         <li><span class="parameter">bytes</span>
             <span class="types"><a class="type" href="index.html#Class_Range">Range</a></span>
-
+         file bytes, from 0, at the start and end of the viewport
         </li>
         <li><span class="parameter">lines</span>
             <span class="types"><a class="type" href="index.html#Class_Range">Range</a></span>
-
+         file lines, from 1, at the top and bottom of the viewport
+        </li>
+        <li><span class="parameter">height</span>
+            <span class="types"><span class="type">int</span></span>
+         lines in viewport, accounting for window decoration
+        </li>
+        <li><span class="parameter">width</span>
+            <span class="types"><span class="type">int</span></span>
+         columns in viewport, accounting for window decoration
         </li>
     </ul>
 
@@ -2414,6 +2430,53 @@ <h3>Usage:</h3>
         <pre class="example">win:style_define(win.STYLE_DEFAULT, <span class="string">"fore:red"</span>)</pre>
     </ul>
 
+</dd>
+    <dt>
+    <a name = "Window:style_pos"></a>
+    <strong>Window:style_pos(id, x, y)</strong>
+    </dt>
+    <dd>
+    Style the single terminal cell at the given coordinates, relative to this window.
+<p> Completely independent of the file buffer, and can be used to style UI elements,
+ such as the status bar.
+ The style will be cleared after every window redraw.
+
+
+    <h3>Parameters:</h3>
+    <ul>
+        <li><span class="parameter">id</span>
+            <span class="types"><span class="type">int</span></span>
+         display style registered with <a href="index.html#Window:style_define">style_define</a>
+        </li>
+        <li><span class="parameter">x</span>
+            <span class="types"><span class="type">int</span></span>
+         0-based x coordinate within Win, where (0,0) is the top left corner
+        </li>
+        <li><span class="parameter">y</span>
+            <span class="types"><span class="type">int</span></span>
+         See above
+        </li>
+    </ul>
+
+    <h3>Returns:</h3>
+    <ol>
+
+           <span class="types"><span class="type">bool</span></span>
+        false if the coordinates would be outside the window's dimensions
+    </ol>
+
+
+    <h3>See also:</h3>
+    <ul>
+         <a href="index.html#Window:style_define">style_define</a>
+    </ul>
+
+    <h3>Usage:</h3>
+    <ul>
+        <pre class="example">win:style_pos(win.STYLE_COLOR_COLUMN, <span class="number">0</span>, win.height - <span class="number">1</span>)
+<span class="comment">-- Styles the first character of the status bar (or the last line, if disabled)</span></pre>
+    </ul>
+
 </dd>
     <dt>
     <a name = "Window:unmap"></a>
@@ -3590,6 +3653,23 @@ <h3>Parameters:</h3>
 
 
 
+</dd>
+    <dt>
+    <a name = "ui_draw"></a>
+    <strong>ui_draw()</strong>
+    </dt>
+    <dd>
+    Emitted immediately before the UI is drawn to the screen.
+ Allows last-minute overrides to the styling of UI elements.
+<p> *WARNING:* This is emitted every screen draw!
+ Use sparingly and check for `nil` values!
+
+
+
+
+
+
+
 </dd>
     <dt>
     <a name = "win_close"></a>
@@ -3752,6 +3832,9 @@ <h3>Fields:</h3>
         <li><span class="parameter">PROCESS_RESPONSE</span>
         see <a href="index.html#process_response">process_response</a>
         </li>
+        <li><span class="parameter">UI_DRAW</span>
+        see <a href="index.html#ui_draw">ui_draw</a>
+        </li>
     </ul>
 
 
@@ -3865,7 +3948,7 @@ <h3>Returns:</h3>
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
-<i style="float:right;">Last updated 2024-04-29 14:29:54 </i>
+<i style="float:right;">Last updated 2024-04-29 15:12:42 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>