Skip to content

Commit c61e35f

Browse files
rabbibottonrabbibotton
committed
update docs
1 parent b8fe239 commit c61e35f

File tree

3 files changed

+90
-11
lines changed

3 files changed

+90
-11
lines changed

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ embedded in a native template application.)
2828

2929
[CLOG - Technical Overview and Purpose](CONCEPT.md)
3030

31-
STATUS: CLOG and CLOG Builder 1.6 released.
31+
STATUS: CLOG and CLOG Builder 1.7 released.
3232

3333
CLOG is actually based on GNOGA, a framework I wrote for Ada in 2013
3434
and used in commercial production code for the last 9+ years. CLOG

‎doc/clog-manual.html‎

Lines changed: 85 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -390,6 +390,15 @@ <h2><a href="#CLOG:@CLOG-SYSTEM%20MGL-PAX:SECTION">4 CLOG System</a></h2>
390390
<p>Contains the static-root setting after initialization.</p></li>
391391
</ul>
392392

393+
<p><a id="x-28CLOG-3A-2ACLOG-PORT-2A-20VARIABLE-29"></a>
394+
<a id="CLOG:*CLOG-PORT*%20VARIABLE"></a></p>
395+
396+
<ul>
397+
<li><p><span class=reference-bullet><span class=reference><span class="locative-type">[variable]</span> <span class="reference-object"><a href="#CLOG:*CLOG-PORT*%20VARIABLE" >*CLOG-PORT*</a></span></span> <span class="locative-args">8080</span></span></p>
398+
399+
<p>Port this instance of clog was started on</p></li>
400+
</ul>
401+
393402
<p><a id="x-28CLOG-3ASET-ON-NEW-WINDOW-20FUNCTION-29"></a>
394403
<a id="CLOG:SET-ON-NEW-WINDOW%20FUNCTION"></a></p>
395404

@@ -432,7 +441,7 @@ <h2><a href="#CLOG:@CLOG-SYSTEM%20MGL-PAX:SECTION">4 CLOG System</a></h2>
432441
<a id="CLOG:OPEN-BROWSER%20FUNCTION"></a></p>
433442

