Skip to content

guitextlistctrl: members

56 implemented, 0 reserved. Entries are sorted by name.

guitextlistctrl.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.

guitextlistctrl.allowmultipleselections: boolean

Runs on: client only. Origin: compatibility. Since: M8. Playground: no.

Property of GuiTextListCtrl in the legacy GUI toolkit (gui.md§2, §3).

new GuiTextListCtrl("MyControl") { allowmultipleselections = 1; }

Specification: gui.md§3.

guitextlistctrl.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.

guitextlistctrl.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.

guitextlistctrl.clearselection() -> number

Runs on: client only. Origin: compatibility. Since: M8. Playground: no.

Deselects every row of the list.

Control.clearselection();

Specification: gui.md§3.

guitextlistctrl.clipcolumntext: boolean

Runs on: client only. Origin: compatibility. Since: M8. Playground: no.

Property of GuiTextListCtrl in the legacy GUI toolkit (gui.md§2, §3).

new GuiTextListCtrl("MyControl") { clipcolumntext = 1; }

Specification: gui.md§3.

guitextlistctrl.columns: string

Runs on: client only. Origin: compatibility. Since: M8. Playground: no.

Column layout: frame sizes for a frame set, tab stops in pixels for a text list.

new GuiTextListCtrl("MyControl") { columns = "0 100"; }

Specification: gui.md§3.

guitextlistctrl.enumerate: boolean

Runs on: client only. Origin: compatibility. Since: M8. Playground: no.

Property of GuiTextListCtrl in the legacy GUI toolkit (gui.md§2, §3).

new GuiTextListCtrl("MyControl") { enumerate = 1; }

Specification: gui.md§3.

guitextlistctrl.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.

guitextlistctrl.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.

guitextlistctrl.fitparentwidth: boolean

Runs on: client only. Origin: compatibility. Since: M8. Playground: no.

Whether the list stretches to the width of its parent.

new GuiTextListCtrl("MyControl") { fitparentwidth = true; }

Specification: gui.md§3.

guitextlistctrl.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.

guitextlistctrl.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.

guitextlistctrl.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.

guitextlistctrl.getselectedid() -> number

Runs on: client only. Origin: compatibility. Since: M8. Playground: no.

The id of the selected row of a text list, or -1.

echo(List.getSelectedId());

Specification: gui.md§3.

guitextlistctrl.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.

guitextlistctrl.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.

guitextlistctrl.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.

guitextlistctrl.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.

guitextlistctrl.groupsortorder: string

Runs on: client only. Origin: compatibility. Since: M8. Playground: no.

Property of GuiTextListCtrl in the legacy GUI toolkit (gui.md§2, §3).

new GuiTextListCtrl("MyControl") { groupsortorder = 1; }

Specification: gui.md§3.

guitextlistctrl.iconheight: number

Runs on: client only. Origin: compatibility. Since: M8. Playground: no.

Property of GuiTextListCtrl in the legacy GUI toolkit (gui.md§2, §3).

new GuiTextListCtrl("MyControl") { iconheight = 1; }

Specification: gui.md§3.

guitextlistctrl.iconwidth: number

Runs on: client only. Origin: compatibility. Since: M8. Playground: no.

Property of GuiTextListCtrl in the legacy GUI toolkit (gui.md§2, §3).

new GuiTextListCtrl("MyControl") { iconwidth = 1; }

Specification: gui.md§3.

guitextlistctrl.insertrow(index: number, id: number, text?: string) -> guitextlistentry

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.

guitextlistctrl.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.

guitextlistctrl.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.

guitextlistctrl.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.

guitextlistctrl.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.

guitextlistctrl.onDblClick(id: any, text: string, index: number)

Runs on: client only. Origin: compatibility. Since: M8. Playground: no.

Raised when a row is double-clicked.

function MyControl.onDblClick(id, text, index) {
echo("onDblClick");
}

Specification: gui.md§3.4.

guitextlistctrl.onDeleteKey(id: any, text: string, index: number)

Runs on: client only. Origin: compatibility. Since: M8. Playground: no.

Raised when Delete is pressed with a row selected.

function MyControl.onDeleteKey(id, text, index) {
echo("onDeleteKey");
}

Specification: gui.md§3.4.

guitextlistctrl.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.

guitextlistctrl.onIconResized(width: number, height: number)

Runs on: client only. Origin: compatibility. Since: M8. Playground: no.

Raised after setIconSize changed the size of the row icons.

function MyControl.onIconResized(w, h) {
echo("onIconResized");
}

Specification: gui.md§3.4.

