selection_change | When the current selection changes, by any means. |
list_click | When a list item is left clicked/touched/enter key pressed while active. |
list_double_click | When a list item is left clicked/touched/enter key pressed within the theme's double_click time of os.clock () on the same character. |
list__click_time | number | Records click time for double click. |
list__click_x | number | Records x coordinate for double click. |
list__click_y | number | Records y coordinate for double click. |
list__colors | table | Color table. |
list__colors.back | number | Blurred background color. |
list__colors.focus | number | Focused background color. |
list__colors.selected_back | number | Background color of selected item. |
list__colors.selected_text | number | Text color of selected item. |
list__colors.text | number | Text color. |
list__items | table | Table of items. |
list__sel_index | number | Holds the last selected item's index. |
string1 | string |
First string to test. |
string2 | string | Second string to test. |
result | boolean |
True if string1 is before string2. |
string1 | string | First string to test. |
string2 | string |
result | boolean | True if string1 is before string2. |
str | string | The string to display in the list. |
data | any | Any custom object/value associated with the list entry. |
index | number/nil | 1 based index to insert the item. If nil or out of range the item is added to the end of the list. |
none |
parent | window | Parent window, typically a frame. |
id | number | Numeric id value for list window. |
x | number | Parent relative x position. |
y | number | Parent relative y position. |
width | number | List window's width. |
height | number | List window's height. |
list | listWindow | The instantiated list window. |
none |
count | number | The count of items in the list control. |
gdi | GDI | GDI object to use for drawing. |
bounds | rect | Invalidated area of the window. |
none |
index | number | 1 based item index to ensure is visible. If nil the currently selected item is used. |
none |
str | string | The string to search for. |
from | number/nil | The 1 based index to search after. Zero or nil searches from the beginning. |
exact | boolean | If true the string must match exactly, otherwise a match if the start of the string is the same. |
index | number | The 1 based index of the item found, or zero if none. |
none |
index | number | The 1 based index of the currently selected list item, or zero if none. |
index | number/nil | The 1 based index of the item. If nil or omitted the currently selected item is used, if any. |
data | any | The item's data, or nil if index is out of range. |
index | number/nil | The 1 based index of the item. If nil or omitted the currently selected item is used, if any. |
str | string/nil | The item's string, or nil if index is out of range. |
focused | window | The window gaining focus, it may be nil. |
result | boolean | Always false. |
blurred | window | The window losing focus, it may be nil. |
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 | True if key was handled, false if not. |
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 true. |
x | number | Window relative x position. |
y | number | Window relative y position. |
result | boolean | Always true. |
index | number | 1 based index of the item to remove. |
result | boolean | True if successfully removed, or false otherwise (index is out of range). |
none |
none |
text | number | Text color. |
background | number | Blurred background color. |
focus | number | Focused background color. |
selected_text | number | Text color of selected item. |
selected_back | number | Background color of selected item. |
none |
index | number | 1 based index of the item to select. Zero or nil for no selection. |
make_visible | boolean | If true or nil scrolling is adjusted to bring the selected item into view if needed. |
changed | boolean | True if the current selection changed, false if not. |
data | any | The data value to set. |
index | number/nil | The 1 based index of the item to set. If nil the currently selected item is used, if any. |
result | boolean | True if the item was successfully set, false if not. |
str | string | The string value to set. |
index | number/nil | The 1 based index of the item to set. If nil the currently selected item is used, if any. |
result | boolean | True if the item was successfully set, false if not. |
descending | boolean | If true the sort is descending, otherwise ascending. |
none |