List object

The List widget displays a scrollable list of selectable items

Event Description
List:onChange() Event fired when List items have been modified
List:onClick() Event occurs when the user clicks on the List
List:onContext() Event fired when a right click occured on the List
List:onCreate() Event fired when List has just been created
List:onDoubleClick() Event fired when the user double-clicks on an item in the List
List:onDrop() Event fired when the List received a drag and drop content
List:onDropItem() Event fired when an item is dropped on the List
List:onHide() Event fired when the List is hidden
List:onHover() Event fired when the user moves the mouse pointer over the List
List:onLeave() Event fired when the mouse cursor leaves the List
List:onMouseDown() Event fired when the user presses a mouse button over the List
List:onMouseUp() Event fired when the user releases a mouse button over the List
List:onSelect() Event fired when the user selects an item in the List
List:onShow() Event fired when the List is shown
Property Description Access Type
List.align Align the List relative to its parent readwrite boolean
List.allowdrop Controls whether the List is a drag and drop target readwrite boolean
List.border Controls whether the List border is visible readwrite boolean
List.count Get the count of items in the List readonly number
List.cursor Get/set the image of the mouse cursor as it hovers over the List readwrite string
List.enabled Controls whether the List responds to mouse and other events readwrite boolean
List.font Get/set the List font readwrite string
List.fontsize Get/set the List font size readwrite number
List.fontstyle Get/set the List font style readwrite table
List.height Get/set the List's height readwrite number
List.items Get/set the List items readwrite table
List.parent Get the List's parent widget readonly
List.selected Get/set the selected List item readwrite
List.style Get/set the List style readwrite string
List.visible Controls whether the List appears on screen readwrite boolean
List.width Get/set the List's width readwrite number
List.x Get/set the List's horizontal position readwrite number
List.y Get/set the List's vertical position readwrite number
Methods Description Return value
List:add() Add an item to the List
List:center() Centers the List on the parent widget -
List:clear() Remove all items from the List -
List:constructor() List object constructor
List:hide() Hides the List -
List:remove() Remove an item from the List -
List:show() Shows the List -
List:sort() Sort the List -
List:toback() Puts the widget to the back -
List:tofront() Brings the widget in front -