guitextlistctrl.onMouseOverCell(id: number, text: string, index: number)

Runs on: client only. Origin: compatibility. Since: M14. Playground: no.

Raised when the pointer moves onto another cell of the list, with the row and column counted from 0.

function MyList.onMouseOverCell(row, column) {
echo(row);
}

Specification: gui.md§3.13.

guitextlistctrl.onOpenMenu(id: number, text: string, index: number)

Runs on: client only. Origin: compatibility. Since: M8. Playground: no.

Raised by a right click on the list, to open a context menu.

function MyControl.onOpenMenu(mods, x, y) {
echo("onOpenMenu");
}

Specification: gui.md§3.4.

guitextlistctrl.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.

guitextlistctrl.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.

guitextlistctrl.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.

guitextlistctrl.resizecell: boolean

Runs on: client only. Origin: compatibility. Since: M8. Playground: no.

Property of GuiTextListCtrl in the legacy GUI toolkit (gui.md§2, §3).

new GuiTextListCtrl("MyControl") { resizecell = 1; }

Specification: gui.md§3.

guitextlistctrl.rowcount() -> number

Runs on: client only. Origin: compatibility. Since: M8. Playground: no.

Returns the number of rows.

Control.rowcount();

Specification: gui.md§3.

guitextlistctrl.rows: string

Runs on: client only. Origin: compatibility. Since: M8. Playground: no. read-only.

Property of GuiTextListCtrl in the legacy GUI toolkit (gui.md§2, §3).

new GuiTextListCtrl("MyControl") { rows = 1; }

Specification: gui.md§3.

guitextlistctrl.selected: string

Runs on: client only. Origin: compatibility. Since: M8. Playground: no. read-only.

Property of GuiTextListCtrl in the legacy GUI toolkit (gui.md§2, §3).

new GuiTextListCtrl("MyControl") { selected = 1; }

Specification: gui.md§3.

guitextlistctrl.selectedid: number

Runs on: client only. Origin: compatibility. Since: M14. Playground: no.

The id of the selected row, or -1; writing selects the row with that id.

List.selectedid = 3;

Specification: gui.md§3.11.

guitextlistctrl.selectedrow: number

Runs on: client only. Origin: compatibility. Since: M14. Playground: no.

The index of the selected row, or -1; writing selects that row.

List.selectedrow = 0;

Specification: gui.md§3.11.

guitextlistctrl.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.

guitextlistctrl.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.

guitextlistctrl.setrowbyid(id: number, text: string) -> boolean

Runs on: client only. Origin: compatibility. Since: M8. Playground: no.

Replaces the text of the row with that id.

List.setRowById(3, "New");

Specification: gui.md§3.

guitextlistctrl.setrowcount(count: number) -> number

Runs on: client only. Origin: compatibility. Since: M8. Playground: no.

Adds empty rows or removes rows from the end until there are that many.

List.setRowCount(10);

Specification: gui.md§3.

guitextlistctrl.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.

guitextlistctrl.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.

guitextlistctrl.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.

guitextlistctrl.setselectedid(id: number) -> number

Runs on: client only. Origin: compatibility. Since: M8. Playground: no.

Selects the row with that id without raising onSelect.

List.setSelectedId(3);

Specification: gui.md§3.

guitextlistctrl.setselectedrow(index: number) -> number

Runs on: client only. Origin: compatibility. Since: M8. Playground: no.

Selects a row by position, counting from 0, without raising onSelect.

List.setSelectedRow(0);

Specification: gui.md§3.

guitextlistctrl.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.

guitextlistctrl.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.

guitextlistctrl.sortcolumn: number

Runs on: client only. Origin: compatibility. Since: M8. Playground: no.

Property of GuiTextListCtrl in the legacy GUI toolkit (gui.md§2, §3).

new GuiTextListCtrl("MyControl") { sortcolumn = 1; }

Specification: gui.md§3.

guitextlistctrl.sortmode: string

Runs on: client only. Origin: compatibility. Since: M8. Playground: no.

Property of GuiTextListCtrl in the legacy GUI toolkit (gui.md§2, §3).

new GuiTextListCtrl("MyControl") { sortmode = 1; }

Specification: gui.md§3.

guitextlistctrl.sortorder: string

Runs on: client only. Origin: compatibility. Since: M8. Playground: no.

Property of GuiTextListCtrl in the legacy GUI toolkit (gui.md§2, §3).

new GuiTextListCtrl("MyControl") { sortorder = 1; }

Specification: gui.md§3.

Engine version 0.1.0. Built 2026-11-18.