win.WND_TOP | 0 | Bring window to top of parent children. |
win.WND_BOTTOM | 100000 | Send window to bottom of parent children. |
win.HT_NOWHERE | 0 | Hit not in window. |
win.HT_CLIENT | 1 | Hit client area of window. |
win.HT_LINEUP | 2 | Hit vertical scroll bar line up button. |
win.HT_LINEDOWN | 3 | Hit vertical scroll bar line down button. |
win.HT_PAGEUP | 4 | Hit vertical scroll bar track to page up. |
win.HT_PAGEDOWN | 5 | Hit vertical scroll bar track to page down. |
win.HT_LINELEFT | 6 | Hit horizontal scroll bar line left button. |
win.HT_LINERIGHT | 7 | Hit horizontal scroll bar line right button. |
win.HT_PAGELEFT | 8 | Hit horizontal scroll bar track to page left. |
win.HT_PAGERIGHT | 9 | Hit horizontal scroll bar track to page right. |
win.ID_TITLEBAR | 80000 | Title bar window id. |
win.ID_CLOSE | 80001 | Window close button id. |
win.CB_EMPTY | 0 | Clipboard is empty. |
win.CB_TEXT | 1 | Clipboard data is plain text. |
win.KEYINPUT_NONE | 0 | No key input. |
win.KEYINPUT_LINE | 1 | Single line key input. |
win.KEYINPUT_EDIT | 2 | Multi-line key input. |
srcpath | string |
Path of existing file or folder. |
destpath | string | Path to copy to. |
recurse | boolean |
If true and copying folder, recursively
copies contents of folder also. |
result | boolean | True if operation succeeded, false if not.
Note for folder operations some files may have been copied
even if failed. |
count | number |
The count of files and folders copied. |
msg | string/nil |
On failure, an error message. |
parent | string | Full parent path to check. |
sub | string | Full sub path to test. |
result | boolean | True if sub path is under parent path, false
if not. |
path | string | The file path of the ini file to load. Must be the full path to the file. |
ini | table | Table of key/value pairs, or nil if unsuccessful. |
local ini = fs.load_ini ("/somefile.ini")
if ini then local value = tostring ((ini:find ("key")) or "default value") -- do something end
local ini = fs.load_ini ("/somefile.ini")
if ini then for value in ini:next ("key") do -- do something end end
path | string |
The full path of the file or folder to
delete. |
recurse | boolean |
Deleting folders only: If true and folder has content, recursively deletes contents of folder if not empty. If false and folder has content, operation fails. Ignored when deleting files. |
result | boolean |
True if operation succeeded, false if not. Note for folder operations some files may have been deleted even if failed. |
count | number |
The count of files and folders deleted. |
msg | string/nil | On failure, an error message. |
prefix | string/nil |
A prefix for the file/folder name. If nil "tmp" is used. |
path | string | The returned full path. |
none |
none |
none |
none |
src | string | The string to splice. |
len | number | The maximum length of the returned string. |
str | string | The spliced string. |
remaining | string/nil | Any of the source string remaining after the splice. If none nil is returned. |
new_line | boolean | True if the string was spliced for a hard or soft break, otherwise false. |
mid_word |
boolean |
True if the string was spliced mid-word,
false if not. |
src | string | The source string to trim. |
char | string/nil | The character/s to trim. If more than one character only exact groups are removed. If nil a space character is assumed. |
str | string | The trimmed string. |
src | string | The source string to trim. |
char | string | The character/s to trim. If more than one character only exact groups are removed. If nil a space character is assumed. |
str | string | The trimmed string. |
src | string | The source string to trim. |
char | string | The character/s to trim. If more than one character only exact groups are removed. If nil a space character is assumed. |
str | string | The trimmed string. |
src | string | The string value to wrap. |
len | number | The maximum character length of a line. |
lines | table | Returned table of strings; one for each line. |
wrap_strs |
table | A table of string lines, typically returned by string:wrap. |
width | number | The maximum character width of any line in wrapped string table. |
height | number | The number of lines in wrapped string table. |
none |
appFrame | applicationFrame | The instance of the application's main frame. |
none |
printers |
table |
List of printer channels. |
path | string | Full path to the api file to load. |
perm | boolean/nil | If true the api is permanently loaded. |
result | boolean | True if the api was successfully loaded, false if not. |
... | string | The command line to parse. May be a single or series of string values. |
args | table | An indexed table of the command line arguments, in order. Typically the command itself is the first. |
wnd | window | The window object to use for the conversion. |
x | number | Screen relative x coordinate. |
y | number | Screen relative y coordinate. |
x | number | Window relative x coordinate. |
y | number | Window relative y coordinate. |
none |
none |
entry | string | The log file entry to write. |
none |
path | string | Full path of the api file to be unloaded. |
none |
none |
ver |
number |
The running version of WIN. |
wnd | window | The window object to use for the conversion. |
x | number | Window relative x coordinate. |
y |
number | Window relative y coordinate. |
x | number | Screen relative x coordinate. |
y |
number | Screen relative y coordinate. |