09f9090300b4

clojure-lanterna: Update site.
[view raw] [browse files]
author Steve Losh <steve@stevelosh.com>
date Mon, 25 Feb 2013 11:12:38 -0500
parents 9c78e1a01787
children 38fa67c580a2
branches/tags (none)
files clojure-lanterna/changelog/index.html clojure-lanterna/reference/index.html clojure-lanterna/terminals/index.html

Changes

--- a/clojure-lanterna/changelog/index.html	Thu Nov 08 12:55:55 2012 -0500
+++ b/clojure-lanterna/changelog/index.html	Mon Feb 25 11:12:38 2013 -0500
@@ -3,7 +3,10 @@
         <div class="wrap">
             <header><h1><a href="..">clojure-lanterna</a></h1></header><div class="markdown">
 <h1 id="changelog"><a href="">Changelog</a></h1><p>Here's the list of changes in each released version.</p>
-<h2 id="v092">v0.9.2</h2>
+<h2 id="v093">v0.9.3</h2>
+<ul><li><code>get-key-blocking</code> now accepts optional arguments for timeout and interval.</li>
+<li>Added <code>remove-resize-listener</code> functions for Screens and Terminals.</li>
+</ul><h2 id="v092">v0.9.2</h2>
 <ul><li>Added an experimental <code>put-sheet</code> function for screens.  Don't rely on this
   yet -- it's subject to change.</li>
 <li>Relies on a stable release of Lanterna once more.</li>
--- a/clojure-lanterna/reference/index.html	Thu Nov 08 12:55:55 2012 -0500
+++ b/clojure-lanterna/reference/index.html	Mon Feb 25 11:12:38 2013 -0500
@@ -32,6 +32,7 @@
 <li><a href="#lanternaterminalget-key">lanterna.terminal/get-key</a></li>
 <li><a href="#lanternaterminalget-key-blocking">lanterna.terminal/get-key-blocking</a></li>
 <li><a href="#lanternaterminaladd-resize-listener">lanterna.terminal/add-resize-listener</a></li>
+<li><a href="#lanternaterminalremove-resize-listener">lanterna.terminal/remove-resize-listener</a></li>
 <li><a href="#lanternaterminalget-available-fonts">lanterna.terminal/get-available-fonts</a></li>
 </ul></li>
 <li><a href="#screens">Screens</a><ul><li><a href="#lanternascreenget-screen">lanterna.screen/get-screen</a></li>
@@ -46,6 +47,7 @@
 <li><a href="#lanternascreenget-key">lanterna.screen/get-key</a></li>
 <li><a href="#lanternascreenget-key-blocking">lanterna.screen/get-key-blocking</a></li>
 <li><a href="#lanternascreenadd-resize-listener">lanterna.screen/add-resize-listener</a></li>
+<li><a href="#lanternascreenremove-resize-listener">lanterna.screen/remove-resize-listener</a></li>
 </ul></li>
 </ul></div>
 <h2 id="constants">Constants</h2>
@@ -278,6 +280,7 @@
 <a href="#lanternaterminalget-key-blocking"><code>get-key-blocking</code></a> instead.</p>
 <h3 id="lanternaterminalget-key-blocking">lanterna.terminal/get-key-blocking</h3>
 <div class="codehilite"><pre><span class="p">(</span><span class="nf">get-key-blocking</span> <span class="nv">terminal</span><span class="p">)</span>
+<span class="p">(</span><span class="nf">get-key-blocking</span> <span class="nv">terminal</span> <span class="nv">options</span><span class="p">)</span>
 </pre></div>
 
 
@@ -290,7 +293,11 @@
 off and returned as normal.</p>
 <p>If you want to return immediately instead of blocking when no input is buffered,
 use <a href="#lanternaterminalget-key"><code>get-key</code></a> instead.</p>
-<h3 id="lanternaterminaladd-resize-listener">lanterna.terminal/add-resize-listener</h3>
+<p>The <code>options</code> map can contain any of the following mappings:</p>
+<ul><li><code>:interval</code> - The interval between checks, in milliseconds (default <code>50</code>).</li>
+<li><code>:timeout</code> - The maximum amount of time blocking will occur before returning
+  <code>nil</code> (default infinity).</li>
+</ul><h3 id="lanternaterminaladd-resize-listener">lanterna.terminal/add-resize-listener</h3>
 <div class="codehilite"><pre><span class="p">(</span><span class="nf">add-resize-listener</span> <span class="nv">terminal</span> <span class="nv">listener-fn</span><span class="p">)</span>
 </pre></div>
 
