API Reference - WIN

Caveats
Window and screen coordinates through the API are from 0, 0 left, top.

Conventions
Class object properties beginning with a prefix and double underscore are intended as private members.

Most API objects are metatable class based objects. In the documents the class name is used as a place holder for the name of the instantiated object. If a method may be used as a static member (called with the class name) it states so in the remarks. For example, to call the win.buttonWindow:set_colors method:
local btn = win.buttonWindow:new  ( ... )
btn:set_colors (term.colors.red, term.colors.pink, term.colors.purple)
When instantiating a class object pass the parameters for the class' constructor to new:
-- constructor for buttonWindow
-- win.buttonWindow:constructor (parent, id, x, y, label)
local btn = win.buttonWindow:new (appFrame, ID_BTN, 2, 5, "Button")
When a frame implements one of the frame:on_child_* events, if this handler returns true the child window does not receive the event.

Topics
__classBase
applicationFrame
appListFrame
buttonWindow
checkWindow
closeButtonWindow
comm
Common Dialog API
desktopTheme
desktopWindow
editUndo
editWindow
Events
GDI (Graphics Device Interface)
Global
homePageFrame
HTML API
inputWindow
keyboardFrame
labelWindow
listWindow
lockScrnFrame
menuWindow
msgBoxFrame
parentFrame
popupFrame
printData
Private
rect (rectangle)
server
sysMsgBoxFrame
taskBarFrame
textWindow
window
workSpace


See also WIN.