about GUI functions manual

[johu]

In http://www.newlisp.org/guiserver/guiserver.lsp.html">GUI functions Manual, some parameters missing.



gs_color-dialog

parameter: <float-blue - The initial blue color component.


parameter: float-blue - The initial blue color component.




split-pane

parameter: <int-divider-size) - The optional size of the draggable divider in pixels.


parameter: int-divider-size - The optional size of the draggable divider in pixels.




undo-enable

syntax: (<font color=#CC0000>gs:undo-enable</font> sym-id <boolean-enabled)


syntax: (<font color=#CC0000>gs:undo-enable</font> sym-id boolean-enabled)

[Lutz]

Thanks Johu, a corrected version is available here:



http://www.newlisp.org/guiserver/">http://www.newlisp.org/guiserver/



Ps: actually the correction were made in guiserver.lsp which then gets processed by newlispdoc to generate the HTML files.

[johu]

In http://www.newlisp.org/guiserver/guiserver.lsp.html#gs_eva-shell">GUI functions Manual & http://www.newlisp.org/guiserver/index.html">Index,



gs:eva-shell -> gs:eval-shell

[johu]

In http://www.newlisp.org/guiserver/guiserver.lsp.src.html">GUI functions source, some comments have mistakes.



;; @param Mstr-description> An optional mask description.

;; @param <str-description> An optional mask description.



;; @syntax (gs:eva-shell <sym-id-text-area> <str-command>)

;; @syntax (gs:eval-shell <sym-id-text-area> <str-command>)

[Lutz]

Thanks Johu, the corrected version is online here:



http://www.newlisp.org/guiserver/">http://www.newlisp.org/guiserver/

[johu]

In http://www.newlisp.org/guiserver/guiserver.lsp.src.html">GUI functions source, I found some mistakes of commants, maybe.



If the following is correct, the source changed is http://cid-23a9a25e1aec3626.office.live.com/self.aspx/.Public/guiserver%5E_manual.zip">here.



I changed only the commnets of source, 'guiserverEx.lsp'.

And 'guiserver_manual-J.html' is with Japanese-translation.





;; be installed. See the desription for 'gs:play-note' for details.

;; be installed. See the description for 'gs:play-note' for details.



;; on Win32. When using the Win32 binary installer 'NEWLISPDIR' is written to

;; on Win32. When using the Win32 binary installer 'NEWLISPDIR' is written



;; ;;;; initialization

;; ; initialization



;; ;;;; describe the GUI

;; ; describe the GUI



;; ;;;; define actions

;; ; define actions



;; ;;;; listen for incoming action requests and dispatch

;; ; listen for incoming action requests and dispatch



;; ;; eof

;; ; eof



;; newLISP-GS is an event driven asyncronous system. Most functions return

;; newLISP-GS is an event driven asynchronous system. Most functions return



;; the return valuse is sent beack from newLISP-GS.

;; the return valuse is sent back from newLISP-GS.



;; After all tag operations redrawing is initiated by default, but it can be forced off by spcifying

;; After all tag operations redrawing is initiated by default, but it can be forced off by specifying



;; Items are added in the same sequence as they appear in the 'gs:add-list' command and added to the

;; Items are added in the same sequence as they appear in the 'gs:add-list-item' command and added to the



;; @param <list-of-notes> A list of notes. Each note is a list of key duration velocity and channel.;;

;; @param <list-of-notes> A list of notes. Each note is a list of key duration velocity and bend.

;;



;; The second example shows the usage of pitch-bend in notes:

;; @example

;; The second example shows the usage of pitch-bend in notes:

;;

;; @example



;; @param <str-icon-path> An optional text for the button.

;; @param <str-text> An optional text for the button.



;; A canvas is a pane for drawing and receiving mouse input events. For most

;; A canvas is a panel for drawing and receiving mouse input events. For most



;; the canvas is treated like a 'gs:pane', with a flow layout by default.

;; Similar to a panel created with 'gs:pane' other layouts can be set.

;; the canvas is treated like a 'gs:panel', with a flow layout by default.

;; Similar to a panel created with 'gs:panel' other layouts can be set.



;; @param <int-microseconds> Wait for for an event a maximum of <int-microseconds> and execute it.

;; @param <int-microseconds> Wait for an event a maximum of <int-microseconds> and execute it.



;; <tt>1</tt> for the no- or <tt>3</tt> for the cancel-button.

;; <tt>1</tt> for the no- or <tt>2</tt> for the cancel-button.



;; @param <sym-id-text-area> The name of the text are in which to evaluate text.

;; @param <sym-id-text-area> The name of the text area in which to evaluate text.



;; @syntax (gs:find-text <sym-id> <str-text> <sym-action> [<str-direction>])

;; @param <sym-id> The name of the textr area or text pane.

;; @param <boolean-next> The optional direction string '"next"' (default) or '"previous"'.

;; @param <sym-action> A optional action to peform after find-text.

;; @syntax (gs:find-text <sym-id> <str-text> <sym-action> [<str-direction>])

;; @param <sym-id> The name of the text area or text pane.

;; @param <str-text> The searching text.

;; @param <sym-action> A optional action to peform after find-text.

;; @param <str-direction> The optional direction string '"next"' (default) or '"previous"'.



;; @return The version string of newLISP-GS running.

;; @return The version of newLISP-GS running.



;; @syntax (gs:key-event <sym-id> <sym-action>)

;; @param <sym-canvas> The id of the component to register the action handler.

;; @syntax (gs:key-event <sym-id> <sym-action>)

;; @param <sym-id> The id of the component to register the action handler.



;; includes text widgets, which alrady handle key events using their normal event

;; includes text widgets, which already handle key events using their normal event



;; @param <str-item> Zero, one or more text entries in the list box.

;; @param <list-str-items> Zero, one or more text entries in a list.



;; <click-count> - the number of times the mouse has been clicked


;; </tt>

;; <click-count> - the number of times the mouse has been clicked




;; @syntax (gs:mouse-event <sym-id> <sym-action>)

;; @param <sym-canvas> The id of the component to register the action handler.

;; @syntax (gs:mouse-event <sym-id> <sym-action>)

;; @param <sym-id> The id of the component to register the action handler.



;; The following code is a complete example:

;; @example

;; The following code is a complete example:

;;

;; @example



;; The second example demonstrated usage of the <int-bend> parameter:

;; @example

;; The second example demonstrated usage of the <int-bend> parameter:

;;

;; @example



;; sequenced from start to end with no repetiton (loop count of 0). Note that the start and

;; end positions refer only to loop played after playing the full track. After the sequence

;; sequenced from start to end with no repetiton (loop count of 0). Note that the start-loop and

;; end-loop positions refer only to loop played after playing the full track. After the sequence



;; index equal or greater to the number of items in the list, the item is added at the end.

;; index equal or greater to the number of items in the list, the item is removed at the end.



;; @syntax (gs:set-scale <int-x> <int-y>)

;; @param <int-x> The X-scale value of the current canvas.

;; @param <int-y> The Y-scale value of the current canvas.

;; @syntax (gs:set-scale <float-x> <float-y>)

;; @param <float-x> The X-scale value of the current canvas.

;; @param <float-y> The Y-scale value of the current canvas.



;; For a <float-width> 0f 0.0 the thinnest possible line width be be chosen.

;; For a <float-width> 0f 0.0 the thinnest possible line width be chosen.



;; when loading and saving files. On Mac OX X UTF-8 mode is by default enabled.

;; when loading and saving files. On Mac OS X UTF-8 mode is by default enabled.



;; @param <int-height> The optional height of the text area.

;; @example

;; @param <int-height> The optional height of the text area.

;;

;; @example



;; @param <int-columns> The number of columns in the text field.

;; @example

;; @param <int-columns> The number of columns in the text field.

;;

;; @example



;; and 'gs:append-text' will work only on the 'text/plain' content style.

;; @example

;; and 'gs:append-text' will work only on the 'text/plain' content style.

;;

;; @example

[Lutz]

Thanks for all the corrections Johu.



corrections now online: http://www.newlisp.org/guiserver/index.html">http://www.newlisp.org/guiserver/index.html



PS:  I also corrected gs:confirm-dialog (type "plain") instead of (type plain) for the default parameter. Now version 1.38



The development version is already at 1.40 including Unya's gs:text-field password mask additions.



Development 10.2.15 will be posted next week.