HTML documentation

This commit is contained in:
David Botton 2020-12-24 22:02:30 -05:00
parent 5589cde897
commit 979012e7c4
9 changed files with 1057 additions and 10 deletions

View file

@ -1,4 +1,3 @@
# CLOG - The Common Lisp Omnificent GUI # CLOG - The Common Lisp Omnificent GUI
## David Botton <david@botton.com> ## David Botton <david@botton.com>
@ -18,13 +17,6 @@ To load this package and use the tests:
3. In the REPL run (ql:quickload :clog) 3. In the REPL run (ql:quickload :clog)
4. Then (load "~/common-lisp/clog/test/test-clog.lisp) (clog-test:test) 4. Then (load "~/common-lisp/clog/test/test-clog.lisp) (clog-test:test)
Documentation for CLOG in markdown can be generated with
(clog:make-markup)
or by running the script if you have ecl installed - make-manual-ecl
Sample CLOG app with code base so far: Sample CLOG app with code base so far:
``` ```

View file

@ -156,3 +156,16 @@ application."
(load "clog-body.lisp") (load "clog-body.lisp")
(describe clog:@CLOG-MANUAL)) (describe clog:@CLOG-MANUAL))
(export 'make-html)
(defun make-html ()
(load "clog.lisp")
(load "clog-base.lisp")
(load "clog-window.lisp")
(load "clog-navigator.lisp")
(load "clog-document.lisp")
(load "clog-location.lisp")
(load "clog-system.lisp")
(load "clog-utilities.lisp")
(load "clog-body.lisp")
(mgl-pax:update-asdf-system-html-docs clog:@CLOG-MANUAL :clog))

696
doc/clog-manual.html Normal file
View file

@ -0,0 +1,696 @@
<!DOCTYPE html>
<html xmlns='http://www.w3.org/1999/xhtml' xml:lang='en' lang='en'>
<head>
<title>The CLOG manual</title>
<link type='text/css' href='style.css' rel='stylesheet'/>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<script src="jquery.min.js"></script>
<script src="toc.min.js"></script>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
tex2jax: {
inlineMath: [['$','$']],
processEscapes: true
}
});
</script>
<script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS_HTML">
</script>
</head>
<body>
<div id="content-container">
<div id="toc">
<div id="page-toc">
</div>
<div id="toc-footer"><ul><li><a href="https://github.com/melisgl/mgl-pax">[generated by MGL-PAX]</a></li></ul></div>
</div>
<div id="content">
<p><a id='x-28CLOG-3A-40CLOG-MANUAL-20MGL-PAX-3ASECTION-29'></a></p>
<p><span class="outer-navigation"><span class="navigation"> <a href="#x-28-22clog-22-20ASDF-2FSYSTEM-3ASYSTEM-29" title="(\&quot;clog\&quot; ASDF/SYSTEM:SYSTEM)">&#8594;</a> <a href="#x-28CLOG-3A-40CLOG-MANUAL-20MGL-PAX-3ASECTION-29" title="The CLOG manual">&#8634;</a></span></span></p>
<h1><a href="#x-28CLOG-3A-40CLOG-MANUAL-20MGL-PAX-3ASECTION-29">The CLOG manual</a></h1>
<h2>Table of Contents</h2>
<ul>
<li><a href="#x-28-22clog-22-20ASDF-2FSYSTEM-3ASYSTEM-29" title="(\&quot;clog\&quot; ASDF/SYSTEM:SYSTEM)">1 clog ASDF System Details</a></li>
<li><a href="#x-28CLOG-3A-40CLOG-SYSTEM-20MGL-PAX-3ASECTION-29" title="CLOG System">2 CLOG System</a></li>
<li><a href="#x-28CLOG-3A-40CLOG-UTILITIES-20MGL-PAX-3ASECTION-29" title="CLOG Utilities">3 CLOG Utilities</a></li>
<li><a href="#x-28CLOG-3A-40CLOG-OBJ-20MGL-PAX-3ASECTION-29" title="CLOG Objects">4 CLOG Objects</a></li>
<li><a href="#x-28CLOG-3A-40CLOG-BODY-20MGL-PAX-3ASECTION-29" title="CLOG Body Objects">5 CLOG Body Objects</a></li>
<li><a href="#x-28CLOG-3A-40CLOG-WINDOW-20MGL-PAX-3ASECTION-29" title="CLOG Window Objects">6 CLOG Window Objects</a></li>
<li><a href="#x-28CLOG-3A-40CLOG-DOCUMENT-20MGL-PAX-3ASECTION-29" title="CLOG Document Objects">7 CLOG Document Objects</a></li>
<li><a href="#x-28CLOG-3A-40CLOG-LOCATION-20MGL-PAX-3ASECTION-29" title="CLOG Location Objects">8 CLOG Location Objects</a></li>
<li><a href="#x-28CLOG-3A-40CLOG-NAVIGATOR-20MGL-PAX-3ASECTION-29" title="CLOG Navigator Objects">9 CLOG Navigator Objects</a></li>
</ul>
<h6>[in package CLOG]</h6>
<p>The Common Lisp Omnificient GUI, <a href="#x-28-22clog-22-20ASDF-2FSYSTEM-3ASYSTEM-29" title="(\&quot;clog\&quot; ASDF/SYSTEM:SYSTEM)"><code>CLOG</code></a> for short, uses web technology
to produce graphical user interfaces for applications locally or
remotely. The <a href="#x-28-22clog-22-20ASDF-2FSYSTEM-3ASYSTEM-29" title="(\&quot;clog\&quot; ASDF/SYSTEM:SYSTEM)"><code>CLOG</code></a> package starts up the connectivity to the browser
or other websocket client (often a browser embedded in a native
application.</p>
<p><a id='x-28-22clog-22-20ASDF-2FSYSTEM-3ASYSTEM-29'></a></p>
<p><span class="outer-navigation"><span class="navigation"> <a href="#x-28CLOG-3A-40CLOG-MANUAL-20MGL-PAX-3ASECTION-29" title="The CLOG manual">&#8592;</a> <a href="#x-28CLOG-3A-40CLOG-MANUAL-20MGL-PAX-3ASECTION-29" title="The CLOG manual">&#8593;</a> <a href="#x-28CLOG-3A-40CLOG-SYSTEM-20MGL-PAX-3ASECTION-29" title="CLOG System">&#8594;</a> <a href="#x-28-22clog-22-20ASDF-2FSYSTEM-3ASYSTEM-29" title="(\&quot;clog\&quot; ASDF/SYSTEM:SYSTEM)">&#8634;</a></span></span></p>
<h2><a href="#x-28-22clog-22-20ASDF-2FSYSTEM-3ASYSTEM-29">1 clog ASDF System Details</a></h2>
<ul>
<li>Version: 0.0.1</li>
<li>Description: The Common Lisp Omnificent GUI</li>
<li>Licence: BSD</li>
<li>Author: David Botton <a href="m&#x61;&#105;l&#x74;&#111;:&#x64;&#97;v&#x69;&#100;@&#x62;&#111;t&#x74;&#111;n&#x2E;&#99;o&#x6D;">m&#x61;&#105;l&#x74;&#111;:&#x64;&#97;v&#x69;&#100;@&#x62;&#111;t&#x74;&#111;n&#x2E;&#99;o&#x6D;</a></li>
</ul>
<p><a id='x-28CLOG-3A-40CLOG-SYSTEM-20MGL-PAX-3ASECTION-29'></a></p>
<p><span class="outer-navigation"><span class="navigation"> <a href="#x-28-22clog-22-20ASDF-2FSYSTEM-3ASYSTEM-29" title="(\&quot;clog\&quot; ASDF/SYSTEM:SYSTEM)">&#8592;</a> <a href="#x-28CLOG-3A-40CLOG-MANUAL-20MGL-PAX-3ASECTION-29" title="The CLOG manual">&#8593;</a> <a href="#x-28CLOG-3A-40CLOG-UTILITIES-20MGL-PAX-3ASECTION-29" title="CLOG Utilities">&#8594;</a> <a href="#x-28CLOG-3A-40CLOG-SYSTEM-20MGL-PAX-3ASECTION-29" title="CLOG System">&#8634;</a></span></span></p>
<h2><a href="#x-28CLOG-3A-40CLOG-SYSTEM-20MGL-PAX-3ASECTION-29">2 CLOG System</a></h2>
<p><a href="#x-28-22clog-22-20ASDF-2FSYSTEM-3ASYSTEM-29" title="(\&quot;clog\&quot; ASDF/SYSTEM:SYSTEM)"><code>CLOG</code></a> Startup and Shutdown</p>
<p><a id='x-28CLOG-3AINITIALIZE-20FUNCTION-29'></a></p>
<ul>
<li><p><span class=reference-bullet><span class=reference><span class="locative-type">[function]</span> <span class="reference-object"><a href="#x-28CLOG-3AINITIALIZE-20FUNCTION-29" >INITIALIZE</a></span></span> <span class="locative-args">ON-NEW-WINDOW &amp;KEY (HOST &quot;0.0.0.0&quot;) (PORT 8080) (BOOT-FILE &quot;/boot.html&quot;) (STATIC-ROOT #P&quot;static-files/&quot;)</span></span></p>
<p>Inititalze <a href="#x-28-22clog-22-20ASDF-2FSYSTEM-3ASYSTEM-29" title="(\&quot;clog\&quot; ASDF/SYSTEM:SYSTEM)"><code>CLOG</code></a> on a socket using <code>HOST</code> and <code>PORT</code> to serve <code>BOOT-FILE</code> as
the default route to establish web-socket connections and static files
located at <code>STATIC-ROOT</code>.</p></li>
</ul>
<p><a id='x-28CLOG-3ASHUTDOWN-20FUNCTION-29'></a></p>
<ul>
<li><p><span class=reference-bullet><span class=reference><span class="locative-type">[function]</span> <span class="reference-object"><a href="#x-28CLOG-3ASHUTDOWN-20FUNCTION-29" >SHUTDOWN</a></span></span> <span class="locative-args"></span></span></p>
<p>Shutdown <a href="#x-28-22clog-22-20ASDF-2FSYSTEM-3ASYSTEM-29" title="(\&quot;clog\&quot; ASDF/SYSTEM:SYSTEM)"><code>CLOG</code></a>.</p></li>
</ul>
<p><a id='x-28CLOG-3A-40CLOG-UTILITIES-20MGL-PAX-3ASECTION-29'></a></p>
<p><span class="outer-navigation"><span class="navigation"> <a href="#x-28CLOG-3A-40CLOG-SYSTEM-20MGL-PAX-3ASECTION-29" title="CLOG System">&#8592;</a> <a href="#x-28CLOG-3A-40CLOG-MANUAL-20MGL-PAX-3ASECTION-29" title="The CLOG manual">&#8593;</a> <a href="#x-28CLOG-3A-40CLOG-OBJ-20MGL-PAX-3ASECTION-29" title="CLOG Objects">&#8594;</a> <a href="#x-28CLOG-3A-40CLOG-UTILITIES-20MGL-PAX-3ASECTION-29" title="CLOG Utilities">&#8634;</a></span></span></p>
<h2><a href="#x-28CLOG-3A-40CLOG-UTILITIES-20MGL-PAX-3ASECTION-29">3 CLOG Utilities</a></h2>
<p><a href="#x-28-22clog-22-20ASDF-2FSYSTEM-3ASYSTEM-29" title="(\&quot;clog\&quot; ASDF/SYSTEM:SYSTEM)"><code>CLOG</code></a> utilities</p>
<p><a id='x-28CLOG-3AJS-TRUE-P-20FUNCTION-29'></a></p>
<ul>
<li><p><span class=reference-bullet><span class=reference><span class="locative-type">[function]</span> <span class="reference-object"><a href="#x-28CLOG-3AJS-TRUE-P-20FUNCTION-29" >JS-TRUE-P</a></span></span> <span class="locative-args">VALUE</span></span></p>
<p>Return true if <code>VALUE</code> equalp the string true</p></li>
</ul>
<p><a id='x-28CLOG-3AOPEN-BROWSER-20FUNCTION-29'></a></p>
<ul>
<li><p><span class=reference-bullet><span class=reference><span class="locative-type">[function]</span> <span class="reference-object"><a href="#x-28CLOG-3AOPEN-BROWSER-20FUNCTION-29" >OPEN-BROWSER</a></span></span> <span class="locative-args">&amp;KEY (URL &quot;http://127.0.0.1:8080&quot;)</span></span></p>
<p>Open a web browser to <code>URL</code>.</p></li>
</ul>
<p><a id='x-28CLOG-3A-40CLOG-OBJ-20MGL-PAX-3ASECTION-29'></a></p>
<p><span class="outer-navigation"><span class="navigation"> <a href="#x-28CLOG-3A-40CLOG-UTILITIES-20MGL-PAX-3ASECTION-29" title="CLOG Utilities">&#8592;</a> <a href="#x-28CLOG-3A-40CLOG-MANUAL-20MGL-PAX-3ASECTION-29" title="The CLOG manual">&#8593;</a> <a href="#x-28CLOG-3A-40CLOG-BODY-20MGL-PAX-3ASECTION-29" title="CLOG Body Objects">&#8594;</a> <a href="#x-28CLOG-3A-40CLOG-OBJ-20MGL-PAX-3ASECTION-29" title="CLOG Objects">&#8634;</a></span></span></p>
<h2><a href="#x-28CLOG-3A-40CLOG-OBJ-20MGL-PAX-3ASECTION-29">4 CLOG Objects</a></h2>
<p>CLOG-Obj - Base class for <a href="#x-28-22clog-22-20ASDF-2FSYSTEM-3ASYSTEM-29" title="(\&quot;clog\&quot; ASDF/SYSTEM:SYSTEM)"><code>CLOG</code></a> Objects</p>
<p><a id='x-28CLOG-3ACLOG-OBJ-20CLASS-29'></a></p>
<ul>
<li><p><span class=reference-bullet><span class=reference><span class="locative-type">[class]</span> <span class="reference-object"><a href="#x-28CLOG-3ACLOG-OBJ-20CLASS-29" >CLOG-OBJ</a></span></span></span></p>
<p><a href="#x-28-22clog-22-20ASDF-2FSYSTEM-3ASYSTEM-29" title="(\&quot;clog\&quot; ASDF/SYSTEM:SYSTEM)"><code>CLOG</code></a> objects (clog-obj) encapsulate the connection between
lisp and the <code>HTML</code> DOM element.</p></li>
</ul>
<p>CLOG-Obj - General Properties</p>
<p><a id='x-28CLOG-3APROPERTY-20GENERIC-FUNCTION-29'></a></p>
<ul>
<li><p><span class=reference-bullet><span class=reference><span class="locative-type">[generic-function]</span> <span class="reference-object"><a href="#x-28CLOG-3APROPERTY-20GENERIC-FUNCTION-29" >PROPERTY</a></span></span> <span class="locative-args">CLOG-OBJ PROPERTY-NAME</span></span></p>
<p>Get/Setf html property. (eg. draggable)</p></li>
</ul>
<p><a id='x-28CLOG-3ASTYLE-20GENERIC-FUNCTION-29'></a></p>
<ul>
<li><p><span class=reference-bullet><span class=reference><span class="locative-type">[generic-function]</span> <span class="reference-object"><a href="#x-28CLOG-3ASTYLE-20GENERIC-FUNCTION-29" >STYLE</a></span></span> <span class="locative-args">CLOG-OBJ STYLE-NAME</span></span></p>
<p>Get/Setf css style.</p></li>
</ul>
<p><a id='x-28CLOG-3AATTRIBUTE-20GENERIC-FUNCTION-29'></a></p>
<ul>
<li><p><span class=reference-bullet><span class=reference><span class="locative-type">[generic-function]</span> <span class="reference-object"><a href="#x-28CLOG-3AATTRIBUTE-20GENERIC-FUNCTION-29" >ATTRIBUTE</a></span></span> <span class="locative-args">CLOG-OBJ ATTRIBUTE-NAME</span></span></p>
<p>Get/Setf html tag attribute. (eg. src on img tag)</p></li>
</ul>
<p>CLOG-Obj - General Methods</p>
<p><a id='x-28CLOG-3AHEIGHT-20GENERIC-FUNCTION-29'></a></p>
<ul>
<li><p><span class=reference-bullet><span class=reference><span class="locative-type">[generic-function]</span> <span class="reference-object"><a href="#x-28CLOG-3AHEIGHT-20GENERIC-FUNCTION-29" >HEIGHT</a></span></span> <span class="locative-args">CLOG-OBJ</span></span></p>
<p>Get/Setf html height in pixels.</p></li>
</ul>
<p><a id='x-28CLOG-3AWIDTH-20GENERIC-FUNCTION-29'></a></p>
<ul>
<li><p><span class=reference-bullet><span class=reference><span class="locative-type">[generic-function]</span> <span class="reference-object"><a href="#x-28CLOG-3AWIDTH-20GENERIC-FUNCTION-29" >WIDTH</a></span></span> <span class="locative-args">CLOG-OBJ</span></span></p>
<p>Get/Setf html width in pixels.</p></li>
</ul>
<p><a id='x-28CLOG-3AFOCUS-20GENERIC-FUNCTION-29'></a></p>
<ul>
<li><p><span class=reference-bullet><span class=reference><span class="locative-type">[generic-function]</span> <span class="reference-object"><a href="#x-28CLOG-3AFOCUS-20GENERIC-FUNCTION-29" >FOCUS</a></span></span> <span class="locative-args">CLOG-OBJ</span></span></p>
<p>Focus on <code>CLOG-OBJ</code></p></li>
</ul>
<p><a id='x-28CLOG-3ABLUR-20GENERIC-FUNCTION-29'></a></p>
<ul>
<li><p><span class=reference-bullet><span class=reference><span class="locative-type">[generic-function]</span> <span class="reference-object"><a href="#x-28CLOG-3ABLUR-20GENERIC-FUNCTION-29" >BLUR</a></span></span> <span class="locative-args">CLOG-OBJ</span></span></p>
<p>Remove focus from <code>CLOG-OBJ</code></p></li>
</ul>
<p>CLOG-Obj - Placement</p>
<p><a id='x-28CLOG-3APLACE-AFTER-20GENERIC-FUNCTION-29'></a></p>
<ul>
<li><p><span class=reference-bullet><span class=reference><span class="locative-type">[generic-function]</span> <span class="reference-object"><a href="#x-28CLOG-3APLACE-AFTER-20GENERIC-FUNCTION-29" >PLACE-AFTER</a></span></span> <span class="locative-args">CLOG-OBJ NEXT-OBJ</span></span></p>
<p>Places <code>NEXT-OBJ</code> after <code>CLOG-OBJ</code> in DOM</p></li>
</ul>
<p><a id='x-28CLOG-3APLACE-BEFORE-20GENERIC-FUNCTION-29'></a></p>
<ul>
<li><p><span class=reference-bullet><span class=reference><span class="locative-type">[generic-function]</span> <span class="reference-object"><a href="#x-28CLOG-3APLACE-BEFORE-20GENERIC-FUNCTION-29" >PLACE-BEFORE</a></span></span> <span class="locative-args">CLOG-OBJ NEXT-OBJ</span></span></p>
<p>Places <code>NEXT-OBJ</code> before <code>CLOG-OBJ</code> in DOM</p></li>
</ul>
<p><a id='x-28CLOG-3APLACE-INSIDE-TOP-OF-20GENERIC-FUNCTION-29'></a></p>
<ul>
<li><p><span class=reference-bullet><span class=reference><span class="locative-type">[generic-function]</span> <span class="reference-object"><a href="#x-28CLOG-3APLACE-INSIDE-TOP-OF-20GENERIC-FUNCTION-29" >PLACE-INSIDE-TOP-OF</a></span></span> <span class="locative-args">CLOG-OBJ NEXT-OBJ</span></span></p>
<p>Places <code>NEXT-OBJ</code> inside top of <code>CLOG-OBJ</code> in DOM</p></li>
</ul>
<p><a id='x-28CLOG-3APLACE-INSIDE-BOTTOM-OF-20GENERIC-FUNCTION-29'></a></p>
<ul>
<li><p><span class=reference-bullet><span class=reference><span class="locative-type">[generic-function]</span> <span class="reference-object"><a href="#x-28CLOG-3APLACE-INSIDE-BOTTOM-OF-20GENERIC-FUNCTION-29" >PLACE-INSIDE-BOTTOM-OF</a></span></span> <span class="locative-args">CLOG-OBJ NEXT-OBJ</span></span></p>
<p>Places <code>NEXT-OBJ</code> inside bottom of <code>CLOG-OBJ</code> in DOM</p></li>
</ul>
<p>CLOG-Obj - Low Level</p>
<p><a id='x-28CLOG-3ACREATE-CHILD-20GENERIC-FUNCTION-29'></a></p>
<ul>
<li><p><span class=reference-bullet><span class=reference><span class="locative-type">[generic-function]</span> <span class="reference-object"><a href="#x-28CLOG-3ACREATE-CHILD-20GENERIC-FUNCTION-29" >CREATE-CHILD</a></span></span> <span class="locative-args">CLOG-OBJ HTML &amp;KEY AUTO-PLACE</span></span></p>
<p>Create a new <code>CLOG-OBJ</code> from <code>HTML</code> element as child of <code>OBJ</code> and if <code>:AUTO-PLACE</code> (default t)
place-inside-bottom-of <code>OBJ</code></p></li>
</ul>
<p><a id='x-28CLOG-3AATTACH-AS-CHILD-20GENERIC-FUNCTION-29'></a></p>
<ul>
<li><p><span class=reference-bullet><span class=reference><span class="locative-type">[generic-function]</span> <span class="reference-object"><a href="#x-28CLOG-3AATTACH-AS-CHILD-20GENERIC-FUNCTION-29" >ATTACH-AS-CHILD</a></span></span> <span class="locative-args">CLOG-OBJ HTML-ID</span></span></p>
<p>Create a new <code>CLOG-OBJ</code> and attach an existing element with <code>HTML-ID</code>. The
<code>HTML-ID</code> must be unique.</p></li>
</ul>
<p><a id='x-28CLOG-3ACONNECTION-DATA-20GENERIC-FUNCTION-29'></a></p>
<ul>
<li><p><span class=reference-bullet><span class=reference><span class="locative-type">[generic-function]</span> <span class="reference-object"><a href="#x-28CLOG-3ACONNECTION-DATA-20GENERIC-FUNCTION-29" >CONNECTION-DATA</a></span></span> <span class="locative-args">CLOG-OBJ</span></span></p>
<p>Get connection-data that is associated with
clog-obj that will persist regardless of thread. The event hooks
are stored in this string based hash in the format of:
&quot;html-id:event-name&quot; =&gt; event-handler.</p></li>
</ul>
<p><a id='x-28CLOG-3AVALIDP-20GENERIC-FUNCTION-29'></a></p>
<ul>
<li><p><span class=reference-bullet><span class=reference><span class="locative-type">[generic-function]</span> <span class="reference-object"><a href="#x-28CLOG-3AVALIDP-20GENERIC-FUNCTION-29" >VALIDP</a></span></span> <span class="locative-args">CLOG-OBJ</span></span></p>
<p>Returns true of connection is valid on this <code>CLOG-OBJ</code>.</p></li>
</ul>
<p>CLOG-Obj - Event Handling</p>
<p><a id='x-28CLOG-3ASET-ON-RESIZE-20GENERIC-FUNCTION-29'></a></p>
<ul>
<li><p><span class=reference-bullet><span class=reference><span class="locative-type">[generic-function]</span> <span class="reference-object"><a href="#x-28CLOG-3ASET-ON-RESIZE-20GENERIC-FUNCTION-29" >SET-ON-RESIZE</a></span></span> <span class="locative-args">CLOG-OBJ ON-RESIZE-HANDLER</span></span></p>
<p>Set the <code>ON-RESIZE-HANDLER</code> for <code>CLOG-OBJ</code>. If <code>ON-RESIZE-HANDLER</code>
is nil unbind the event.</p></li>
</ul>
<p><a id='x-28CLOG-3ASET-ON-FOCUS-20GENERIC-FUNCTION-29'></a></p>
<ul>
<li><p><span class=reference-bullet><span class=reference><span class="locative-type">[generic-function]</span> <span class="reference-object"><a href="#x-28CLOG-3ASET-ON-FOCUS-20GENERIC-FUNCTION-29" >SET-ON-FOCUS</a></span></span> <span class="locative-args">CLOG-OBJ ON-FOCUS-HANDLER</span></span></p>
<p>Set the <code>ON-FOCUS-HANDLER</code> for <code>CLOG-OBJ</code>. If <code>ON-FOCUS-HANDLER</code>
is nil unbind the event.</p></li>
</ul>
<p><a id='x-28CLOG-3ASET-ON-BLUR-20GENERIC-FUNCTION-29'></a></p>
<ul>
<li><p><span class=reference-bullet><span class=reference><span class="locative-type">[generic-function]</span> <span class="reference-object"><a href="#x-28CLOG-3ASET-ON-BLUR-20GENERIC-FUNCTION-29" >SET-ON-BLUR</a></span></span> <span class="locative-args">CLOG-OBJ ON-BLUR-HANDLER</span></span></p>
<p>Set the <code>ON-BLUR-HANDLER</code> for <code>CLOG-OBJ</code>. If <code>ON-BLUR-HANDLER</code>
is nil unbind the event.</p></li>
</ul>
<p><a id='x-28CLOG-3ASET-ON-CHANGE-20GENERIC-FUNCTION-29'></a></p>
<ul>
<li><p><span class=reference-bullet><span class=reference><span class="locative-type">[generic-function]</span> <span class="reference-object"><a href="#x-28CLOG-3ASET-ON-CHANGE-20GENERIC-FUNCTION-29" >SET-ON-CHANGE</a></span></span> <span class="locative-args">CLOG-OBJ ON-CHANGE-HANDLER</span></span></p>
<p>Set the <code>ON-CHANGE-HANDLER</code> for <code>CLOG-OBJ</code>. If <code>ON-CHANGE-HANDLER</code>
is nil unbind the event.</p></li>
</ul>
<p><a id='x-28CLOG-3ASET-ON-FOCUS-IN-20GENERIC-FUNCTION-29'></a></p>
<ul>
<li><p><span class=reference-bullet><span class=reference><span class="locative-type">[generic-function]</span> <span class="reference-object"><a href="#x-28CLOG-3ASET-ON-FOCUS-IN-20GENERIC-FUNCTION-29" >SET-ON-FOCUS-IN</a></span></span> <span class="locative-args">CLOG-OBJ ON-FOCUS-IN-HANDLER</span></span></p>
<p>Set the <code>ON-FOCUS-IN-HANDLER</code> for <code>CLOG-OBJ</code>. If
<code>ON-FOCUS-IN-HANDLER</code> is nil unbind the event.</p></li>
</ul>
<p><a id='x-28CLOG-3ASET-ON-FOCUS-OUT-20GENERIC-FUNCTION-29'></a></p>
<ul>
<li><p><span class=reference-bullet><span class=reference><span class="locative-type">[generic-function]</span> <span class="reference-object"><a href="#x-28CLOG-3ASET-ON-FOCUS-OUT-20GENERIC-FUNCTION-29" >SET-ON-FOCUS-OUT</a></span></span> <span class="locative-args">CLOG-OBJ ON-FOCUS-OUT-HANDLER</span></span></p>
<p>Set the <code>ON-FOCUS-OUT-HANDLER</code> for <code>CLOG-OBJ</code>.
If <code>ON-FOCUS-OUT-HANDLER</code> is nil unbind the event.</p></li>
</ul>
<p><a id='x-28CLOG-3ASET-ON-RESET-20GENERIC-FUNCTION-29'></a></p>
<ul>
<li><p><span class=reference-bullet><span class=reference><span class="locative-type">[generic-function]</span> <span class="reference-object"><a href="#x-28CLOG-3ASET-ON-RESET-20GENERIC-FUNCTION-29" >SET-ON-RESET</a></span></span> <span class="locative-args">CLOG-OBJ ON-RESET-HANDLER</span></span></p>
<p>Set the <code>ON-RESET-HANDLER</code> for <code>CLOG-OBJ</code>. If <code>ON-RESET-HANDLER</code>
is nil unbind the event.</p></li>
</ul>
<p><a id='x-28CLOG-3ASET-ON-SEARCH-20GENERIC-FUNCTION-29'></a></p>
<ul>
<li><p><span class=reference-bullet><span class=reference><span class="locative-type">[generic-function]</span> <span class="reference-object"><a href="#x-28CLOG-3ASET-ON-SEARCH-20GENERIC-FUNCTION-29" >SET-ON-SEARCH</a></span></span> <span class="locative-args">CLOG-OBJ ON-SEARCH-HANDLER</span></span></p>
<p>Set the <code>ON-SEARCH-HANDLER</code> for <code>CLOG-OBJ</code>. If <code>ON-SEARCH-HANDLER</code>
is nil unbind the event.</p></li>
</ul>
<p><a id='x-28CLOG-3ASET-ON-SELECT-20GENERIC-FUNCTION-29'></a></p>
<ul>
<li><p><span class=reference-bullet><span class=reference><span class="locative-type">[generic-function]</span> <span class="reference-object"><a href="#x-28CLOG-3ASET-ON-SELECT-20GENERIC-FUNCTION-29" >SET-ON-SELECT</a></span></span> <span class="locative-args">CLOG-OBJ ON-SELECT-HANDLER</span></span></p>
<p>Set the <code>ON-SELECT-HANDLER</code> for <code>CLOG-OBJ</code>. If <code>ON-SELECT-HANDLER</code>
is nil unbind the event.</p></li>
</ul>
<p><a id='x-28CLOG-3ASET-ON-SUBMIT-20GENERIC-FUNCTION-29'></a></p>
<ul>
<li><p><span class=reference-bullet><span class=reference><span class="locative-type">[generic-function]</span> <span class="reference-object"><a href="#x-28CLOG-3ASET-ON-SUBMIT-20GENERIC-FUNCTION-29" >SET-ON-SUBMIT</a></span></span> <span class="locative-args">CLOG-OBJ ON-SUBMIT-HANDLER</span></span></p>
<p>Set the <code>ON-SUBMIT-HANDLER</code> for <code>CLOG-OBJ</code>. If <code>ON-SUBMIT-HANDLER</code>
is nil unbind the event.</p></li>
</ul>
<p><a id='x-28CLOG-3ASET-ON-SELECT-20GENERIC-FUNCTION-29'></a></p>
<ul>
<li><p><span class=reference-bullet><span class=reference><span class="locative-type">[generic-function]</span> <span class="reference-object"><a href="#x-28CLOG-3ASET-ON-SELECT-20GENERIC-FUNCTION-29" >SET-ON-SELECT</a></span></span> <span class="locative-args">CLOG-OBJ ON-SELECT-HANDLER</span></span></p>
<p>Set the <code>ON-SELECT-HANDLER</code> for <code>CLOG-OBJ</code>. If <code>ON-SELECT-HANDLER</code>
is nil unbind the event.</p></li>
</ul>
<p><a id='x-28CLOG-3ASET-ON-CONTEXT-MENU-20GENERIC-FUNCTION-29'></a></p>
<ul>
<li><p><span class=reference-bullet><span class=reference><span class="locative-type">[generic-function]</span> <span class="reference-object"><a href="#x-28CLOG-3ASET-ON-CONTEXT-MENU-20GENERIC-FUNCTION-29" >SET-ON-CONTEXT-MENU</a></span></span> <span class="locative-args">CLOG-OBJ ON-CONTEXT-MENU-HANDLER</span></span></p>
<p>Set the <code>ON-CONTEXT-MENU-HANDLER</code> for <code>CLOG-OBJ</code>. If
<code>ON-CONTEXT-MENU-HANDLER</code> is nil unbind the event. Setting
on-mouse-right-click will replace this handler.</p></li>
</ul>
<p><a id='x-28CLOG-3ASET-ON-CLICK-20GENERIC-FUNCTION-29'></a></p>
<ul>
<li><p><span class=reference-bullet><span class=reference><span class="locative-type">[generic-function]</span> <span class="reference-object"><a href="#x-28CLOG-3ASET-ON-CLICK-20GENERIC-FUNCTION-29" >SET-ON-CLICK</a></span></span> <span class="locative-args">CLOG-OBJ ON-CLICK-HANDLER</span></span></p>
<p>Set the <code>ON-CLICK-HANDLER</code> for <code>CLOG-OBJ</code>. If <code>ON-CLICK-HANDLER</code>
is nil unbind the event. Setting this event will replace an on-mouse click if
set.</p></li>
</ul>
<p><a id='x-28CLOG-3ASET-ON-DOUBLE-CLICK-20GENERIC-FUNCTION-29'></a></p>
<ul>
<li><p><span class=reference-bullet><span class=reference><span class="locative-type">[generic-function]</span> <span class="reference-object"><a href="#x-28CLOG-3ASET-ON-DOUBLE-CLICK-20GENERIC-FUNCTION-29" >SET-ON-DOUBLE-CLICK</a></span></span> <span class="locative-args">CLOG-OBJ ON-DOUBLE-CLICK-HANDLER</span></span></p>
<p>Set the <code>ON-DOUBLE-CLICK-HANDLER</code> for <code>CLOG-OBJ</code>. If
<code>ON-DOUBLE-CLICK-HANDLER</code> is nil unbind the event. Setting the
on-mouse-double-click event will replace this handler.</p></li>
</ul>
<p><a id='x-28CLOG-3ASET-ON-MOUSE-CLICK-20GENERIC-FUNCTION-29'></a></p>
<ul>
<li><p><span class=reference-bullet><span class=reference><span class="locative-type">[generic-function]</span> <span class="reference-object"><a href="#x-28CLOG-3ASET-ON-MOUSE-CLICK-20GENERIC-FUNCTION-29" >SET-ON-MOUSE-CLICK</a></span></span> <span class="locative-args">CLOG-OBJ ON-MOUSE-CLICK-HANDLER</span></span></p>
<p>Set the <code>ON-MOUSE-CLICK-HANDLER</code> for <code>CLOG-OBJ</code>. If
<code>ON-MOUSE-CLICK-HANDLER</code> is nil unbind the event. Setting this event will replace
on an on-click event.</p></li>
</ul>
<p><a id='x-28CLOG-3ASET-ON-MOUSE-DOUBLE-CLICK-20GENERIC-FUNCTION-29'></a></p>
<ul>
<li><p><span class=reference-bullet><span class=reference><span class="locative-type">[generic-function]</span> <span class="reference-object"><a href="#x-28CLOG-3ASET-ON-MOUSE-DOUBLE-CLICK-20GENERIC-FUNCTION-29" >SET-ON-MOUSE-DOUBLE-CLICK</a></span></span> <span class="locative-args">CLOG-OBJ ON-MOUSE-DOUBLE-CLICK-HANDLER</span></span></p>
<p>Set the <code>ON-MOUSE-DOUBLE-CLICK-HANDLER</code> for <code>CLOG-OBJ</code>. If
<code>ON-MOUSE-DOUBLE-CLICK-HANDLER</code> is nil unbind the event. Setting this event will
replace on an on-double-click event.</p></li>
</ul>
<p><a id='x-28CLOG-3ASET-ON-MOUSE-RIGHT-CLICK-20GENERIC-FUNCTION-29'></a></p>
<ul>
<li><p><span class=reference-bullet><span class=reference><span class="locative-type">[generic-function]</span> <span class="reference-object"><a href="#x-28CLOG-3ASET-ON-MOUSE-RIGHT-CLICK-20GENERIC-FUNCTION-29" >SET-ON-MOUSE-RIGHT-CLICK</a></span></span> <span class="locative-args">CLOG-OBJ ON-MOUSE-RIGHT-CLICK-HANDLER</span></span></p>
<p>Set the <code>ON-MOUSE-RIGHT-CLICK-HANDLER</code> for <code>CLOG-OBJ</code>. If
<code>ON-MOUSE-RIGHT-CLICK-HANDLER</code> is nil unbind the event. Setting this event will
replace on an on-context-menu event.</p></li>
</ul>
<p><a id='x-28CLOG-3ASET-ON-MOUSE-ENTER-20GENERIC-FUNCTION-29'></a></p>
<ul>
<li><p><span class=reference-bullet><span class=reference><span class="locative-type">[generic-function]</span> <span class="reference-object"><a href="#x-28CLOG-3ASET-ON-MOUSE-ENTER-20GENERIC-FUNCTION-29" >SET-ON-MOUSE-ENTER</a></span></span> <span class="locative-args">CLOG-OBJ ON-MOUSE-ENTER-HANDLER</span></span></p>
<p>Set the <code>ON-MOUSE-ENTER-HANDLER</code> for <code>CLOG-OBJ</code>. If <code>ON-MOUSE-ENTER-HANDLER</code>
is nil unbind the event.</p></li>
</ul>
<p><a id='x-28CLOG-3ASET-ON-MOUSE-LEAVE-20GENERIC-FUNCTION-29'></a></p>
<ul>
<li><p><span class=reference-bullet><span class=reference><span class="locative-type">[generic-function]</span> <span class="reference-object"><a href="#x-28CLOG-3ASET-ON-MOUSE-LEAVE-20GENERIC-FUNCTION-29" >SET-ON-MOUSE-LEAVE</a></span></span> <span class="locative-args">CLOG-OBJ ON-MOUSE-LEAVE-HANDLER</span></span></p>
<p>Set the <code>ON-MOUSE-LEAVE-HANDLER</code> for <code>CLOG-OBJ</code>. If <code>ON-MOUSE-LEAVE-HANDLER</code>
is nil unbind the event.</p></li>
</ul>
<p><a id='x-28CLOG-3ASET-ON-MOUSE-OVER-20GENERIC-FUNCTION-29'></a></p>
<ul>
<li><p><span class=reference-bullet><span class=reference><span class="locative-type">[generic-function]</span> <span class="reference-object"><a href="#x-28CLOG-3ASET-ON-MOUSE-OVER-20GENERIC-FUNCTION-29" >SET-ON-MOUSE-OVER</a></span></span> <span class="locative-args">CLOG-OBJ ON-MOUSE-OVER-HANDLER</span></span></p>
<p>Set the <code>ON-MOUSE-OVER-HANDLER</code> for <code>CLOG-OBJ</code>. If <code>ON-MOUSE-OVER-HANDLER</code>
is nil unbind the event.</p></li>
</ul>
<p><a id='x-28CLOG-3ASET-ON-MOUSE-OUT-20GENERIC-FUNCTION-29'></a></p>
<ul>
<li><p><span class=reference-bullet><span class=reference><span class="locative-type">[generic-function]</span> <span class="reference-object"><a href="#x-28CLOG-3ASET-ON-MOUSE-OUT-20GENERIC-FUNCTION-29" >SET-ON-MOUSE-OUT</a></span></span> <span class="locative-args">CLOG-OBJ ON-MOUSE-OUT-HANDLER</span></span></p>
<p>Set the <code>ON-MOUSE-OUT-HANDLER</code> for <code>CLOG-OBJ</code>. If <code>ON-MOUSE-OUT-HANDLER</code>
is nil unbind the event.</p></li>
</ul>
<p><a id='x-28CLOG-3ASET-ON-MOUSE-DOWN-20GENERIC-FUNCTION-29'></a></p>
<ul>
<li><p><span class=reference-bullet><span class=reference><span class="locative-type">[generic-function]</span> <span class="reference-object"><a href="#x-28CLOG-3ASET-ON-MOUSE-DOWN-20GENERIC-FUNCTION-29" >SET-ON-MOUSE-DOWN</a></span></span> <span class="locative-args">CLOG-OBJ ON-MOUSE-DOWN-HANDLER</span></span></p>
<p>Set the <code>ON-MOUSE-DOWN-HANDLER</code> for <code>CLOG-OBJ</code>. If
<code>ON-MOUSE-DOWN-HANDLER</code> is nil unbind the event.</p></li>
</ul>
<p><a id='x-28CLOG-3ASET-ON-MOUSE-UP-20GENERIC-FUNCTION-29'></a></p>
<ul>
<li><p><span class=reference-bullet><span class=reference><span class="locative-type">[generic-function]</span> <span class="reference-object"><a href="#x-28CLOG-3ASET-ON-MOUSE-UP-20GENERIC-FUNCTION-29" >SET-ON-MOUSE-UP</a></span></span> <span class="locative-args">CLOG-OBJ ON-MOUSE-UP-HANDLER</span></span></p>
<p>Set the <code>ON-MOUSE-UP-HANDLER</code> for <code>CLOG-OBJ</code>. If
<code>ON-MOUSE-UP-HANDLER</code> is nil unbind the event.</p></li>
</ul>
<p><a id='x-28CLOG-3ASET-ON-MOUSE-MOVE-20GENERIC-FUNCTION-29'></a></p>
<ul>
<li><p><span class=reference-bullet><span class=reference><span class="locative-type">[generic-function]</span> <span class="reference-object"><a href="#x-28CLOG-3ASET-ON-MOUSE-MOVE-20GENERIC-FUNCTION-29" >SET-ON-MOUSE-MOVE</a></span></span> <span class="locative-args">CLOG-OBJ ON-MOUSE-MOVE-HANDLER</span></span></p>
<p>Set the <code>ON-MOUSE-MOVE-HANDLER</code> for <code>CLOG-OBJ</code>. If
<code>ON-MOUSE-MOVE-HANDLER</code> is nil unbind the event.</p></li>
</ul>
<p><a id='x-28CLOG-3ASET-ON-CHARACTER-20GENERIC-FUNCTION-29'></a></p>
<ul>
<li><p><span class=reference-bullet><span class=reference><span class="locative-type">[generic-function]</span> <span class="reference-object"><a href="#x-28CLOG-3ASET-ON-CHARACTER-20GENERIC-FUNCTION-29" >SET-ON-CHARACTER</a></span></span> <span class="locative-args">CLOG-OBJ ON-CHARACTER-HANDLER</span></span></p>
<p>Set the <code>ON-CHARACTER-HANDLER</code> for <code>CLOG-OBJ</code>. If
<code>ON-CHARACTER-HANDLER</code> is nil unbind the event. Setting this event
will replace a on-key-press</p></li>
</ul>
<p><a id='x-28CLOG-3ASET-ON-KEY-DOWN-20GENERIC-FUNCTION-29'></a></p>
<ul>
<li><p><span class=reference-bullet><span class=reference><span class="locative-type">[generic-function]</span> <span class="reference-object"><a href="#x-28CLOG-3ASET-ON-KEY-DOWN-20GENERIC-FUNCTION-29" >SET-ON-KEY-DOWN</a></span></span> <span class="locative-args">CLOG-OBJ ON-KEY-DOWN-HANDLER</span></span></p>
<p>Set the <code>ON-KEY-DOWN-HANDLER</code> for <code>CLOG-OBJ</code>. If
<code>ON-KEY-DOWN-HANDLER</code> is nil unbind the event.</p></li>
</ul>
<p><a id='x-28CLOG-3ASET-ON-KEY-UP-20GENERIC-FUNCTION-29'></a></p>
<ul>
<li><p><span class=reference-bullet><span class=reference><span class="locative-type">[generic-function]</span> <span class="reference-object"><a href="#x-28CLOG-3ASET-ON-KEY-UP-20GENERIC-FUNCTION-29" >SET-ON-KEY-UP</a></span></span> <span class="locative-args">CLOG-OBJ ON-KEY-UP-HANDLER</span></span></p>
<p>Set the <code>ON-KEY-UP-HANDLER</code> for <code>CLOG-OBJ</code>. If
<code>ON-KEY-UP-HANDLER</code> is nil unbind the event.</p></li>
</ul>
<p><a id='x-28CLOG-3ASET-ON-KEY-PRESS-20GENERIC-FUNCTION-29'></a></p>
<ul>
<li><p><span class=reference-bullet><span class=reference><span class="locative-type">[generic-function]</span> <span class="reference-object"><a href="#x-28CLOG-3ASET-ON-KEY-PRESS-20GENERIC-FUNCTION-29" >SET-ON-KEY-PRESS</a></span></span> <span class="locative-args">CLOG-OBJ ON-KEY-PRESS-HANDLER</span></span></p>
<p>Set the <code>ON-KEY-PRESS-HANDLER</code> for <code>CLOG-OBJ</code>. If
<code>ON-KEY-PRESS-HANDLER</code> is nil unbind the event.</p></li>
</ul>
<p><a id='x-28CLOG-3ASET-ON-COPY-20GENERIC-FUNCTION-29'></a></p>
<ul>
<li><p><span class=reference-bullet><span class=reference><span class="locative-type">[generic-function]</span> <span class="reference-object"><a href="#x-28CLOG-3ASET-ON-COPY-20GENERIC-FUNCTION-29" >SET-ON-COPY</a></span></span> <span class="locative-args">CLOG-OBJ ON-COPY-HANDLER</span></span></p>
<p>Set the <code>ON-COPY-HANDLER</code> for <code>CLOG-OBJ</code>. If <code>ON-COPY-HANDLER</code>
is nil unbind the event.</p></li>
</ul>
<p><a id='x-28CLOG-3ASET-ON-CUT-20GENERIC-FUNCTION-29'></a></p>
<ul>
<li><p><span class=reference-bullet><span class=reference><span class="locative-type">[generic-function]</span> <span class="reference-object"><a href="#x-28CLOG-3ASET-ON-CUT-20GENERIC-FUNCTION-29" >SET-ON-CUT</a></span></span> <span class="locative-args">CLOG-OBJ ON-CUT-HANDLER</span></span></p>
<p>Set the <code>ON-CUT-HANDLER</code> for <code>CLOG-OBJ</code>. If <code>ON-CUT-HANDLER</code>
is nil unbind the event.</p></li>
</ul>
<p><a id='x-28CLOG-3ASET-ON-PASTE-20GENERIC-FUNCTION-29'></a></p>
<ul>
<li><p><span class=reference-bullet><span class=reference><span class="locative-type">[generic-function]</span> <span class="reference-object"><a href="#x-28CLOG-3ASET-ON-PASTE-20GENERIC-FUNCTION-29" >SET-ON-PASTE</a></span></span> <span class="locative-args">CLOG-OBJ ON-PASTE-HANDLER</span></span></p>
<p>Set the <code>ON-PASTE-HANDLER</code> for <code>CLOG-OBJ</code>. If <code>ON-PASTE-HANDLER</code>
is nil unbind the event.</p></li>
</ul>
<p><a id='x-28CLOG-3A-40CLOG-BODY-20MGL-PAX-3ASECTION-29'></a></p>
<p><span class="outer-navigation"><span class="navigation"> <a href="#x-28CLOG-3A-40CLOG-OBJ-20MGL-PAX-3ASECTION-29" title="CLOG Objects">&#8592;</a> <a href="#x-28CLOG-3A-40CLOG-MANUAL-20MGL-PAX-3ASECTION-29" title="The CLOG manual">&#8593;</a> <a href="#x-28CLOG-3A-40CLOG-WINDOW-20MGL-PAX-3ASECTION-29" title="CLOG Window Objects">&#8594;</a> <a href="#x-28CLOG-3A-40CLOG-BODY-20MGL-PAX-3ASECTION-29" title="CLOG Body Objects">&#8634;</a></span></span></p>
<h2><a href="#x-28CLOG-3A-40CLOG-BODY-20MGL-PAX-3ASECTION-29">5 CLOG Body Objects</a></h2>
<p>CLOG-Body - <a href="#x-28-22clog-22-20ASDF-2FSYSTEM-3ASYSTEM-29" title="(\&quot;clog\&quot; ASDF/SYSTEM:SYSTEM)"><code>CLOG</code></a> Body Objects</p>
<p><a id='x-28CLOG-3ACLOG-BODY-20CLASS-29'></a></p>
<ul>
<li><p><span class=reference-bullet><span class=reference><span class="locative-type">[class]</span> <span class="reference-object"><a href="#x-28CLOG-3ACLOG-BODY-20CLASS-29" >CLOG-BODY</a></span></span> <span class="locative-args"><a href="#x-28CLOG-3ACLOG-OBJ-20CLASS-29" title="(CLOG:CLOG-OBJ CLASS)">CLOG-OBJ</a></span></span></p>
<p><a href="#x-28-22clog-22-20ASDF-2FSYSTEM-3ASYSTEM-29" title="(\&quot;clog\&quot; ASDF/SYSTEM:SYSTEM)"><code>CLOG</code></a> Body Object encapsulate the view in the window.</p></li>
</ul>
<p>CLOG-Body - Properties</p>
<p><a id='x-28CLOG-3AWINDOW-20GENERIC-FUNCTION-29'></a></p>
<ul>
<li><p><span class=reference-bullet><span class=reference><span class="locative-type">[generic-function]</span> <span class="reference-object"><a href="#x-28CLOG-3AWINDOW-20GENERIC-FUNCTION-29" >WINDOW</a></span></span> <span class="locative-args">CLOG-BODY</span></span></p>
<p>Reader for CLOG-Window object</p></li>
</ul>
<p><a id='x-28CLOG-3AHTML-DOCUMENT-20GENERIC-FUNCTION-29'></a></p>
<ul>
<li><p><span class=reference-bullet><span class=reference><span class="locative-type">[generic-function]</span> <span class="reference-object"><a href="#x-28CLOG-3AHTML-DOCUMENT-20GENERIC-FUNCTION-29" >HTML-DOCUMENT</a></span></span> <span class="locative-args">CLOG-BODY</span></span></p>
<p>Reader for CLOG-Document object</p></li>
</ul>
<p><a id='x-28CLOG-3ALOCATION-20GENERIC-FUNCTION-29'></a></p>
<ul>
<li><p><span class=reference-bullet><span class=reference><span class="locative-type">[generic-function]</span> <span class="reference-object"><a href="#x-28CLOG-3ALOCATION-20GENERIC-FUNCTION-29" >LOCATION</a></span></span> <span class="locative-args">CLOG-BODY</span></span></p>
<p>Reader for CLOG-Location object</p></li>
</ul>
<p><a id='x-28CLOG-3ANAVIGATOR-20GENERIC-FUNCTION-29'></a></p>
<ul>
<li><p><span class=reference-bullet><span class=reference><span class="locative-type">[generic-function]</span> <span class="reference-object"><a href="#x-28CLOG-3ANAVIGATOR-20GENERIC-FUNCTION-29" >NAVIGATOR</a></span></span> <span class="locative-args">CLOG-BODY</span></span></p>
<p>Reader for CLOG-Navigator object</p></li>
</ul>
<p><a id='x-28CLOG-3A-40CLOG-WINDOW-20MGL-PAX-3ASECTION-29'></a></p>
<p><span class="outer-navigation"><span class="navigation"> <a href="#x-28CLOG-3A-40CLOG-BODY-20MGL-PAX-3ASECTION-29" title="CLOG Body Objects">&#8592;</a> <a href="#x-28CLOG-3A-40CLOG-MANUAL-20MGL-PAX-3ASECTION-29" title="The CLOG manual">&#8593;</a> <a href="#x-28CLOG-3A-40CLOG-DOCUMENT-20MGL-PAX-3ASECTION-29" title="CLOG Document Objects">&#8594;</a> <a href="#x-28CLOG-3A-40CLOG-WINDOW-20MGL-PAX-3ASECTION-29" title="CLOG Window Objects">&#8634;</a></span></span></p>
<h2><a href="#x-28CLOG-3A-40CLOG-WINDOW-20MGL-PAX-3ASECTION-29">6 CLOG Window Objects</a></h2>
<p>CLOG-Window - <a href="#x-28-22clog-22-20ASDF-2FSYSTEM-3ASYSTEM-29" title="(\&quot;clog\&quot; ASDF/SYSTEM:SYSTEM)"><code>CLOG</code></a> Window Objects</p>
<p><a id='x-28CLOG-3ACLOG-WINDOW-20CLASS-29'></a></p>
<ul>
<li><p><span class=reference-bullet><span class=reference><span class="locative-type">[class]</span> <span class="reference-object"><a href="#x-28CLOG-3ACLOG-WINDOW-20CLASS-29" >CLOG-WINDOW</a></span></span> <span class="locative-args"><a href="#x-28CLOG-3ACLOG-OBJ-20CLASS-29" title="(CLOG:CLOG-OBJ CLASS)">CLOG-OBJ</a></span></span></p>
<p><a href="#x-28-22clog-22-20ASDF-2FSYSTEM-3ASYSTEM-29" title="(\&quot;clog\&quot; ASDF/SYSTEM:SYSTEM)"><code>CLOG</code></a> Window Objects encapsulate the window.</p></li>
</ul>
<p>CLOG-Window - Properties</p>
<p><a id='x-28CLOG-3AWINDOW-NAME-20GENERIC-FUNCTION-29'></a></p>
<ul>
<li><p><span class=reference-bullet><span class=reference><span class="locative-type">[generic-function]</span> <span class="reference-object"><a href="#x-28CLOG-3AWINDOW-NAME-20GENERIC-FUNCTION-29" >WINDOW-NAME</a></span></span> <span class="locative-args">CLOG-WINDOW</span></span></p>
<p>Get/Setf name for use by hyperlink &quot;target&quot; for this
window.</p></li>
</ul>
<p>CLOG-Window - Methods</p>
<p><a id='x-28CLOG-3AALERT-20GENERIC-FUNCTION-29'></a></p>
<ul>
<li><p><span class=reference-bullet><span class=reference><span class="locative-type">[generic-function]</span> <span class="reference-object"><a href="#x-28CLOG-3AALERT-20GENERIC-FUNCTION-29" >ALERT</a></span></span> <span class="locative-args">CLOG-WINDOW MESSAGE</span></span></p>
<p>Launch an alert box. Note that as long as not dismissed
events and messages may not be trasmitted on most browsers.</p></li>
</ul>
<p><a id='x-28CLOG-3A-40CLOG-DOCUMENT-20MGL-PAX-3ASECTION-29'></a></p>
<p><span class="outer-navigation"><span class="navigation"> <a href="#x-28CLOG-3A-40CLOG-WINDOW-20MGL-PAX-3ASECTION-29" title="CLOG Window Objects">&#8592;</a> <a href="#x-28CLOG-3A-40CLOG-MANUAL-20MGL-PAX-3ASECTION-29" title="The CLOG manual">&#8593;</a> <a href="#x-28CLOG-3A-40CLOG-LOCATION-20MGL-PAX-3ASECTION-29" title="CLOG Location Objects">&#8594;</a> <a href="#x-28CLOG-3A-40CLOG-DOCUMENT-20MGL-PAX-3ASECTION-29" title="CLOG Document Objects">&#8634;</a></span></span></p>
<h2><a href="#x-28CLOG-3A-40CLOG-DOCUMENT-20MGL-PAX-3ASECTION-29">7 CLOG Document Objects</a></h2>
<p>CLOG-Document - <a href="#x-28-22clog-22-20ASDF-2FSYSTEM-3ASYSTEM-29" title="(\&quot;clog\&quot; ASDF/SYSTEM:SYSTEM)"><code>CLOG</code></a> Document Objects</p>
<p><a id='x-28CLOG-3ACLOG-DOCUMENT-20CLASS-29'></a></p>
<ul>
<li><p><span class=reference-bullet><span class=reference><span class="locative-type">[class]</span> <span class="reference-object"><a href="#x-28CLOG-3ACLOG-DOCUMENT-20CLASS-29" >CLOG-DOCUMENT</a></span></span> <span class="locative-args"><a href="#x-28CLOG-3ACLOG-OBJ-20CLASS-29" title="(CLOG:CLOG-OBJ CLASS)">CLOG-OBJ</a></span></span></p>
<p><a href="#x-28-22clog-22-20ASDF-2FSYSTEM-3ASYSTEM-29" title="(\&quot;clog\&quot; ASDF/SYSTEM:SYSTEM)"><code>CLOG</code></a> Document Objects encapsulate the document.</p></li>
</ul>
<p><a id='x-28CLOG-3A-40CLOG-LOCATION-20MGL-PAX-3ASECTION-29'></a></p>
<p><span class="outer-navigation"><span class="navigation"> <a href="#x-28CLOG-3A-40CLOG-DOCUMENT-20MGL-PAX-3ASECTION-29" title="CLOG Document Objects">&#8592;</a> <a href="#x-28CLOG-3A-40CLOG-MANUAL-20MGL-PAX-3ASECTION-29" title="The CLOG manual">&#8593;</a> <a href="#x-28CLOG-3A-40CLOG-NAVIGATOR-20MGL-PAX-3ASECTION-29" title="CLOG Navigator Objects">&#8594;</a> <a href="#x-28CLOG-3A-40CLOG-LOCATION-20MGL-PAX-3ASECTION-29" title="CLOG Location Objects">&#8634;</a></span></span></p>
<h2><a href="#x-28CLOG-3A-40CLOG-LOCATION-20MGL-PAX-3ASECTION-29">8 CLOG Location Objects</a></h2>
<p>CLOG-Location - <a href="#x-28-22clog-22-20ASDF-2FSYSTEM-3ASYSTEM-29" title="(\&quot;clog\&quot; ASDF/SYSTEM:SYSTEM)"><code>CLOG</code></a> Location Objects</p>
<p><a id='x-28CLOG-3ACLOG-LOCATION-20CLASS-29'></a></p>
<ul>
<li><p><span class=reference-bullet><span class=reference><span class="locative-type">[class]</span> <span class="reference-object"><a href="#x-28CLOG-3ACLOG-LOCATION-20CLASS-29" >CLOG-LOCATION</a></span></span> <span class="locative-args"><a href="#x-28CLOG-3ACLOG-OBJ-20CLASS-29" title="(CLOG:CLOG-OBJ CLASS)">CLOG-OBJ</a></span></span></p>
<p><a href="#x-28-22clog-22-20ASDF-2FSYSTEM-3ASYSTEM-29" title="(\&quot;clog\&quot; ASDF/SYSTEM:SYSTEM)"><code>CLOG</code></a> Location Objects encapsulate the location.</p></li>
</ul>
<p><a id='x-28CLOG-3A-40CLOG-NAVIGATOR-20MGL-PAX-3ASECTION-29'></a></p>
<p><span class="outer-navigation"><span class="navigation"> <a href="#x-28CLOG-3A-40CLOG-LOCATION-20MGL-PAX-3ASECTION-29" title="CLOG Location Objects">&#8592;</a> <a href="#x-28CLOG-3A-40CLOG-MANUAL-20MGL-PAX-3ASECTION-29" title="The CLOG manual">&#8593;</a> <a href="#x-28CLOG-3A-40CLOG-NAVIGATOR-20MGL-PAX-3ASECTION-29" title="CLOG Navigator Objects">&#8634;</a></span></span></p>
<h2><a href="#x-28CLOG-3A-40CLOG-NAVIGATOR-20MGL-PAX-3ASECTION-29">9 CLOG Navigator Objects</a></h2>
<p>CLOG-Navigator - <a href="#x-28-22clog-22-20ASDF-2FSYSTEM-3ASYSTEM-29" title="(\&quot;clog\&quot; ASDF/SYSTEM:SYSTEM)"><code>CLOG</code></a> Navigator Objects</p>
<p><a id='x-28CLOG-3ACLOG-NAVIGATOR-20CLASS-29'></a></p>
<ul>
<li><p><span class=reference-bullet><span class=reference><span class="locative-type">[class]</span> <span class="reference-object"><a href="#x-28CLOG-3ACLOG-NAVIGATOR-20CLASS-29" >CLOG-NAVIGATOR</a></span></span> <span class="locative-args"><a href="#x-28CLOG-3ACLOG-OBJ-20CLASS-29" title="(CLOG:CLOG-OBJ CLASS)">CLOG-OBJ</a></span></span></p>
<p><a href="#x-28-22clog-22-20ASDF-2FSYSTEM-3ASYSTEM-29" title="(\&quot;clog\&quot; ASDF/SYSTEM:SYSTEM)"><code>CLOG</code></a> Navigator Objects encapsulate the navigator.</p></li>
</ul>
</div>
</div>
<script>$('#page-toc').toc({'selectors': 'h1,h2,h3,h4'});</script>
</body>
</html>

4
doc/jquery.min.js vendored Normal file

File diff suppressed because one or more lines are too long

336
doc/style.css Normal file
View file

@ -0,0 +1,336 @@
body {
font-family: sans-serif;
margin: auto;
background-color: #FFFEFB;
color: #000000;
}
h1, h2, h3, h4, h5, h6 {
font-family: serif;
font-weight: bold;
text-shadow: 0.05em 0.05em 0.02em #DDDDDD;
}
h1 a {
border-bottom: none;
}
h2 a {
border-bottom: none;
}
h3 a {
border-bottom: none;
}
h4 a {
border-bottom: none;
}
h5 a {
border-bottom: none;
}
h1 {
font-size: 250%
}
h2 {
border-bottom: 0.05em solid #CCCCCC;
font-size: 200%;
}
h3 {
font-size: 150%;
}
h4 {
font-size: 130%;
}
h5 {
font-size: 110%;
margin-top: 0.75em;
margin-bottom: 0.5em;
}
h6 {
color: #777777;
background-color: inherit;
font-size: 100%;
}
hr {
height: 0.2em;
border: 0;
color: #CCCCCC;
background-color: #CCCCCC;
}
p, blockquote, table, pre {
line-height: 1.5;
margin: 0.5em 0 0 0;
}
ul, ol, dl {
padding-left: 1.1em;
list-style-position: outside;
/* margin: 0; */
}
li {
line-height: 1.5;
margin: 0 0 0 0;
}
pre {
background-color: #F5F3ED;
color: #000000;
border: 0.1em solid #CCCCCC;
line-height: 1.25em;
overflow: auto;
margin: 0.5em 0 0 0;
padding: 0.2em;
}
pre > code {
color: #222222;
}
code {
color: #222222;
}
a {
color: #222222;
text-decoration: none;
border-bottom: 1px solid;
}
h6 a {
color: #777777;
}
a:hover {
/* text-decoration: none; */
}
.reference-bullet {
}
.reference {
/* padding: 0.3em 0; */
/* background-color: #EEEEEE; */
}
.locative-type a {
text-decoration: none;
border-bottom: 0;
font-weight: bold;
}
.reference-object {
background-color: #EBE8E2;
padding: 0.1em;
border: solid 1px;
font-weight: bold;
}
.reference-object a {
border-bottom: none;
}
.locative-args {
font-style: italic;
}
.locative-args code {
font-family: sans-serif;
}
.navigation a {
color: #CCCCCC;
text-shadow: none;
border-bottom: none;
}
/* Option 1 for navigation links: just hide the links in the previous
line. Good because there is no jumping around of content as with
the other otptions. */
.navigation {
display: block;
visibility: hidden;
margin-bottom: -1.5em;
}
.outer-navigation:hover .navigation {
visibility: visible;
}
/* Option 2 for navigation links: heading moves right to make room for
the links. */
/* .navigation { */
/* display: none; */
/* } */
/* */
/* h1:hover .navigation, */
/* h2:hover .navigation, */
/* h3:hover .navigation, */
/* h4:hover .navigation, */
/* h5:hover .navigation, */
/* h6:hover .navigation { */
/* display: inline; */
/* } */
/* Option 3 for navigation links: heading moves down to make room for
the links. */
/* .navigation { */
/* display: none; */
/* } */
/* */
/* h1:hover .navigation, */
/* h2:hover .navigation, */
/* h3:hover .navigation, */
/* h4:hover .navigation, */
/* h5:hover .navigation, */
/* h6:hover .navigation { */
/* display: block; */
/* } */
/* Syntax highlighting with Colorize */
.symbol { color : #770055; background-color : transparent; border: 0px; margin: 0px;}
a.symbol:link { color : #229955; background-color : transparent; text-decoration: none; border: 0px; margin: 0px; }
a.symbol:active { color : #229955; background-color : transparent; text-decoration: none; border: 0px; margin: 0px; }
a.symbol:visited { color : #229955; background-color : transparent; text-decoration: none; border: 0px; margin: 0px; }
a.symbol:hover { color : #229955; background-color : transparent; text-decoration: none; border: 0px; margin: 0px; }
.special { color : #FF5000; background-color : inherit; }
.keyword { color : #770000; background-color : inherit; }
.comment { color : #007777; background-color : inherit; }
.string { color : #777777; background-color : inherit; }
.atom { color : #314F4F; background-color : inherit; }
.macro { color : #FF5000; background-color : inherit; }
.variable { color : #36648B; background-color : inherit; }
.function { color : #8B4789; background-color : inherit; }
.attribute { color : #FF5000; background-color : inherit; }
.character { color : #0055AA; background-color : inherit; }
.syntaxerror { color : #FF0000; background-color : inherit; }
.diff-deleted { color : #5F2121; background-color : inherit; }
.diff-added { color : #215F21; background-color : inherit; }
/* Disable rainbow nesting on hover */
/* span.paren1 { background-color : inherit; -webkit-transition: background-color 0.2s linear; } */
/* span.paren1:hover { color : inherit; background-color : #BAFFFF; } */
/* span.paren2 { background-color : inherit; -webkit-transition: background-color 0.2s linear; } */
/* span.paren2:hover { color : inherit; background-color : #FFCACA; } */
/* span.paren3 { background-color : inherit; -webkit-transition: background-color 0.2s linear; } */
/* span.paren3:hover { color : inherit; background-color : #FFFFBA; } */
/* span.paren4 { background-color : inherit; -webkit-transition: background-color 0.2s linear; } */
/* span.paren4:hover { color : inherit; background-color : #CACAFF; } */
/* span.paren5 { background-color : inherit; -webkit-transition: background-color 0.2s linear; } */
/* span.paren5:hover { color : inherit; background-color : #CAFFCA; } */
/* span.paren6 { background-color : inherit; -webkit-transition: background-color 0.2s linear; } */
/* span.paren6:hover { color : inherit; background-color : #FFBAFF; } */
#content-container
{
margin: 0;
padding: 0;
}
#content
{
margin-left: 40ex;
padding-left: 2.5em;
max-width: 85ex;
}
#toc {
top: 0px;
left: 0px;
height: 100%;
width: 40ex;
max-width: 33%;
position: fixed;
overflow-y:auto;
overflow-x:hidden;
background: #333;
box-shadow: inset -5px 0 5px 0px #000;
color: #aaa;
}
#toc ul {
font-size: 80%;
}
#toc li {
line-height: 1.0;
}
#toc a {
border-bottom: none;
}
#toc hr {
height: 0.05em;
border: 0;
background: #777;
}
#toc ul {
margin: 0;
padding: 0;
list-style: none;
}
#toc li {
padding: 5px 10px;
}
#toc .toc-h2 {
padding-left: 10px;
}
#toc .toc-h3 {
padding-left: 20px;
}
#toc .toc-h4 {
padding-left: 30px;
}
#toc .toc-active {
background: #336699;
box-shadow: inset -5px 0px 10px -5px #000;
}
#page-toc a {
color: #fff;
}
.menu-block {
padding-left: 10px;
margin-bottom: 1em;
}
.menu-block-title {
font-size: 90%;
}
.menu-block a {
color: #fff;
border-bottom: none;
}
#toc-header a {
color: #777777;
}
#toc-footer a {
font-size: 80%;
color: #777777;
}

8
doc/toc.min.js vendored Normal file
View file

@ -0,0 +1,8 @@
/*!
* toc - jQuery Table of Contents Plugin
* v0.3.2
* http://projects.jga.me/toc/
* copyright Greg Allen 2014
* MIT License
*/
!function(a){a.fn.smoothScroller=function(b){b=a.extend({},a.fn.smoothScroller.defaults,b);var c=a(this);return a(b.scrollEl).animate({scrollTop:c.offset().top-a(b.scrollEl).offset().top-b.offset},b.speed,b.ease,function(){var a=c.attr("id");a.length&&(history.pushState?history.pushState(null,null,"#"+a):document.location.hash=a),c.trigger("smoothScrollerComplete")}),this},a.fn.smoothScroller.defaults={speed:400,ease:"swing",scrollEl:"body,html",offset:0},a("body").on("click","[data-smoothscroller]",function(b){b.preventDefault();var c=a(this).attr("href");0===c.indexOf("#")&&a(c).smoothScroller()})}(jQuery),function(a){var b={};a.fn.toc=function(b){var c,d=this,e=a.extend({},jQuery.fn.toc.defaults,b),f=a(e.container),g=a(e.selectors,f),h=[],i=e.activeClass,j=function(b,c){if(e.smoothScrolling&&"function"==typeof e.smoothScrolling){b.preventDefault();var f=a(b.target).attr("href");e.smoothScrolling(f,e,c)}a("li",d).removeClass(i),a(b.target).parent().addClass(i)},k=function(){c&&clearTimeout(c),c=setTimeout(function(){for(var b,c=a(window).scrollTop(),f=Number.MAX_VALUE,g=0,j=0,k=h.length;k>j;j++){var l=Math.abs(h[j]-c);f>l&&(g=j,f=l)}a("li",d).removeClass(i),b=a("li:eq("+g+")",d).addClass(i),e.onHighlight(b)},50)};return e.highlightOnScroll&&(a(window).bind("scroll",k),k()),this.each(function(){var b=a(this),c=a(e.listType);g.each(function(d,f){var g=a(f);h.push(g.offset().top-e.highlightOffset);var i=e.anchorName(d,f,e.prefix);if(f.id!==i){a("<span/>").attr("id",i).insertBefore(g)}var l=a("<a/>").text(e.headerText(d,f,g)).attr("href","#"+i).bind("click",function(c){a(window).unbind("scroll",k),j(c,function(){a(window).bind("scroll",k)}),b.trigger("selected",a(this).attr("href"))}),m=a("<li/>").addClass(e.itemClass(d,f,g,e.prefix)).append(l);c.append(m)}),b.html(c)})},jQuery.fn.toc.defaults={container:"body",listType:"<ul/>",selectors:"h1,h2,h3",smoothScrolling:function(b,c,d){a(b).smoothScroller({offset:c.scrollToOffset}).on("smoothScrollerComplete",function(){d()})},scrollToOffset:0,prefix:"toc",activeClass:"toc-active",onHighlight:function(){},highlightOnScroll:!0,highlightOffset:100,anchorName:function(c,d,e){if(d.id.length)return d.id;var f=a(d).text().replace(/[^a-z0-9]/gi," ").replace(/\s+/g,"-").toLowerCase();if(b[f]){for(var g=2;b[f+g];)g++;f=f+"-"+g}return b[f]=!0,e+"-"+f},headerText:function(a,b,c){return c.text()},itemClass:function(a,b,c,d){return d+"-"+c[0].tagName.toLowerCase()}}}(jQuery);

View file

@ -1 +0,0 @@
ecl --eval "(ql:quickload :clog)" --eval "(clog:make-markup)" --eval "(quit)" > docs/manual.md

View file

@ -1 +0,0 @@
sbcl --eval "(ql:quickload :clog)" --eval "(clog:make-markup)" --eval "(quit)" > docs/manual.md