MetzNet
/
dfhack
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update lua api docs

develop
myk002 2022-11-07 16:19:03 -08:00
parent 83f560a6f4
commit 93bc4c00eb
No known key found for this signature in database
GPG Key ID: 8A39CA0FA0C16E78
1 changed files with 7 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
docs/Lua API.rst
Unescape Escape View File

@ -4322,8 +4322,8 @@ It has the following attributes:
with an empty list. with an empty list.
:on_submit: Enter key or mouse click callback; if specified, the list reacts to the :on_submit: Enter key or mouse click callback; if specified, the list reacts to the
key/click and calls the callback as ``on_submit(index,choice)``. key/click and calls the callback as ``on_submit(index,choice)``.
:on_submit2: Shift-Enter key callback; if specified, the list reacts to the key :on_submit2: Shift-Enter key or shift-mouse click callback; if specified, the list
and calls it as ``on_submit2(index,choice)``. reacts to the key/click and calls it as ``on_submit2(index,choice)``.
:row_height: Height of every row in text lines. :row_height: Height of every row in text lines.
:icon_width: If not *nil*, the specified number of character columns :icon_width: If not *nil*, the specified number of character columns
are reserved to the left of the list item for the icons. are reserved to the left of the list item for the icons.
@ -4360,6 +4360,11 @@ The list supports the following methods:
Returns the selected *index, choice*, or nothing if the list is empty. Returns the selected *index, choice*, or nothing if the list is empty.
* ``list:getIdxUnderMouse()``
Returns the index of the list item under the mouse cursor, or nothing if the
list is empty or the mouse is not over a list item.
* ``list:getContentWidth()`` * ``list:getContentWidth()``
Returns the minimal width to draw all choices without clipping. Returns the minimal width to draw all choices without clipping.