| x |
number | Parent relative x position of window. |
| y |
number | Parent relative y position of window. |
| width |
number | Width of window. |
| height |
number | Height of window. |
| gdi | GDI | Window GDI object. |
| wnd__alive | boolean | Indicator used during destruction. |
| wnd__bg_color |
number | Window background colour. |
| wnd__color |
number | Window text/fore colour. |
| wnd__cursor_x |
number | Window relative cursor x position. |
| wnd__cursor_y |
number | Window relative cursor y position. |
| wnd__enabled | boolean | Window enabled property. |
| wnd__frame_class |
number | Window's frame class. |
| wnd__hidden | boolean | Window visibility property. |
| wnd__id | number | Window id number. |
| wnd__invalid | rect | Window's invalidated rectangle. |
| wnd__nodes | table | Child window list. |
| wnd__owner | parentFrame | Owner frame (for popups). |
| wnd__parent | window | Parent window. |
| wnd__popup | parentFrame | Current popup (for frames). |
| wnd__scroll_x | number | Scroll x offset (always positive). |
| wnd__scroll_y | number | Scroll y offset (always positive). |
| wnd__scroll_width | number | Scrollable width of window. |
| wnd__scroll_height | number | Scrollable height of window. |
| wnd__text | string | Window text property. |
| wnd__want_focus |
boolean | True if window can take input focus. |
| wnd__want_key_input |
number | Indicator if on screen keyboard should be invoked on touch. |
| wnd__do_keyboard |
boolean | Flag to indicate if on screen keyboard should
be invoked. |
| parent | window | Parent window in window hierarchy. |
| id | number | Numeric id value for the window. |
| x | number | Parent relative x position. |
| y | number | Parent relative y position. |
| width | number | Width of the window. |
| height | number | Height of the window. |
| wnd | window | The instantiated window object. |
| none |
| none |
| none |
| width | number | Width of window client area (excluding any
scroll bars). |
| height | number | Height of window client area (excluding any scroll bars). |
| none |
| rt | rect | Window's parent relative coordinates. |
| x | number | Window relative x position. |
| y | number | Window relative y position. |
| hit | number | Hit item indicator. |
win.HT_NOWHERE = 0 win.HT_CLIENT = 1 win.HT_LINEUP = 2 win.HT_LINEDOWN = 3 win.HT_PAGEUP = 4 win.HT_PAGEDOWN = 5 win.HT_LINELEFT = 6 win.HT_LINERIGHT = 7 win.HT_PAGELEFT = 8 win.HT_PAGERIGHT = 9The coordinate parameters are floored to integer values.
| x | number/nil | Parent relative x position. |
| y | number/nil | Parent relative y position. |
| width | number/nil | Window width. |
| height | number/nil | Window height. |
| z | number/nil | Sibling window relative position. |
| none |
win.WND_TOP = 0 win.WND_BOTTOM = 100000Invalidation is done and the on_move handler is called.
| x | number | Screen relative x coordinate. |
| y | number | Screen relative y coordinate. |
| x | number | Window relative x coordinate. |
| y | number | Window relative y coordinate. |
| x | number | Scroll relative x coordinate. |
| y | number | Scroll relative y coordinate. |
| x | number | Window relative x coordinate. |
| y | number | Window relative y coordinate. |
| x | number | Window relative horizontal position. |
| y | number | Window relative vertical position. |
| disabled | boolean | Include disabled windows if true, not if false. |
| hidden | boolean | Include invisible windows if true, not if false. |
| wnd | window | The sort window object, or nil if none found. |
| x | number | Window relative horizontal position. |
| y | number | Window relative vertical position. |
| wnd | window | The sort window object, or nil if none found. |
| x | number | Window relative x coordinate. |
| y | number | Window relative y coordinate. |
| x | number | Screen relative x coordinate. |
| y | number | Screen relative y coordinate. |
| x | number | Window relative x coordinate. |
| y | number | Window relative y coordinate. |
| x | number | Scroll relative x coordinate. |
| y | number | Scroll relative y coordinate. |
| gdi | GDI | GDI object to use for drawing. |
| bounds | rect | Invalidated area of the window. |
| none |
| none |
| gdi | GDI | The returned gdi object. |
| x | number/nil | Window relative x coordinate. |
| y | number/nil | Window relative y coordinate. |
| width | number/nil | Width to invalidate. |
| height | number/nil | Height to invalidate. |
| none | ||
wnd:invalidate ()The coordinate parameters are floored to integer values.
| gdi | GDI | The GDI object to use for drawing. |
| children | boolean | If true child windows are also draw. |
| hidden | boolean | If the window is invisible and this parameter is true, the window is still drawn. Otherwise an invisible window is not drawn. |
| none |
| none |
| none |
| force | boolean | If true the whole window is redrawn, otherwise only the invalidated area (if any). |
| rt | rect | Screen relative affected area of drawing. It may be empty, if no area was drawn. |
| none |
| none |
| enable | boolean | True to enable, false to disable. |
| none |
| none |
| color | number | The window's background color. |
| none |
| color | number | Window's fore color. |
| none |
| id | number | Window's numeric id. |
| none |
| dir |
string | The desktop directory. |
| none |
| text | string | Window's text value. |
| none |
| want | boolean | True if the window can have input focus, false if not. |
| none |
| want | number | Value indicating desired action. |
win.KEYINPUT_NONE = 0 -- No on screen keyboard.
win.KEYINPUT_LINE = 1 -- Dismiss keyboard on cancel or enter keys.
win.KEYINPUT_EDIT = 2 -- Dismiss keyboard on cancel key only.
| none |
| enabled | boolean | True if enabled, false if disabled. |
| none |
| shown | boolean | True if visible, false if not. |
| color | number | Color to set. |
| none |
| color | number | Color to set. |
| none |
| id | number | Numeric id value for window. |
| none |
| text | string | Text value to set. |
| none |
| want | boolean | True if the window can have input focus, false if not. |
| none |
| want | number | Value indicating desired action. |
| none |
win.KEYINPUT_NONE = 0 -- No on screen keyboard. win.KEYINPUT_LINE = 1 -- Dismiss keyboard on cancel or enter keys. win.KEYINPUT_EDIT = 2 -- Dismiss keyboard on cancel key only.See window:get_want_key_input.
| show | boolean | True to show, false to hide. |
| none |
| name | string | The name of the connection to close. |
| result | boolean | True if the connection was closed, false if not (the connection wasn't found). |
| none |
| result | boolean | True if there are any connections, otherwise false. |
| name | string/nil | The name of the connection. |
| com | comm | The comm object or nil if none matching found. |
| name | string | The name of the connection. If nil a unique name is generated. |
| timeout | number | Count of os.clock () an operation will wait/attempt until a failure is accepted. If nil the default is 5. |
| com | comm | The comm connection object, or nil if the connection could not be established. |
| recipient | string/number/nil | The intended recipient computer's label or id number. If nil the message is broadcasted to all computers on the connection's port/channel. |
| application | string | Identifier for message filtering. This should match the sender's and recipient's registered application filter. |
| context | string | Message specific context. This states the purpose/structure of the data. |
| data | table/string/number | The data for the message, if any. |
| name | string/nil | The name of the connection to use to send the message. |
| message_id | number | Unique identifier for the message, or nil if the send was not successful (no appropriate connection). This can be used to identify the message in the sent handler. |
| application | string/nil | The message filtering identifier the interest was registered with. |
| name | string/nil | The name of the connection the interest was registered with. |
| result | boolean | True if the interest was successfully unregistered, false if not (a matching interest was not found on the specified connection). |
| application | string | Identifier for filtering which messages should be passed to the sent notification and receive handlers. |
| name | string/nil | The name of the connection to register the interest with. |
| result | boolean | True if the interest was successfully registered, false if not (no appropriate connection was found). |
| child | window | The child window to add. |
| none |
| child | number | The child window to find. |
| index | number | Child window's index, or zero if not found. |
| none |
| count | number | Count of child windows. |
| none |
| frame | applicationFrame | The application frame object. |
| index | number | Index of child to retrieve (1 based). |
| child | window/nil | The child window, or nil if index is out of range. |
| none |
| colors | table | Desktop theme's color table. |
| none |
| desktop | desktopWindow | The desktop window object. |
| none |
| parent | window | Parent window. |
| none |
| frame | window | The parent frame window object, or nil if none. |
| none |
| theme | desktopTheme | Desktop theme object. |
| id | number | The window id to search for. |
| recursive | boolean | If not false, the search recursively checks child windows after all immediate children have been checked. If nil, defaults to true. |
| wnd | window | The sort window object, or nil if not found. |
| none |
| workspace | workSpace | The top system object. |
| child | window | The child window to remove. |
| removed | boolean | true if the child was removed, false if not. |
| parent | window | Window to set as parent of this window. |
| none |
| none |
| x | number | Left scroll origin position. |
| y | number | Top scroll origin position. |
| none |
| width | number | Window scroll width. |
| height | number | Window scroll Height. |
| none |
| vertical | boolean | True if the vertical scroll bar is currently visible, false if not. |
| horizontal | boolean | True if the horizontal scroll bar is currently visible, false if not. |
| cols | number | Columns (characters) to scroll. |
| none |
| lines | number | Lines to scroll. |
| none |
| x | number | Left scroll origin position. |
| y | number | Top scroll origin position. |
| none |
| width | number | Window scroll width. |
| height | number | Window scroll height. |
| none |
| none |
| x | number | Cursor scroll relative x position. |
| y | number | Cursor scroll relative y position. |
| none |
| none |
| blink | boolean | True to display cursor, false to hide. |
| none |
| x | number | Cursor scroll relative x position. |
| y | number | Cursor scroll relative y position. |
| none |
| none |
| none |
| none |
| wnd | window | Window object that has capture, or nil if none. |
| none |
| none |
| ctrl | boolean | True for control key depressed, false for not. |
| alt | boolean | True for alternate key depressed, false for not. |
| shift | boolean | True for shift key depressed, false for not. |
| match | boolean | True if keys state matches. |
| none |
| wnd | window | Window with input focus, or nil if none. |
| none |
| none |
| none |
| focused | boolean | True if made focused window (for the frame), false if not. |
| suspend | boolean |
True to stop keyboard from displaying, false
to display. |
| none |
| none |
| type | number | Clipboard data type. |
| data | any | Clipboard data. |
| data | any | Data to place on clipboard. |
| type | number | Type of data. |
| none |
win.CB_EMPTY = 0 win.CB_TEXT = 1See window:get_clipboard.
| alarm_id | number |
The id of the alarm returned by
window:set_alarm to remove. |
| none |
| timer_id | number | The id of the timer returned by window:start_timer to remove. |
| none |
| time | number | Time value for alarm. |
| alarm_id | number | Alarm id. |
| timeout | number | Timeout value in seconds. |
| timer_id |
number | Timer id. |
| wnd | window | The child window object the event is for. |
| event | string | The event type. |
| p1 | any | First parameter to event or nil if not used. |
| p2 | any | Second parameter to event or nil if not used. |
| p3 | any | Third parameter to event or nil if not used. |
| p4 | any | Fourth parameter to event or nil if not used. |
| p5 | any | Fifth parameter to event or nil if not used. |
| ... | any | Any additional parameters. |
| result | boolean | Return value from the child event handler. |
| wnd | window | The window object the event is for. |
| event | string | The event type. |
| ... | any | Any additional parameters. |
| result | boolean | Return value from the event handler. |
| event | string | The event type. |
| p1 | any | First parameter to event or nil if not used. |
| p2 | any | Second parameter to event or nil if not used. |
| p3 | any | Third parameter to event or nil if not used. |
| p4 | any | Fourth parameter to event or nil if not used. |
| p5 | any | Fifth parameter to event or nil if not used. |
| ... | any | Any additional parameters. |
| result | boolean | Return value from the event handler. |
| event | string | The event type. |
| ... | any | Any additional parameters. |
| result | boolean | Return value from the event handler. |
| event | string/nil | Event type, or nil for all wanted events. |
| result | boolean | True if successful or false if not (the event was not registered for the window). Always true if event is nil (or omitted). |
| event | string | Event type. The wildcard "*" will send all non-standard routed events to the window. |
| result | boolean | True if registered successfully or false if not (the event is already registered for this window). |
| id | number | The alarm id (gained when the alarm was set). |
| result | boolean | Always false. |
| focused | window | The window gaining focus, it may be nil. |
| result | boolean | Always false. |
| char | string | Single character string; the character input by user. |
| ascii | number |
The character code of the input character. |
| result | boolean | Always false. |
| child | window | Child window the event is for. |
| focused | window | The window gaining focus, it may be nil. |
| result | boolean | Always false. |
| child | window | Child window the event is for. |
| char | string | Single character string; the character input by user. |
| ascii | number | The character code of the input character. |
| result | boolean | Always false. |
| child | window | Child window the event is for. |
| text | string | The text data to paste. |
| result | boolean | Always false. |
| child | window | Child window the event is for. |
| event | string | The event type. |
| p1 | any | First parameter to event or nil if not used. |
| p2 | any | Second parameter to event or nil if not used. |
| p3 | any | Third parameter to event or nil if not used. |
| p4 | any | Fourth parameter to event or nil if not used. |
| p5 | any | Fifth parameter to event or nil if not used. |
| ... | any | Any additional parameters. |
| result | boolean | Always false. |
| child | window | Child window the event is for. |
| blurred | window | The window losing focus, it may be nil. |
| result | boolean | Always false. |
| child | window | Child window the event is for. |
| key | number | Key code. |
| ctrl | boolean | True if control key is depressed. |
| alt | boolean | True if alternate key is depressed. |
| shift | boolean | True if shift key is depressed. |
| result | boolean | Always false. |
| child | window | Child window the event is for. |
| key | number | Key code. |
| result | boolean | Always false. |
| child | window | Child window the event is for. |
| x | number | Screen relative x position. |
| y | number | Screen relative y position. |
| count | number | The number of times this same position was
repeatedly clicked, with each successive click within the double_click_time. |
| result | boolean | Always false. |
| child | window | Child window the event is for. |
| x | number | Screen relative x position. |
| y | number | Screen relative y position. |
| result | boolean | Always false. |
| child | window | Child window the event is for. |
| x | number | Screen relative x position. |
| y | number | Screen relative y position. |
| result | boolean | Always false. |
| child | window | Child window the event is for. |
| x | number | Screen relative x position. |
| y | number | Screen relative y position. |
| count | number | The number of times this same position was repeatedly clicked, with each successive click within the double_click_time. |
| result | boolean | Always false. |
| child | window | Child window the event is for. |
| x | number | Screen relative x position. |
| y | number | Screen relative y position. |
| result | boolean | Always false. |
| child | window | Child window the event is for. |
| x | number | Screen relative x position. |
| y | number | Screen relative y position. |
| result | boolean | Always false. |
| child | window | Child window the event is for. |
| x | number | Screen relative x position. |
| y | number | Screen relative y position. |
| count | number | The number of times this same position was repeatedly clicked, with each successive click within the double_click_time. |
| result | boolean | Always false. |
| child | window | Child window the event is for. |
| x | number | Screen relative x position. |
| y | number | Screen relative y position. |
| result | boolean | Always false. |
| child | window | Child window the event is for. |
| x | number | Screen relative x position. |
| y | number | Screen relative y position. |
| result | boolean | Always false. |
| child | window | Child window the event is for. |
| x | number | Screen relative x position. |
| y | number | Screen relative y position. |
| result | boolean | Always false. |
| text | string | The text data to paste. |
| result | boolean | Always false. |
| none |
| none |
| event | string | The event type. |
| p1 | any | First parameter to event or nil if not used. |
| p2 | any | Second parameter to event or nil if not used. |
| p3 | any | Third parameter to event or nil if not used. |
| p4 | any | Fourth parameter to event or nil if not used. |
| p5 | any | Fifth parameter to event or nil if not used. |
| ... | any | Any additional parameters. |
| result | boolean | Always false. |
| blurred | window | The window losing focus, it may be nil. |
| result | boolean | Always false. |
| none |
| result | boolean | Always false. |
| direction | number | -1 if scrolled up, 1 if down. |
| page | boolean | True for page action, false for column action. |
| result | boolean | Always true. |
| count | number | Number of successive times (1 based) the idle event was propagated since any other event type was processed. |
| result | boolean | Always false. |
| key | number | Key code. |
| ctrl | boolean | True if control key is depressed. |
| alt | boolean | True if alternate key is depressed. |
| shift | boolean | True if shift key is depressed. |
| result | boolean | Always false. |
| key | number | Key code. |
| result | boolean | Always false. |
| x | number | Window relative x position. |
| y | number | Window relative y position. |
| count | number | The number of times this same position was repeatedly clicked, with each successive click within the double_click_time. |
| result | boolean | True if scroll bar actioned, false if not. |
| x | number | Window relative x position. |
| y | number | Window relative y position. |
| result | boolean | Always false. |
| x | number | Window relative x position. |
| y | number | Window relative y position. |
| result | boolean | Always false. |
| x | number | Window relative x position. |
| y | number | Window relative y position. |
| count | number | The number of times this same position was repeatedly clicked, with each successive click within the double_click_time. |
| result | boolean | Always false. |
| x | number | Window relative x position. |
| y | number | Window relative y position. |
| result | boolean | Always false. |
| x | number | Window relative x position. |
| y | number | Window relative y position. |
| result | boolean | Always false. |
| none |
| result | boolean | Always false. |
| msg | msg | The message received. |
| result | boolean | Always false. |
| none |
| result | boolean | Always false. |
| x | number | Window relative x position. |
| y | number | Window relative y position. |
| count | number | The number of times this same position was repeatedly clicked, with each successive click within the double_click_time. |
| result | boolean | Always false. |
| x | number | Window relative x position. |
| y | number | Window relative y position. |
| result | boolean | Always false. |
| x | number | Window relative x position. |
| y | number | Window relative y position. |
| result | boolean | Always false. |
| none |
| none |
| direction | number | -1 if scrolled up, 1 if down. |
| x | number | Window relative x position. |
| y | number | Window relative y position. |
| result | boolean | Always true. |
| msg | msg | The message that was sent. |
| success | boolean | True if the message was successfully sent, false if failed (an addressed message that did not receive a confirmation). |
| result | boolean | Always false. |
| id | number | Timer id (gained when the timer was started). |
| result | boolean | Always false. |
| x | number | Window relative x position. |
| y | number | Window relative y position. |
| result | boolean | True if scroll bar actioned, false if not. |
| direction | number | -1 if scrolled up, 1 if down. |
| page | boolean | True for page action, false for line action. |
| result | boolean | Always true. |