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

doc update

Browse source
This commit is contained in:
David Botton 2021-02-17 13:54:13 -05:00
parent b19f78d926
commit 9421a601f4
2 changed files with 106 additions and 19 deletions
Download patch file Download diff file Expand all files Collapse all files

95
doc/clog-manual.html
View file

@ -4514,9 +4514,10 @@ clog-body.</p></li>
<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>
<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-OBJ &amp;KEY CLASS HTML-ID</span></span></p>
<p>Attached a menu item to a <code>CLOG-GUI-MENU-DROP-DOWN</code></p></li>
<p>Attached a clog-select as a menu item that auto updates
with open windows and maximizes them. Only one instance allowed.</p></li>
</ul>
<p><a id='x-28CLOG-3ACREATE-GUI-MENU-FULL-SCREEN-20GENERIC-FUNCTION-29'></a></p>
@ -4546,6 +4547,47 @@ icon ⤢ and full screen mode.</p></li>
<p>Get the current selected clog-gui-window</p></li>
</ul>
<p><a id='x-28CLOG-3AMENU-BAR-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-3AMENU-BAR-20GENERIC-FUNCTION-29" >MENU-BAR</a></span></span> <span class="locative-args">CLOG-OBJ</span></span></p>
<p>Get/setf window menu-bar. This is set buy
create-gui-menu-bar.</p></li>
</ul>
<p><a id='x-28CLOG-3AMENU-BAR-HEIGHT-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-3AMENU-BAR-HEIGHT-20GENERIC-FUNCTION-29" >MENU-BAR-HEIGHT</a></span></span> <span class="locative-args">CLOG-OBJ</span></span></p>
<p>Get menu-bar height</p></li>
</ul>
<p><a id='x-28CLOG-3AWINDOW-COLLECTION-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-COLLECTION-20GENERIC-FUNCTION-29" >WINDOW-COLLECTION</a></span></span> <span class="locative-args">CLOG-OBJ</span></span></p>
<p>Get hash table of open windows</p></li>
</ul>
<p><a id='x-28CLOG-3AMAXIMIZE-ALL-WINDOWS-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-3AMAXIMIZE-ALL-WINDOWS-20GENERIC-FUNCTION-29" >MAXIMIZE-ALL-WINDOWS</a></span></span> <span class="locative-args">CLOG-OBJ</span></span></p>
<p>Maximize all windows</p></li>
</ul>
<p><a id='x-28CLOG-3ANORMALIZE-ALL-WINDOWS-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-3ANORMALIZE-ALL-WINDOWS-20GENERIC-FUNCTION-29" >NORMALIZE-ALL-WINDOWS</a></span></span> <span class="locative-args">CLOG-OBJ</span></span></p>
<p>Normalize all windows</p></li>
</ul>
<p><a id='x-28CLOG-3ASET-ON-WINDOW-CHANGE-20GENERIC-FUNCTION-29'></a></p>
<ul>
@ -4607,6 +4649,14 @@ on-window-resize-done at end of resize.</p></li>
<p>Close <code>CLOG-GUI-WINDOW</code>. on-window-can-close is not called.</p></li>
</ul>
<p><a id='x-28CLOG-3AWINDOW-MAXIMIZED-P-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-MAXIMIZED-P-20GENERIC-FUNCTION-29" >WINDOW-MAXIMIZED-P</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-MAXIMIZE-20GENERIC-FUNCTION-29'></a></p>
<ul>
@ -4631,6 +4681,31 @@ on-window-resize-done at end of resize.</p></li>
<p>Toggle <code>CLOG-GUI-WINDOW</code> as maximize window.</p></li>
</ul>
<p><a id='x-28CLOG-3AWINDOW-KEEP-ON-TOP-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-KEEP-ON-TOP-20GENERIC-FUNCTION-29" >WINDOW-KEEP-ON-TOP</a></span></span> <span class="locative-args">CLOG-GUI-WINDOW</span></span></p>
<p>Set <code>CLOG-GUI-WINDOW</code> to stay on top. Use window-focus to undue.</p></li>
</ul>
<p><a id='x-28CLOG-3AWINDOW-MAKE-MODAL-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-MAKE-MODAL-20GENERIC-FUNCTION-29" >WINDOW-MAKE-MODAL</a></span></span> <span class="locative-args">CLOG-GUI-WINDOW</span></span></p>
<p>Set <code>CLOG-GUI-WINDOW</code> to stay on top and prevent all other
interactions. Use window-end-modal to undo.</p></li>
</ul>
<p><a id='x-28CLOG-3AWINDOW-END-MODAL-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-END-MODAL-20GENERIC-FUNCTION-29" >WINDOW-END-MODAL</a></span></span> <span class="locative-args">CLOG-GUI-WINDOW</span></span></p>
<p>Set <code>CLOG-GUI-WINDOW</code> to end modal state.</p></li>
</ul>
<p><a id='x-28CLOG-3ASET-ON-WINDOW-CAN-CLOSE-20GENERIC-FUNCTION-29'></a></p>
<ul>
@ -4695,6 +4770,17 @@ on-window-resize-done at end of resize.</p></li>
<p>Set the on-window-size-done <code>HANDLER</code></p></li>
</ul>
<p><code>CLOG-GUI</code> - Dialog Boxes</p>
<p><a id='x-28CLOG-3ASERVER-FILE-DIALOG-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-3ASERVER-FILE-DIALOG-20FUNCTION-29" >SERVER-FILE-DIALOG</a></span></span> <span class="locative-args">OBJ TITLE INITIAL-DIR ON-FILE-NAME &amp;KEY (LEFT <code>NIL</code>) (TOP <code>NIL</code>) (WIDTH 400) (HEIGHT 375) (MAXIMIZE <code>NIL</code>) (INITIAL-FILENAME <code>NIL</code>)</span></span></p>
<p>Create a local file dialog box called <code>TITLE</code> using <code>INITIAL-DIR</code> on server
machine, upon close <code>ON-FILE-NAME</code> called with filename or nil if failure.</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-GUI-20MGL-PAX-3ASECTION-29" title="CLOG GUI 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>
@ -5043,8 +5129,9 @@ is nil unbind the event.</p></li>
<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-BEFORE-UNLOAD-20GENERIC-FUNCTION-29" >SET-ON-BEFORE-UNLOAD</a></span></span> <span class="locative-args">CLOG-WINDOW ON-BEFORE-UNLOAD-HANDLER</span></span></p>
<p>Set the <code>ON-BEFORE-UNLOAD-HANDLER</code> for <a href="#x-28CLOG-3ACLOG-OBJ-20CLASS-29" title="(CLOG:CLOG-OBJ CLASS)"><code>CLOG-OBJ</code></a>. If
<code>ON-BEFORE-UNLOAD-HANDLER</code> is nil unbind the event.</p></li>
<p>Set the <code>ON-BEFORE-UNLOAD-HANDLER</code> for <code>CLOG-WINDOW</code>.
Return and empty string in order to prevent navigation off page.
If <code>ON-BEFORE-UNLOAD-HANDLER</code> is nil unbind the event.</p></li>
</ul>
<p><a id='x-28CLOG-3ASET-ON-HASH-CHANGE-20GENERIC-FUNCTION-29'></a></p>

30
source/clog-helpers.lisp
View file

@ -97,21 +97,21 @@ clog-user:*body* to last window openned to /repl."
;;;;;;;;;;;;;;;;
(defun load-world ()
(load "clog.lisp")
(load "clog-docs.lisp")
(load "clog-base.lisp")
(load "clog-element.lisp")
(load "clog-element-common.lisp")
(load "clog-canvas.lisp")
(load "clog-form.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")
(load "clog-helpers.lisp"))
(load "source/clog.lisp")
(load "source/clog-docs.lisp")
(load "source/clog-base.lisp")
(load "source/clog-element.lisp")
(load "source/clog-element-common.lisp")
(load "source/clog-canvas.lisp")
(load "source/clog-form.lisp")
(load "source/clog-window.lisp")
(load "source/clog-navigator.lisp")
(load "source/clog-document.lisp")
(load "source/clog-location.lisp")
(load "source/clog-system.lisp")
(load "source/clog-utilities.lisp")
(load "source/clog-body.lisp")
(load "source/clog-helpers.lisp"))
;;;;;;;;;;;;;;;;;;;;
;; make-mark-down ;;