From d97593b6952d0c08c384570c074a5cc62a941bd4 Mon Sep 17 00:00:00 2001 From: "D. Rimron-Soutter" Date: Tue, 28 Apr 2020 21:11:53 +0100 Subject: [PATCH] Added github readme --- SPUI/README.md | 38 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) create mode 100644 SPUI/README.md diff --git a/SPUI/README.md b/SPUI/README.md new file mode 100644 index 0000000..6cd8da2 --- /dev/null +++ b/SPUI/README.md @@ -0,0 +1,38 @@ +Stale Pixels User Interface tools (aka SPUI) +-- + +Abstract +== +SPUI is a DotCommand for the ZX Spectrum Next. It's primary (sole?) purpose is to make the creation of User Interaction +flows from NextBASIC (a) easier; (b) less ugly; (c) less effort; (d) consistent. + +Quick Start +== +.SPUI -h will get you the built-in help. + +When building GUIs the second parameter is compulsory. + +Currently the only supported type is MENU. + +Parameters +== + * -x = X position, aka left most column + * -y = Y position, aka top most row + * -r = Rows used for content, aka height + * -c = Columns used for content, aka width + * -t = Title of the dialog box + +Setup +== + To prevent unexpected side-effects, unless instructed, you should pre-load Register 0x7F with 0. + +Types +== +*MENU* + A list of menu entries follow the type and optional parameters. These strings are presented in a 128k style menu. The selected item is returned in Reg 0x7F. This is 0 is the menu is cancelled with BREAK. + +More Information +== +See the /docs/ folder + +--Xalior, 20200428 \ No newline at end of file