434443
<ul>
435-
<li><p><span class=reference-bullet><span class=reference><span class="locative-type">[function]</span> <span class="reference-object"><a href="#CLOG:OPEN-BROWSER%20FUNCTION" >OPEN-BROWSER</a></span></span> <span class="locative-args">&amp;KEY (URL &quot;http://127.0.0.1:8080&quot;)</span></span></p>
444+
<li><p><span class=reference-bullet><span class=reference><span class="locative-type">[function]</span> <span class="reference-object"><a href="#CLOG:OPEN-BROWSER%20FUNCTION" >OPEN-BROWSER</a></span></span> <span class="locative-args">&amp;KEY (URL (<a href="http://www.lispworks.com/documentation/HyperSpec/Body/f_format.htm" title="FORMAT FUNCTION"><code>FORMAT</code></a> <code>NIL</code> &quot;http://127.0.0.1:~A&quot; <a href="#CLOG:*CLOG-PORT*%20VARIABLE" title="CLOG:*CLOG-PORT* VARIABLE"><code>*CLOG-PORT*</code></a>))</span></span></p>
436445

437446
<p>Launch on os a web browser on local machine to <code>URL</code>. See <a href="#CLOG:OPEN-WINDOW%20GENERIC-FUNCTION" title="CLOG:OPEN-WINDOW GENERIC-FUNCTION"><code>OPEN-WINDOW</code></a>
438447
for openning windows on remote machines.</p></li>
@@ -582,6 +591,15 @@ <h2><a href="#CLOG:@CLOG-UTILITIES%20MGL-PAX:SECTION">5 CLOG Utilities</a></h2>
582591
<p>Return <code>RGB</code> string, red green and blue may be 0-255</p></li>
583592
</ul>
584593

594+
<p><a id="x-28CLOG-3ARGB-TO-HEX-20FUNCTION-29"></a>
595+
<a id="CLOG:RGB-TO-HEX%20FUNCTION"></a></p>
596+
597+
<ul>
598+
<li><p><span class=reference-bullet><span class=reference><span class="locative-type">[function]</span> <span class="reference-object"><a href="#CLOG:RGB-TO-HEX%20FUNCTION" >RGB-TO-HEX</a></span></span> <span class="locative-args">RGB</span></span></p>
599+
600+
<p>Return hex #rrggbb from rgb(red,green,blue)</p></li>
601+
</ul>
602+
585603
<p><a id="x-28CLOG-3ARGBA-20FUNCTION-29"></a>
586604
<a id="CLOG:RGBA%20FUNCTION"></a></p>
587605

@@ -621,6 +639,16 @@ <h2><a href="#CLOG:@CLOG-UTILITIES%20MGL-PAX:SECTION">5 CLOG Utilities</a></h2>
621639
<p>produce a string from numeric value with <code>UNIT-TYPE</code> appended.</p></li>
622640
</ul>
623641

642+
<p><a id="x-28CLOG-3AUNIT-2A-20FUNCTION-29"></a>
643+
<a id="CLOG:UNIT*%20FUNCTION"></a></p>
644+
645+
<ul>
646+
<li><p><span class=reference-bullet><span class=reference><span class="locative-type">[function]</span> <span class="reference-object"><a href="#CLOG:UNIT*%20FUNCTION" >UNIT*</a></span></span> <span class="locative-args">UNIT-TYPE VALUE</span></span></p>
647+
648+
<p>Returns value and if no unit was specified on value
649+
unit added unless value is empty string or nil.</p></li>
650+
</ul>
651+
624652
<p><a id="x-28CLOG-3A-40CLOG-OBJ-20MGL-PAX-3ASECTION-29"></a>
625653
<a id="CLOG:@CLOG-OBJ%20MGL-PAX:SECTION"></a></p>
626654

@@ -2410,7 +2438,8 @@ <h2><a href="#CLOG:@CLOG-ELEMENT%20MGL-PAX:SECTION">7 CLOG Elements</a></h2>
24102438
<li><p><span class=reference-bullet><span class=reference><span class="locative-type">[generic-function]</span> <span class="reference-object"><a href="#CLOG:SET-GEOMETRY%20GENERIC-FUNCTION" >SET-GEOMETRY</a></span></span> <span class="locative-args">CLOG-ELEMENT &amp;KEY LEFT TOP RIGHT BOTTOM WIDTH HEIGHT UNITS</span></span></p>
24112439

24122440
<p>Change the geometry <code>:LEFT</code> <code>:TOP</code> <code>:RIGHT</code> <code>:BOTTOM</code>
2413-
<code>:WIDTH</code> <code>:HEIGHT</code> each optional in <code>UNITS</code> (default :px)</p></li>
2441+
<code>:WIDTH</code> <code>:HEIGHT</code> each optional. If any measure is missing a unit,
2442+
<code>UNITS</code> (default :px) is used.</p></li>
24142443
</ul>
24152444

24162445
<p><a id="x-28CLOG-3ALEFT-20GENERIC-FUNCTION-29"></a>
@@ -2437,7 +2466,7 @@ <h2><a href="#CLOG:@CLOG-ELEMENT%20MGL-PAX:SECTION">7 CLOG Elements</a></h2>
24372466
<ul>
24382467
<li><p><span class=reference-bullet><span class=reference><span class="locative-type">[generic-function]</span> <span class="reference-object"><a href="#CLOG:RIGHT%20GENERIC-FUNCTION" >RIGHT</a></span></span> <span class="locative-args">CLOG-ELEMENT</span></span></p>
24392468

2440-
<p>Get/Setf right.</p></li>
2469+
<p>Get/Setf right (defaults to us :px units).</p></li>
24412470
</ul>
24422471

24432472
<p><a id="x-28CLOG-3ABOTTOM-20GENERIC-FUNCTION-29"></a>
@@ -2446,7 +2475,7 @@ <h2><a href="#CLOG:@CLOG-ELEMENT%20MGL-PAX:SECTION">7 CLOG Elements</a></h2>
24462475
<ul>
24472476
<li><p><span class=reference-bullet><span class=reference><span class="locative-type">[generic-function]</span> <span class="reference-object"><a href="#CLOG:BOTTOM%20GENERIC-FUNCTION" >BOTTOM</a></span></span> <span class="locative-args">CLOG-ELEMENT</span></span></p>
24482477

2449-
<p>Get/Setf bottom.</p></li>
2478+
<p>Get/Setf bottom (defaults to us :px units).</p></li>
24502479
</ul>
24512480

24522481
<p><a id="x-28CLOG-3ABOX-HEIGHT-20GENERIC-FUNCTION-29"></a>
@@ -8272,6 +8301,46 @@ <h6>[in package CLOG-GUI]</h6>
82728301
<p>Get hash table of open windows</p></li>
82738302
</ul>
82748303

8304+
<p><a id="x-28CLOG-GUI-3AWINDOW-TO-TOP-BY-TITLE-20GENERIC-FUNCTION-29"></a>
8305+
<a id="CLOG-GUI:WINDOW-TO-TOP-BY-TITLE%20GENERIC-FUNCTION"></a></p>
8306+
8307+
<ul>
8308+
<li><p><span class=reference-bullet><span class=reference><span class="locative-type">[generic-function]</span> <span class="reference-object"><a href="#CLOG-GUI:WINDOW-TO-TOP-BY-TITLE%20GENERIC-FUNCTION" >WINDOW-TO-TOP-BY-TITLE</a></span></span> <span class="locative-args">CLOG-OBJ TITLE</span></span></p>
8309+
8310+
<p>Bring window with <code>TITLE</code> to top and return
8311+
window or nil if not found</p></li>
8312+
</ul>
8313+
8314+
<p><a id="x-28CLOG-GUI-3AWINDOW-TO-TOP-BY-PARAM-20GENERIC-FUNCTION-29"></a>
8315+
<a id="CLOG-GUI:WINDOW-TO-TOP-BY-PARAM%20GENERIC-FUNCTION"></a></p>
8316+
8317+
<ul>
8318+
<li><p><span class=reference-bullet><span class=reference><span class="locative-type">[generic-function]</span> <span class="reference-object"><a href="#CLOG-GUI:WINDOW-TO-TOP-BY-PARAM%20GENERIC-FUNCTION" >WINDOW-TO-TOP-BY-PARAM</a></span></span> <span class="locative-args">CLOG-OBJ PARAM</span></span></p>
8319+
8320+
<p>Bring window with <code>PARAM</code> to top and return
8321+
window or nil if not found</p></li>
8322+
</ul>
8323+
8324+
<p><a id="x-28CLOG-GUI-3AWINDOW-BY-TITLE-20GENERIC-FUNCTION-29"></a>
8325+
<a id="CLOG-GUI:WINDOW-BY-TITLE%20GENERIC-FUNCTION"></a></p>
8326+
8327+
<ul>
8328+
<li><p><span class=reference-bullet><span class=reference><span class="locative-type">[generic-function]</span> <span class="reference-object"><a href="#CLOG-GUI:WINDOW-BY-TITLE%20GENERIC-FUNCTION" >WINDOW-BY-TITLE</a></span></span> <span class="locative-args">CLOG-OBJ TITLE</span></span></p>
8329+
8330+
<p>Bring window with <code>TITLE</code> to top and return
8331+
window or nil if not found</p></li>
8332+
</ul>
8333+
8334+
<p><a id="x-28CLOG-GUI-3AWINDOW-BY-PARAM-20GENERIC-FUNCTION-29"></a>
8335+
<a id="CLOG-GUI:WINDOW-BY-PARAM%20GENERIC-FUNCTION"></a></p>
8336+
8337+
<ul>
8338+
<li><p><span class=reference-bullet><span class=reference><span class="locative-type">[generic-function]</span> <span class="reference-object"><a href="#CLOG-GUI:WINDOW-BY-PARAM%20GENERIC-FUNCTION" >WINDOW-BY-PARAM</a></span></span> <span class="locative-args">CLOG-OBJ PARAM</span></span></p>
8339+
8340+
<p>Bring window with <code>PARAM</code> to top and return
8341+
window or nil if not found</p></li>
8342+
</ul>
8343+
82758344
<p><a id="x-28CLOG-GUI-3AMAXIMIZE-ALL-WINDOWS-20GENERIC-FUNCTION-29"></a>
82768345
<a id="CLOG-GUI:MAXIMIZE-ALL-WINDOWS%20GENERIC-FUNCTION"></a></p>
82778346

@@ -8313,7 +8382,7 @@ <h6>[in package CLOG-GUI]</h6>
83138382
<a id="CLOG-GUI:CREATE-GUI-WINDOW%20GENERIC-FUNCTION"></a></p>
83148383

83158384
<ul>
8316-
<li><p><span class=reference-bullet><span class=reference><span class="locative-type">[generic-function]</span> <span class="reference-object"><a href="#CLOG-GUI:CREATE-GUI-WINDOW%20GENERIC-FUNCTION" >CREATE-GUI-WINDOW</a></span></span> <span class="locative-args">CLOG-OBJ &amp;KEY TITLE CONTENT LEFT TOP WIDTH HEIGHT MAXIMIZE HAS-PINNER KEEP-ON-TOP HIDDEN CLIENT-MOVEMENT BORDER-CLASS TITLE-CLASS HTML-ID</span></span></p>
8385+
<li><p><span class=reference-bullet><span class=reference><span class="locative-type">[generic-function]</span> <span class="reference-object"><a href="#CLOG-GUI:CREATE-GUI-WINDOW%20GENERIC-FUNCTION" >CREATE-GUI-WINDOW</a></span></span> <span class="locative-args">CLOG-OBJ &amp;KEY TITLE CONTENT LEFT TOP WIDTH HEIGHT MAXIMIZE HAS-PINNER KEEP-ON-TOP WINDOW-PARAM HIDDEN CLIENT-MOVEMENT BORDER-CLASS TITLE-CLASS HTML-ID</span></span></p>
83178386

83188387
<p>Create a clog-gui-window. If client-movement is t then
83198388
use jquery-ui to move/resize and will not work on mobile. When client-movement
@@ -8322,7 +8391,8 @@ <h6>[in package CLOG-GUI]</h6>
83228391
on-window-resize-done at end of resize. If has-pinner a toggle wil appear on
83238392
title bar to allow pinning the window in place, if keep-on-top t then when
83248393
pinned also will keep-on-top. If had-pinned is nil and keep-on-top t then
8325-
the window will be set to keep-on-top always.</p></li>
8394+
the window will be set to keep-on-top always. window-param is a general parameter
8395+
for identifiying the window to use with window-to-top-by-param or window-by-param.</p></li>
83268396
</ul>
83278397

83288398
<p><a id="x-28CLOG-GUI-3AWINDOW-TITLE-20GENERIC-FUNCTION-29"></a>
@@ -8334,6 +8404,15 @@ <h6>[in package CLOG-GUI]</h6>
83348404
<p>Get/setf window title</p></li>
83358405
</ul>
83368406

8407+
<p><a id="x-28CLOG-GUI-3AWINDOW-PARAM-20GENERIC-FUNCTION-29"></a>
8408+
<a id="CLOG-GUI:WINDOW-PARAM%20GENERIC-FUNCTION"></a></p>
8409+
8410+
<ul>
8411+
<li><p><span class=reference-bullet><span class=reference><span class="locative-type">[generic-function]</span> <span class="reference-object"><a href="#CLOG-GUI:WINDOW-PARAM%20GENERIC-FUNCTION" >WINDOW-PARAM</a></span></span> <span class="locative-args">CLOG-GUI-WINDOW</span></span></p>
8412+
8413+
<p>Get/setf window param</p></li>
8414+
</ul>
8415+
83378416
<p><a id="x-28CLOG-GUI-3AWINDOW-CONTENT-20GENERIC-FUNCTION-29"></a>
83388417
<a id="CLOG-GUI:WINDOW-CONTENT%20GENERIC-FUNCTION"></a></p>
83398418

‎source/clog-gui.lisp‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -270,7 +270,7 @@ window or nil if not found"))
270270
(declare (ignore key))
271271
(when (equalp (window-title value) title)
272272
(window-focus value)
273-
(setf r key)))
273+
(setf r value)))
274274
(windows app))
275275
r))
276276

@@ -289,7 +289,7 @@ window or nil if not found"))
289289
(declare (ignore key))
290290
(when (equalp (win-param value) param)
291291
(window-focus value)
292-
(setf r key)))
292+
(setf r value)))
293293
(windows app))
294294
r))
295295

@@ -307,7 +307,7 @@ window or nil if not found"))
307307
(maphash (lambda (key value)
308308
(declare (ignore key))
309309
(when (equalp (window-title value) title)
310-
(setf r key)))
310+
(setf r value)))
311311
(windows app))
312312
r))
313313

@@ -325,7 +325,7 @@ window or nil if not found"))
325325
(maphash (lambda (key value)
326326
(declare (ignore key))
327327
(when (equalp (win-param value) param)
328-
(setf r key)))
328+
(setf r value)))
329329
(windows app))
330330
r))
331331

0 commit comments

Comments
 (0)