guistartmenuctrl: members
62 implemented, 0 reserved. Entries are sorted by name.
Implemented
Section titled “Implemented”guistartmenuctrl.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”guistartmenuctrl.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.
allowmultipleselections
Section titled “allowmultipleselections”guistartmenuctrl.allowmultipleselections: boolean
Runs on: client only. Origin: compatibility. Since: M8. Playground: no.
Property of GuiContextMenuCtrl in the legacy GUI toolkit (gui.md§2, §3).
new GuiContextMenuCtrl("MyControl") { allowmultipleselections = 1; }Specification: gui.md§3.
guistartmenuctrl.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”guistartmenuctrl.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”guistartmenuctrl.clearselection() -> number
Runs on: client only. Origin: compatibility. Since: M8. Playground: no.
Deselects every row of the list.
Control.clearselection();Specification: gui.md§3.
clipcolumntext
Section titled “clipcolumntext”guistartmenuctrl.clipcolumntext: boolean
Runs on: client only. Origin: compatibility. Since: M8. Playground: no.
Property of GuiContextMenuCtrl in the legacy GUI toolkit (gui.md§2, §3).
new GuiContextMenuCtrl("MyControl") { clipcolumntext = 1; }Specification: gui.md§3.
guistartmenuctrl.close() -> number
Runs on: client only. Origin: compatibility. Since: M8. Playground: no.
Closes the open pop-up or context menu.
Control.close();Specification: gui.md§3.
columns
Section titled “columns”guistartmenuctrl.columns: string
Runs on: client only. Origin: compatibility. Since: M8. Playground: no.
Property of GuiContextMenuCtrl in the legacy GUI toolkit (gui.md§2, §3).
new GuiContextMenuCtrl("MyControl") { columns = 1; }Specification: gui.md§3.
enumerate
Section titled “enumerate”guistartmenuctrl.enumerate: boolean
Runs on: client only. Origin: compatibility. Since: M8. Playground: no.
Property of GuiContextMenuCtrl in the legacy GUI toolkit (gui.md§2, §3).
new GuiContextMenuCtrl("MyControl") { enumerate = 1; }Specification: gui.md§3.
findtext
Section titled “findtext”guistartmenuctrl.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”guistartmenuctrl.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.
fitparentwidth
Section titled “fitparentwidth”guistartmenuctrl.fitparentwidth: boolean
Runs on: client only. Origin: compatibility. Since: M8. Playground: no.
Property of GuiContextMenuCtrl in the legacy GUI toolkit (gui.md§2, §3).
new GuiContextMenuCtrl("MyControl") { fitparentwidth = 1; }Specification: gui.md§3.
getrowatpoint
Section titled “getrowatpoint”guistartmenuctrl.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”guistartmenuctrl.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”guistartmenuctrl.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”guistartmenuctrl.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.
getselectedids
Section titled “getselectedids”guistartmenuctrl.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”guistartmenuctrl.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”guistartmenuctrl.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”guistartmenuctrl.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.
gettext
Section titled “gettext”guistartmenuctrl.gettext() -> string
Runs on: client only. Origin: compatibility. Since: M8. Playground: no.
The caption.
echo(Start.gettext());Specification: gui-legacy.md§27.1.
groupsortorder
Section titled “groupsortorder”guistartmenuctrl.groupsortorder: string
Runs on: client only. Origin: compatibility. Since: M8. Playground: no.
Property of GuiContextMenuCtrl in the legacy GUI toolkit (gui.md§2, §3).
new GuiContextMenuCtrl("MyControl") { groupsortorder = 1; }Specification: gui.md§3.
iconheight
Section titled “iconheight”guistartmenuctrl.iconheight: number
Runs on: client only. Origin: compatibility. Since: M8. Playground: no.
Property of GuiContextMenuCtrl in the legacy GUI toolkit (gui.md§2, §3).
new GuiContextMenuCtrl("MyControl") { iconheight = 1; }Specification: gui.md§3.
iconwidth
Section titled “iconwidth”guistartmenuctrl.iconwidth: number
Runs on: client only. Origin: compatibility. Since: M8. Playground: no.
Property of GuiContextMenuCtrl in the legacy GUI toolkit (gui.md§2, §3).
new GuiContextMenuCtrl("MyControl") { iconwidth = 1; }Specification: gui.md§3.
insertrow
Section titled “insertrow”guistartmenuctrl.insertrow(arg1: number, arg2: number) -> guitextlistentry
Runs on: client only. Origin: compatibility. Since: M8. Playground: no.
Inserts a row at an index and returns it.
Control.insertrow(0, 0);Specification: gui.md§3.
isidselected
Section titled “isidselected”guistartmenuctrl.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.
isopen
Section titled “isopen”guistartmenuctrl.isopen() -> boolean
Runs on: client only. Origin: compatibility. Since: M8. Playground: no.
Returns true while the pop-up or context menu is open.
Control.isopen();Specification: gui.md§3.
isrowselected
Section titled “isrowselected”guistartmenuctrl.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.
makevisible
Section titled “makevisible”guistartmenuctrl.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”guistartmenuctrl.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.
maxchars
Section titled “maxchars”guistartmenuctrl.maxchars: number
Runs on: client only. Origin: compatibility. Since: M14. Playground: no.
Longest text the player can type; 255 by default and 0 for no limit.
new GuiStartMenuCtrl("MyControl") { maxchars = 20; }Specification: gui.md§3.11.
maxpopupheight
Section titled “maxpopupheight”guistartmenuctrl.maxpopupheight: number
Runs on: client only. Origin: compatibility. Since: M14. Playground: no.
Height at which the open list stops growing and scrolls; 0 for no limit.
Menu.maxpopupheight = 200;Specification: gui.md§3.11.
onCancel
Section titled “onCancel”guistartmenuctrl.onCancel()
Runs on: client only. Origin: compatibility. Since: M8. Playground: no.
Raised when the list closes without a choice.
function MyControl.onCancel() { echo("onCancel");}Specification: gui.md§3.4.
onDeselect
Section titled “onDeselect”guistartmenuctrl.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”guistartmenuctrl.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.
onTextChanged
Section titled “onTextChanged”guistartmenuctrl.onTextChanged(text: string)
Runs on: client only. Origin: compatibility. Since: M8. Playground: no.
Raised when the caption changes.
function Start.onTextChanged(text) { echo(text); }Specification: gui-legacy.md§27.1.
guistartmenuctrl.open(arg1: number, arg2: number) -> number
Runs on: client only. Origin: compatibility. Since: M8. Playground: no.
Opens the pop-up or context menu at a point in screen coordinates.
Control.open(0, 0);Specification: gui.md§3.
openatmouse
Section titled “openatmouse”guistartmenuctrl.openatmouse() -> number
Runs on: client only. Origin: compatibility. Since: M8. Playground: no.
Opens the pop-up or context menu at the mouse.
Control.openatmouse();Specification: gui.md§3.
removerow
Section titled “removerow”guistartmenuctrl.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”guistartmenuctrl.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.
resizecell
Section titled “resizecell”guistartmenuctrl.resizecell: boolean
Runs on: client only. Origin: compatibility. Since: M8. Playground: no.
Property of GuiContextMenuCtrl in the legacy GUI toolkit (gui.md§2, §3).
new GuiContextMenuCtrl("MyControl") { resizecell = 1; }Specification: gui.md§3.
rowcount
Section titled “rowcount”guistartmenuctrl.rowcount() -> number
Runs on: client only. Origin: compatibility. Since: M8. Playground: no.
Returns the number of rows.
Control.rowcount();Specification: gui.md§3.
guistartmenuctrl.rows: string
Runs on: client only. Origin: compatibility. Since: M8. Playground: no. read-only.
Property of GuiContextMenuCtrl in the legacy GUI toolkit (gui.md§2, §3).
new GuiContextMenuCtrl("MyControl") { rows = 1; }Specification: gui.md§3.
scrollprofile
Section titled “scrollprofile”guistartmenuctrl.scrollprofile: string
Runs on: client only. Origin: compatibility. Since: M8. Playground: no.
Property of GuiContextMenuCtrl in the legacy GUI toolkit (gui.md§2, §3).
new GuiContextMenuCtrl("MyControl") { scrollprofile = 1; }Specification: gui.md§3.
selected
Section titled “selected”guistartmenuctrl.selected: string
Runs on: client only. Origin: compatibility. Since: M8. Playground: no. read-only.
Property of GuiContextMenuCtrl in the legacy GUI toolkit (gui.md§2, §3).
new GuiContextMenuCtrl("MyControl") { selected = 1; }Specification: gui.md§3.
seticonsize
Section titled “seticonsize”guistartmenuctrl.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”guistartmenuctrl.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”guistartmenuctrl.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”guistartmenuctrl.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”guistartmenuctrl.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”guistartmenuctrl.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”guistartmenuctrl.setselectedrow(index: number) -> number
Runs on: client only. Origin: compatibility. Since: M14. Playground: no.
Selects a row by position, counting from 0, without raising onSelect.
Menu.setSelectedRow(2);Specification: gui.md§3.
setselectedrows
Section titled “setselectedrows”guistartmenuctrl.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.
settext
Section titled “settext”guistartmenuctrl.settext(text: string)
Runs on: client only. Origin: compatibility. Since: M8. Playground: no.
Sets the caption, like the text property.
Start.settext("Games");Specification: gui-legacy.md§27.1.
guistartmenuctrl.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.
sortcolumn
Section titled “sortcolumn”guistartmenuctrl.sortcolumn: number
Runs on: client only. Origin: compatibility. Since: M8. Playground: no.
Property of GuiContextMenuCtrl in the legacy GUI toolkit (gui.md§2, §3).
new GuiContextMenuCtrl("MyControl") { sortcolumn = 1; }Specification: gui.md§3.
sortmode
Section titled “sortmode”guistartmenuctrl.sortmode: string
Runs on: client only. Origin: compatibility. Since: M8. Playground: no.
Property of GuiContextMenuCtrl in the legacy GUI toolkit (gui.md§2, §3).
new GuiContextMenuCtrl("MyControl") { sortmode = 1; }Specification: gui.md§3.
sortorder
Section titled “sortorder”guistartmenuctrl.sortorder: string
Runs on: client only. Origin: compatibility. Since: M8. Playground: no.
Property of GuiContextMenuCtrl in the legacy GUI toolkit (gui.md§2, §3).
new GuiContextMenuCtrl("MyControl") { sortorder = 1; }Specification: gui.md§3.
stylesection
Section titled “stylesection”guistartmenuctrl.stylesection: string
Runs on: client only. Origin: compatibility. Since: M14. Playground: no.
Name of the part of the GUI style the text color comes from; kept without GUI styles.
new GuiStartMenuCtrl("MyControl") { stylesection = "Clock"; }Specification: gui.md§3.11.
guistartmenuctrl.text: string
Runs on: client only. Origin: compatibility. Since: M8. Playground: no.
The caption; a change raises onTextChanged.
Start.text = "Games";Specification: gui-legacy.md§27.1.
textprofile
Section titled “textprofile”guistartmenuctrl.textprofile: string
Runs on: client only. Origin: compatibility. Since: M8. Playground: no.
Property of GuiContextMenuCtrl in the legacy GUI toolkit (gui.md§2, §3).
new GuiContextMenuCtrl("MyControl") { textprofile = 1; }Specification: gui.md§3.
Engine version 0.1.0. Built 2026-11-18.