guitabctrl: members
44 implemented, 0 reserved. Entries are sorted by name.
Implemented
Section titled “Implemented”guitabctrl.add(text: string, id: number) -> number
Runs on: client only. Origin: compatibility. Since: M8. Playground: no.
Adds an entry to a drop-down, tab bar, or context menu.
Pop.add("Red", 1);Specification: gui.md§3.
addrow
Section titled “addrow”guitabctrl.addrow(id: number, text: string) -> number
Runs on: client only. Origin: compatibility. Since: M8. Playground: no.
Adds a row to a text list; columns in the text are separated by tabs.
List.addRow(1, "Name\tValue");Specification: gui.md§3.
guitabctrl.clear() -> number
Runs on: client only. Origin: compatibility. Since: M8. Playground: no.
Empties a text edit, drop-down, tab bar, context menu, or text list.
List.clear();Specification: gui.md§3.
clearrows
Section titled “clearrows”guitabctrl.clearrows() -> number
Runs on: client only. Origin: compatibility. Since: M8. Playground: no.
Removes every row of a text list.
List.clearRows();Specification: gui.md§3.
clearselection
Section titled “clearselection”guitabctrl.clearselection() -> number
Runs on: client only. Origin: compatibility. Since: M8. Playground: no.
Deselects every row of the list.
Control.clearselection();Specification: gui.md§3.
findtext
Section titled “findtext”guitabctrl.findtext(arg1: string) -> number
Runs on: client only. Origin: compatibility. Since: M8. Playground: no.
Returns the index of the first row with this text, or the position of the first match in multi-line text.
Control.findtext("");Specification: gui.md§3.
findtextid
Section titled “findtextid”guitabctrl.findtextid(arg1: string) -> number
Runs on: client only. Origin: compatibility. Since: M8. Playground: no.
Returns the id of the first row with this text, or -1.
Control.findtextid("");Specification: gui.md§3.
getrowatpoint
Section titled “getrowatpoint”guitabctrl.getrowatpoint(arg1: number, arg2: number) -> number
Runs on: client only. Origin: compatibility. Since: M8. Playground: no.
Returns the index of the row under a point in screen coordinates, or -1.
Control.getrowatpoint(0, 0);Specification: gui.md§3.
getrowidatpoint
Section titled “getrowidatpoint”guitabctrl.getrowidatpoint(arg1: number, arg2: number) -> number
Runs on: client only. Origin: compatibility. Since: M8. Playground: no.
Returns the id of the row under a point in screen coordinates, or -1.
Control.getrowidatpoint(0, 0);Specification: gui.md§3.
getrownumbyid
Section titled “getrownumbyid”guitabctrl.getrownumbyid(arg1: number) -> number
Runs on: client only. Origin: compatibility. Since: M8. Playground: no.
Returns the index of the row with an id, or -1.
Control.getrownumbyid(0);Specification: gui.md§3.
getselected
Section titled “getselected”guitabctrl.getselected() -> any
Runs on: client only. Origin: compatibility. Since: M8. Playground: no.
The id of the selected entry of a drop-down, tab bar, or menu (-1 for none); the value of the selected node of a tree.
echo(Pop.getSelected());Specification: gui.md§3.
getselectedid
Section titled “getselectedid”guitabctrl.getselectedid() -> number
Runs on: client only. Origin: compatibility. Since: M14. Playground: no.
The id of the selected tab, or -1.
echo(Tabs.getSelectedId());Specification: gui.md§3.11.
getselectedids
Section titled “getselectedids”guitabctrl.getselectedids() -> array
Runs on: client only. Origin: compatibility. Since: M8. Playground: no.
Returns the ids of the selected rows as an array.
Control.getselectedids();Specification: gui.md§3.
getselectedrow
Section titled “getselectedrow”guitabctrl.getselectedrow() -> number
Runs on: client only. Origin: compatibility. Since: M8. Playground: no.
Returns the index of the selected row, or -1.
Control.getselectedrow();Specification: gui.md§3.
getselectedrows
Section titled “getselectedrows”guitabctrl.getselectedrows() -> array
Runs on: client only. Origin: compatibility. Since: M8. Playground: no.
The ids of the selected entries, an array of zero or one id.
echo(Pop.getSelectedRows().size());Specification: gui.md§3.
getselectedtext
Section titled “getselectedtext”guitabctrl.getselectedtext() -> string
Runs on: client only. Origin: compatibility. Since: M8. Playground: no.
The text of the selected entry or row.
echo(Pop.getSelectedText());Specification: gui.md§3.
iconheight
Section titled “iconheight”guitabctrl.iconheight: number
Runs on: client only. Origin: compatibility. Since: M8. Playground: no.
Property of GuiTabCtrl in the legacy GUI toolkit (gui.md§2, §3).
new GuiTabCtrl("MyControl") { iconheight = 1; }Specification: gui.md§3.
iconwidth
Section titled “iconwidth”guitabctrl.iconwidth: number
Runs on: client only. Origin: compatibility. Since: M8. Playground: no.
Property of GuiTabCtrl in the legacy GUI toolkit (gui.md§2, §3).
new GuiTabCtrl("MyControl") { iconwidth = 1; }Specification: gui.md§3.
insertrow
Section titled “insertrow”guitabctrl.insertrow(index: number, id: number, text?: string) -> guitabctrlentry
Runs on: client only. Origin: compatibility. Since: M8. Playground: no.
Inserts a row at an index and returns it.
Control.insertrow(0, 5, "Row");Specification: gui.md§3.
isidselected
Section titled “isidselected”guitabctrl.isidselected(arg1: number) -> boolean
Runs on: client only. Origin: compatibility. Since: M8. Playground: no.
Returns true when the row with this id is selected.
Control.isidselected(0);Specification: gui.md§3.
isrowselected
Section titled “isrowselected”guitabctrl.isrowselected(arg1: number) -> boolean
Runs on: client only. Origin: compatibility. Since: M8. Playground: no.
Returns true when the row at this index is selected.
Control.isrowselected(0);Specification: gui.md§3.
leveling
Section titled “leveling”guitabctrl.leveling: number
Runs on: client only. Origin: compatibility. Since: M8. Playground: no.
Property of GuiTabCtrl in the legacy GUI toolkit (gui.md§2, §3).
new GuiTabCtrl("MyControl") { leveling = 1; }Specification: gui.md§3.
makevisible
Section titled “makevisible”guitabctrl.makevisible(arg1: number) -> number
Runs on: client only. Origin: compatibility. Since: M8. Playground: no.
Scrolls so the row at this index can be seen.
Control.makevisible(0);Specification: gui.md§3.
makevisiblebyid
Section titled “makevisiblebyid”guitabctrl.makevisiblebyid(arg1: number) -> number
Runs on: client only. Origin: compatibility. Since: M8. Playground: no.
Scrolls so the row with this id can be seen.
Control.makevisiblebyid(0);Specification: gui.md§3.
maxvisibletabs
Section titled “maxvisibletabs”guitabctrl.maxvisibletabs: number
Runs on: client only. Origin: compatibility. Since: M8. Playground: no.
Property of GuiTabCtrl in the legacy GUI toolkit (gui.md§2, §3).
new GuiTabCtrl("MyControl") { maxvisibletabs = 1; }Specification: gui.md§3.
onDeselect
Section titled “onDeselect”guitabctrl.onDeselect(id: any, text: string, index: number)
Runs on: client only. Origin: compatibility. Since: M8. Playground: no.
Raised for the row that was chosen before another one is.
function MyControl.onDeselect(id, text, index) { echo("onDeselect");}Specification: gui.md§3.4.
onSelect
Section titled “onSelect”guitabctrl.onSelect(id: any, text: string, index: number)
Runs on: client only. Origin: compatibility. Since: M8. Playground: no.
Raised when a row is chosen, with its id, text and index.
function MyControl.onSelect(id, text, index) { echo("onSelect");}Specification: gui.md§3.4.
overlapwidth
Section titled “overlapwidth”guitabctrl.overlapwidth: number
Runs on: client only. Origin: compatibility. Since: M8. Playground: no.
Property of GuiTabCtrl: how much wider the selected tab is on each side, and the space before the first tab (default 3).
new GuiTabCtrl("MyControl") { overlapwidth = 3; }Specification: gui-legacy.md§18.
removerow
Section titled “removerow”guitabctrl.removerow(index: number) -> boolean
Runs on: client only. Origin: compatibility. Since: M8. Playground: no.
Removes the row at that position; the rows after it move up.
List.removeRow(0);Specification: gui.md§3.
removerowbyid
Section titled “removerowbyid”guitabctrl.removerowbyid(arg1: number) -> number
Runs on: client only. Origin: compatibility. Since: M8. Playground: no.
Removes the row with this id.
Control.removerowbyid(0);Specification: gui.md§3.
rowcount
Section titled “rowcount”guitabctrl.rowcount() -> number
Runs on: client only. Origin: compatibility. Since: M8. Playground: no.
Returns the number of rows.
Control.rowcount();Specification: gui.md§3.
guitabctrl.rows: string
Runs on: client only. Origin: compatibility. Since: M8. Playground: no. read-only.
Property of GuiTabCtrl in the legacy GUI toolkit (gui.md§2, §3).
new GuiTabCtrl("MyControl") { rows = 1; }Specification: gui.md§3.
selected
Section titled “selected”guitabctrl.selected: string
Runs on: client only. Origin: compatibility. Since: M8. Playground: no. read-only.
Property of GuiTabCtrl in the legacy GUI toolkit (gui.md§2, §3).
new GuiTabCtrl("MyControl") { selected = 1; }Specification: gui.md§3.
seticonsize
Section titled “seticonsize”guitabctrl.seticonsize(arg1: number, arg2: number) -> number
Runs on: client only. Origin: compatibility. Since: M8. Playground: no.
Sets the size of the icons (at most 64 by 64) and raises onIconResized.
Control.seticonsize(0, 0);Specification: gui.md§3.
setrowactivebyid
Section titled “setrowactivebyid”guitabctrl.setrowactivebyid(arg1: number, arg2: boolean) -> number
Runs on: client only. Origin: compatibility. Since: M8. Playground: no.
Turns a row on or off; an inactive row cannot be chosen.
Control.setrowactivebyid(0, "");Specification: gui.md§3.
setselected
Section titled “setselected”guitabctrl.setselected(id: number) -> number
Runs on: client only. Origin: compatibility. Since: M8. Playground: no.
Selects the entry with that id without raising onSelect.
Pop.setSelected(1);Specification: gui.md§3.
setselectedbyid
Section titled “setselectedbyid”guitabctrl.setselectedbyid(arg1: number) -> number
Runs on: client only. Origin: compatibility. Since: M8. Playground: no.
Selects the row with this id.
Control.setselectedbyid(0);Specification: gui.md§3.
setselectedbyids
Section titled “setselectedbyids”guitabctrl.setselectedbyids(arg1: string) -> number
Runs on: client only. Origin: compatibility. Since: M8. Playground: no.
Selects the rows with these ids (several with allowmultipleselections).
Control.setselectedbyids("");Specification: gui.md§3.
setselectedbytext
Section titled “setselectedbytext”guitabctrl.setselectedbytext(arg1: string) -> number
Runs on: client only. Origin: compatibility. Since: M8. Playground: no.
Selects the first row with this text.
Control.setselectedbytext("");Specification: gui.md§3.
setselectedrow
Section titled “setselectedrow”guitabctrl.setselectedrow(index: number) -> number
Runs on: client only. Origin: compatibility. Since: M14. Playground: no.
Selects the tab at the index.
Tabs.setSelectedRow(1);Specification: gui.md§3.11.
setselectedrows
Section titled “setselectedrows”guitabctrl.setselectedrows(arg1: string) -> number
Runs on: client only. Origin: compatibility. Since: M8. Playground: no.
Selects the rows at these indices (several with allowmultipleselections).
Control.setselectedrows("");Specification: gui.md§3.
guitabctrl.sort() -> number
Runs on: client only. Origin: compatibility. Since: M8. Playground: no.
Sorts the rows or nodes by the sort properties.
Control.sort();Specification: gui.md§3.
tabwidth
Section titled “tabwidth”guitabctrl.tabwidth: number
Runs on: client only. Origin: compatibility. Since: M8. Playground: no.
Property of GuiTabCtrl in the legacy GUI toolkit (gui.md§2, §3).
new GuiTabCtrl("MyControl") { tabwidth = 1; }Specification: gui.md§3.
guitabctrl.text: string
Runs on: client only. Origin: compatibility. Since: M8. Playground: no.
The text the control shows.
new GuiTabCtrl("MyControl") { text = "Hello"; }Specification: gui.md§3.
Engine version 0.1.0. Built 2026-11-18.