@@ -302,6 +309,12 @@
 <p>You probably don't need this because you can specify a resize listener function
 when you call <a href="#lanternaterminalget-terminal"><code>get-terminal</code></a>.  It's here if you
 <em>do</em> need it though.</p>
+<h3 id="lanternaterminalremove-resize-listener">lanterna.terminal/remove-resize-listener</h3>
+<div class="codehilite"><pre><span class="p">(</span><span class="nf">remove-resize-listener</span> <span class="nv">terminal</span> <span class="nv">listener</span><span class="p">)</span>
+</pre></div>
+
+
+<p>Remove the given resize listener from the given terminal.</p>
 <h3 id="lanternaterminalget-available-fonts">lanterna.terminal/get-available-fonts</h3>
 <div class="codehilite"><pre><span class="p">(</span><span class="nf">get-available-fonts</span><span class="p">)</span>
 </pre></div>
@@ -447,7 +460,11 @@
 off and returned as normal.</p>
 <p>If you want to return immediately instead of blocking when no input is buffered,
 use <a href="#lanternascreenget-key"><code>get-key</code></a> instead.</p>
-<h3 id="lanternascreenadd-resize-listener">lanterna.screen/add-resize-listener</h3>
+<p>The <code>options</code> map can contain any of the following mappings:</p>
+<ul><li><code>:interval</code> - The interval between checks, in milliseconds (default <code>50</code>).</li>
+<li><code>:timeout</code> - The maximum amount of time blocking will occur before returning
+  <code>nil</code> (default infinity).</li>
+</ul><h3 id="lanternascreenadd-resize-listener">lanterna.screen/add-resize-listener</h3>
 <div class="codehilite"><pre><span class="p">(</span><span class="nf">add-resize-listener</span> <span class="nv">screen</span> <span class="nv">listener-fn</span><span class="p">)</span>
 </pre></div>
 
@@ -459,6 +476,12 @@
 <p>You probably don't need this because you can specify a resize listener function
 when you call <a href="#lanternascreenget-screen"><code>get-screen</code></a>.  It's here if you <em>do</em>
 need it though.</p>
+<h3 id="lanternascreenremove-resize-listener">lanterna.screen/remove-resize-listener</h3>
+<div class="codehilite"><pre><span class="p">(</span><span class="nf">remove-resize-listener</span> <span class="nv">screen</span> <span class="nv">listener</span><span class="p">)</span>
+</pre></div>
+
+
+<p>Remove the given resize listener from the given screen.</p>
                 </div>
             <footer><p>Created by <a href="http://stevelosh.com">Steve Losh</a>.
 Documentation created with <a href="http://sjl.bitbucket.org/d/">d</a>.</p>
--- a/clojure-lanterna/terminals/index.html	Thu Nov 08 12:55:55 2012 -0500
+++ b/clojure-lanterna/terminals/index.html	Mon Feb 25 11:12:38 2013 -0500
@@ -142,6 +142,16 @@
 </pre></div>
 
 
+<p><code>get-key-blocking</code> optionally accepts a check interval and/or timeout:</p>
+<div class="codehilite"><pre><span class="p">(</span><span class="nf">t/get-key-blocking</span> <span class="nv">term</span> <span class="p">{</span><span class="ss">:interval</span> <span class="mi">100</span> <span class="ss">:timeout</span> <span class="mi">5000</span><span class="p">})</span>
+<span class="c1">;</span>
+<span class="c1">; Key presses will be checked for every 100 msecs. If you wait</span>
+<span class="c1">; 5 seconds, nil will be returned.</span>
+<span class="c1">;</span>
+<span class="c1">; =&gt; nil</span>
+</pre></div>
+
+
 <p>Normal alphanumeric keys are returned as simple Character objects like <code>\a</code>.</p>
 <p>Note that there's no special attribute to determine if the Shift key was
 pressed, but the Characters will be the correct ones.  For example, if the user