mirrors/clog
1
Fork 0
mirror of https://github.com/rabbibotton/clog.git synced 2025-12-06 10:40:45 -08:00
Code Issues Projects Releases Wiki Activity

doc updates

Browse source
This commit is contained in:
David Botton 2021-02-14 22:03:56 -05:00
parent 43c4f7adf8
commit 68a4310f9d
2 changed files with 77 additions and 15 deletions
Download patch file Download diff file Expand all files Collapse all files

6
README.md
View file

@ -194,11 +194,11 @@ Demo Summary
- 02-demo.lisp - Chat - Private instant messenger - 02-demo.lisp - Chat - Private instant messenger
- 03-demo.lisp - IDE - A very simple common lisp IDE - 03-demo.lisp - IDE - A very simple common lisp IDE
High Order Extensions to CLOG High Order Extensions to CLOG (so far)
- clog-gui - Desktop over the web - clog-gui - Desktop over the web
- Menus - Menus
- Windowing system - Windowing system
- In progress - Feb 2020 - File Load / Save dialogs - In progress - File Load / Save dialogs
- clog-data - clog-data
- In progress - Feb 2020 - Database integrations - In progress - Database integrations

86
doc/clog-manual.html
View file

@ -3242,7 +3242,7 @@ text/plain</p></li>
<p><a id='x-28CLOG-3ACREATE-FIELDSET-20GENERIC-FUNCTION-29'></a></p> <p><a id='x-28CLOG-3ACREATE-FIELDSET-20GENERIC-FUNCTION-29'></a></p>
<ul> <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-FIELDSET-20GENERIC-FUNCTION-29" >CREATE-FIELDSET</a></span></span> <span class="locative-args">CLOG-OBJ &amp;KEY LEGEND HTML-ID</span></span></p> <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-FIELDSET-20GENERIC-FUNCTION-29" >CREATE-FIELDSET</a></span></span> <span class="locative-args">CLOG-OBJ &amp;KEY LEGEND CLASS HTML-ID</span></span></p>
<p>Create a new clog-fieldset as child of <code>CLOG-OBJ</code>.</p></li> <p>Create a new clog-fieldset as child of <code>CLOG-OBJ</code>.</p></li>
</ul> </ul>
@ -3267,7 +3267,7 @@ elements.</p></li>
<p><a id='x-28CLOG-3ACREATE-FORM-ELEMENT-20GENERIC-FUNCTION-29'></a></p> <p><a id='x-28CLOG-3ACREATE-FORM-ELEMENT-20GENERIC-FUNCTION-29'></a></p>
<ul> <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-FORM-ELEMENT-20GENERIC-FUNCTION-29" >CREATE-FORM-ELEMENT</a></span></span> <span class="locative-args">CLOG-OBJ ELEMENT-TYPE &amp;KEY NAME VALUE LABEL HTML-ID</span></span></p> <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-FORM-ELEMENT-20GENERIC-FUNCTION-29" >CREATE-FORM-ELEMENT</a></span></span> <span class="locative-args">CLOG-OBJ ELEMENT-TYPE &amp;KEY NAME VALUE LABEL CLASS HTML-ID</span></span></p>
<p>Create a new clog-form-element as child of <code>CLOG-OBJ</code>. <p>Create a new clog-form-element as child of <code>CLOG-OBJ</code>.
It is importamt that clog-form-elements are a child or descendant of a It is importamt that clog-form-elements are a child or descendant of a
@ -3521,7 +3521,7 @@ virtual keyboards.</p></li>
<p><a id='x-28CLOG-3ACREATE-LABEL-20GENERIC-FUNCTION-29'></a></p> <p><a id='x-28CLOG-3ACREATE-LABEL-20GENERIC-FUNCTION-29'></a></p>
<ul> <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-LABEL-20GENERIC-FUNCTION-29" >CREATE-LABEL</a></span></span> <span class="locative-args">CLOG-OBJ &amp;KEY CONTENT LABEL-FOR HTML-ID</span></span></p> <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-LABEL-20GENERIC-FUNCTION-29" >CREATE-LABEL</a></span></span> <span class="locative-args">CLOG-OBJ &amp;KEY CONTENT LABEL-FOR CLASS HTML-ID</span></span></p>
<p>Create a new clog-label as child of <code>CLOG-OBJ</code>.</p></li> <p>Create a new clog-label as child of <code>CLOG-OBJ</code>.</p></li>
</ul> </ul>
@ -3547,7 +3547,7 @@ virtual keyboards.</p></li>
<p><a id='x-28CLOG-3ACREATE-SELECT-20GENERIC-FUNCTION-29'></a></p> <p><a id='x-28CLOG-3ACREATE-SELECT-20GENERIC-FUNCTION-29'></a></p>
<ul> <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-SELECT-20GENERIC-FUNCTION-29" >CREATE-SELECT</a></span></span> <span class="locative-args">CLOG-OBJ &amp;KEY NAME MULTIPLE LABEL HTML-ID</span></span></p> <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-SELECT-20GENERIC-FUNCTION-29" >CREATE-SELECT</a></span></span> <span class="locative-args">CLOG-OBJ &amp;KEY NAME MULTIPLE LABEL CLASS HTML-ID</span></span></p>
<p>Create a new clog-select as child of <code>CLOG-OBJ</code>.</p></li> <p>Create a new clog-select as child of <code>CLOG-OBJ</code>.</p></li>
</ul> </ul>
@ -3563,7 +3563,7 @@ virtual keyboards.</p></li>
<p><a id='x-28CLOG-3ACREATE-OPTION-20GENERIC-FUNCTION-29'></a></p> <p><a id='x-28CLOG-3ACREATE-OPTION-20GENERIC-FUNCTION-29'></a></p>
<ul> <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-OPTION-20GENERIC-FUNCTION-29" >CREATE-OPTION</a></span></span> <span class="locative-args">CLOG-OBJ &amp;KEY CONTENT VALUE SELECTED DISABLED HTML-ID</span></span></p> <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-OPTION-20GENERIC-FUNCTION-29" >CREATE-OPTION</a></span></span> <span class="locative-args">CLOG-OBJ &amp;KEY CONTENT VALUE SELECTED DISABLED CLASS HTML-ID</span></span></p>
<p>Create a new clog-option as child of <code>CLOG-OBJ</code>.</p></li> <p>Create a new clog-option as child of <code>CLOG-OBJ</code>.</p></li>
</ul> </ul>
@ -3656,7 +3656,7 @@ optionally fill in with contents of data-list.</p></li>
<p><a id='x-28CLOG-3ACREATE-TEXT-AREA-20GENERIC-FUNCTION-29'></a></p> <p><a id='x-28CLOG-3ACREATE-TEXT-AREA-20GENERIC-FUNCTION-29'></a></p>
<ul> <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-TEXT-AREA-20GENERIC-FUNCTION-29" >CREATE-TEXT-AREA</a></span></span> <span class="locative-args">CLOG-OBJ &amp;KEY COLUMNS ROWS NAME VALUE LABEL HTML-ID</span></span></p> <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-TEXT-AREA-20GENERIC-FUNCTION-29" >CREATE-TEXT-AREA</a></span></span> <span class="locative-args">CLOG-OBJ &amp;KEY COLUMNS ROWS NAME VALUE LABEL CLASS HTML-ID</span></span></p>
<p>Create a new clog-text-area as child of <code>CLOG-OBJ</code>.</p></li> <p>Create a new clog-text-area as child of <code>CLOG-OBJ</code>.</p></li>
</ul> </ul>
@ -4455,10 +4455,9 @@ is nil unbind the event.</p></li>
<p><a id='x-28CLOG-3ACLOG-GUI-INITIALIZE-20FUNCTION-29'></a></p> <p><a id='x-28CLOG-3ACLOG-GUI-INITIALIZE-20FUNCTION-29'></a></p>
<ul> <ul>
<li><p><span class=reference-bullet><span class=reference><span class="locative-type">[function]</span> <span class="reference-object"><a href="#x-28CLOG-3ACLOG-GUI-INITIALIZE-20FUNCTION-29" >CLOG-GUI-INITIALIZE</a></span></span> <span class="locative-args">CLOG-BODY &amp;KEY (W3-CSS-URL &quot;/css/w3.css&quot;)</span></span></p> <li><p><span class=reference-bullet><span class=reference><span class="locative-type">[function]</span> <span class="reference-object"><a href="#x-28CLOG-3ACLOG-GUI-INITIALIZE-20FUNCTION-29" >CLOG-GUI-INITIALIZE</a></span></span> <span class="locative-args">CLOG-BODY &amp;KEY (W3-CSS-URL &quot;/css/w3.css&quot;) (JQUERY-UI-CSS &quot;/css/jquery-ui.css&quot;) (JQUERY-UI &quot;/js/jquery-ui.js&quot;)</span></span></p>
<p>Initializes clog-gui loading w3.css from <code>:W3-CSS-URL</code> and installs a <p>Initializes clog-gui and installs a clog-gui object on connection.</p></li>
clog-gui object on connection.</p></li>
</ul> </ul>
<p><code>CLOG-GUI</code> - Menus</p> <p><code>CLOG-GUI</code> - Menus</p>
@ -4501,7 +4500,7 @@ clog-body.</p></li>
<ul> <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-GUI-MENU-ITEM-20CLASS-29" >CLOG-GUI-MENU-ITEM</a></span></span> <span class="locative-args"><a href="#x-28CLOG-3ACLOG-SPAN-20CLASS-29" title="(CLOG:CLOG-SPAN CLASS)">CLOG-SPAN</a></span></span></p> <li><p><span class=reference-bullet><span class=reference><span class="locative-type">[class]</span> <span class="reference-object"><a href="#x-28CLOG-3ACLOG-GUI-MENU-ITEM-20CLASS-29" >CLOG-GUI-MENU-ITEM</a></span></span> <span class="locative-args"><a href="#x-28CLOG-3ACLOG-SPAN-20CLASS-29" title="(CLOG:CLOG-SPAN CLASS)">CLOG-SPAN</a></span></span></p>
<p>Menu bar</p></li> <p>Menu item</p></li>
</ul> </ul>
<p><a id='x-28CLOG-3ACREATE-GUI-MENU-ITEM-20GENERIC-FUNCTION-29'></a></p> <p><a id='x-28CLOG-3ACREATE-GUI-MENU-ITEM-20GENERIC-FUNCTION-29'></a></p>
@ -4512,6 +4511,14 @@ clog-body.</p></li>
<p>Attached a menu item to a <code>CLOG-GUI-MENU-DROP-DOWN</code></p></li> <p>Attached a menu item to a <code>CLOG-GUI-MENU-DROP-DOWN</code></p></li>
</ul> </ul>
<p><a id='x-28CLOG-3ACREATE-GUI-MENU-WINDOW-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-3ACREATE-GUI-MENU-WINDOW-SELECT-20GENERIC-FUNCTION-29" >CREATE-GUI-MENU-WINDOW-SELECT</a></span></span> <span class="locative-args">CLOG-GUI-MENU-DROP-DOWN &amp;KEY CLASS HTML-ID</span></span></p>
<p>Attached a menu item to a <code>CLOG-GUI-MENU-DROP-DOWN</code></p></li>
</ul>
<p><a id='x-28CLOG-3ACREATE-GUI-MENU-FULL-SCREEN-20GENERIC-FUNCTION-29'></a></p> <p><a id='x-28CLOG-3ACREATE-GUI-MENU-FULL-SCREEN-20GENERIC-FUNCTION-29'></a></p>
<ul> <ul>
@ -4559,9 +4566,13 @@ The on-window-change clog-obj received is the new window</p></li>
<p><a id='x-28CLOG-3ACREATE-GUI-WINDOW-20GENERIC-FUNCTION-29'></a></p> <p><a id='x-28CLOG-3ACREATE-GUI-WINDOW-20GENERIC-FUNCTION-29'></a></p>
<ul> <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-GUI-WINDOW-20GENERIC-FUNCTION-29" >CREATE-GUI-WINDOW</a></span></span> <span class="locative-args">CLOG-OBJ &amp;KEY TITLE CONTENT LEFT TOP WIDTH HEIGHT HTML-ID</span></span></p> <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-GUI-WINDOW-20GENERIC-FUNCTION-29" >CREATE-GUI-WINDOW</a></span></span> <span class="locative-args">CLOG-OBJ &amp;KEY TITLE CONTENT LEFT TOP WIDTH HEIGHT MAXIMIZE CLIENT-MOVEMENT HTML-ID</span></span></p>
<p>Create a clog-gui-window</p></li> <p>Create a clog-gui-window. If client-movement is t then
use jquery-ui to move/resize and will not work on mobile. When client-movement
is t only on-window-move is fired once at start of drag and on-window-move-done
at end of drag and on-window-resize at start of resize and
on-window-resize-done at end of resize.</p></li>
</ul> </ul>
<p><a id='x-28CLOG-3AWINDOW-TITLE-20GENERIC-FUNCTION-29'></a></p> <p><a id='x-28CLOG-3AWINDOW-TITLE-20GENERIC-FUNCTION-29'></a></p>
@ -4580,6 +4591,46 @@ The on-window-change clog-obj received is the new window</p></li>
<p>Get window content element.</p></li> <p>Get window content element.</p></li>
</ul> </ul>
<p><a id='x-28CLOG-3AWINDOW-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-3AWINDOW-FOCUS-20GENERIC-FUNCTION-29" >WINDOW-FOCUS</a></span></span> <span class="locative-args">CLOG-GUI-WINDOW</span></span></p>
<p>Set <code>CLOG-GUI-WINDOW</code> as focused window.</p></li>
</ul>
<p><a id='x-28CLOG-3AWINDOW-CLOSE-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-CLOSE-20GENERIC-FUNCTION-29" >WINDOW-CLOSE</a></span></span> <span class="locative-args">CLOG-GUI-WINDOW</span></span></p>
<p>Close <code>CLOG-GUI-WINDOW</code>. on-window-can-close is not called.</p></li>
</ul>
<p><a id='x-28CLOG-3AWINDOW-MAXIMIZE-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-MAXIMIZE-20GENERIC-FUNCTION-29" >WINDOW-MAXIMIZE</a></span></span> <span class="locative-args">CLOG-GUI-WINDOW</span></span></p>
<p>Set <code>CLOG-GUI-WINDOW</code> as maximized window.</p></li>
</ul>
<p><a id='x-28CLOG-3AWINDOW-NORMALIZE-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-NORMALIZE-20GENERIC-FUNCTION-29" >WINDOW-NORMALIZE</a></span></span> <span class="locative-args">CLOG-GUI-WINDOW</span></span></p>
<p>Set <code>CLOG-GUI-WINDOW</code> as normalized window.</p></li>
</ul>
<p><a id='x-28CLOG-3AWINDOW-TOGGLE-MAXIMIZE-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-TOGGLE-MAXIMIZE-20GENERIC-FUNCTION-29" >WINDOW-TOGGLE-MAXIMIZE</a></span></span> <span class="locative-args">CLOG-GUI-WINDOW</span></span></p>
<p>Toggle <code>CLOG-GUI-WINDOW</code> as maximize window.</p></li>
</ul>
<p><a id='x-28CLOG-3ASET-ON-WINDOW-CAN-CLOSE-20GENERIC-FUNCTION-29'></a></p> <p><a id='x-28CLOG-3ASET-ON-WINDOW-CAN-CLOSE-20GENERIC-FUNCTION-29'></a></p>
<ul> <ul>
@ -5197,6 +5248,17 @@ on-storage event is fired for changes to :local storage keys.</p></li>
<p>Write to browser document <br>new-line.</p></li> <p>Write to browser document <br>new-line.</p></li>
</ul> </ul>
<p>CLOG-Document - Events</p>
<p><a id='x-28CLOG-3ASET-ON-FULL-SCREEN-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-FULL-SCREEN-CHANGE-20GENERIC-FUNCTION-29" >SET-ON-FULL-SCREEN-CHANGE</a></span></span> <span class="locative-args">CLOG-DOCUMENT ON-FULL-SCREEN-CHANGE-HANDLER</span></span></p>
<p>Set the <code>ON-FULL-SCREEN-CHANGE-HANDLER</code> for <a href="#x-28CLOG-3ACLOG-OBJ-20CLASS-29" title="(CLOG:CLOG-OBJ CLASS)"><code>CLOG-OBJ</code></a>.
If <code>ON-FULL-SCREEN-CHANGE-HANDLER</code> is nil unbind the event.</p></li>
</ul>
<p><a id='x-28CLOG-3A-40CLOG-LOCATION-20MGL-PAX-3ASECTION-29'></a></p> <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> <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>