Skip to content

guitreeviewctrl: members

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

guitreeviewctrl.addlines(arg1: object, arg2: boolean) -> number

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

Adds one tree node for each line of an array.

Control.addlines("", "");

Specification: gui.md§3.

guitreeviewctrl.addnode(name: string) -> number

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

Adds a root-level node to a tree.

Tree.addNode("Items");

Specification: gui.md§3.

guitreeviewctrl.addnodebypath(path: string, value: string) -> number

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

Adds the nodes of a path separated by slashes, creating the missing ones, and sets the value of the last; an existing path gets the new value.

Tree.addNodeByPath("a/b/c", 5);

Specification: gui.md§3.

guitreeviewctrl.addvars(arg1: object, arg2: boolean) -> number

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

Adds one tree node for each variable of an object.

Control.addvars("", "");

Specification: gui.md§3.

guitreeviewctrl.boxwidth: number

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

Property of GuiTreeViewCtrl: size in pixels of the expand box drawn before each node (default 12).

new GuiTreeViewCtrl("MyControl") { boxwidth = 12; }

Specification: gui-legacy.md§21.

guitreeviewctrl.clearnodes() -> number

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

Removes every node of a tree.

Tree.clearNodes();

Specification: gui.md§3.

guitreeviewctrl.clearrows() -> number

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

Another name of clearNodes: removes every node of the tree.

Tree.clearRows();

Specification: gui.md§3.11.

guitreeviewctrl.clipcolumntext: boolean

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

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

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

Specification: gui.md§3.

guitreeviewctrl.columns: string

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

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

new GuiTreeViewCtrl("MyControl") { columns = 1; }

Specification: gui.md§3.

guitreeviewctrl.expandondoubleclick: boolean

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

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

new GuiTreeViewCtrl("MyControl") { expandondoubleclick = 1; }

Specification: gui.md§3.

guitreeviewctrl.firstlinevisible: boolean

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

Property of GuiTreeViewCtrl: draw boxes and lines for top-level nodes too (default true).

new GuiTreeViewCtrl("MyControl") { firstlinevisible = true; }

Specification: gui-legacy.md§21.

guitreeviewctrl.fitparentwidth: boolean

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

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

new GuiTreeViewCtrl("MyControl") { fitparentwidth = 1; }

Specification: gui.md§3.

guitreeviewctrl.getfullname(arg1: string) -> string

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

Returns the names from the top of the tree to a node joined by a separator.

Control.getfullname("");

Specification: gui.md§3.

guitreeviewctrl.getnode(arg1: string) -> guitreeviewnode

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

Returns the child node with a name.

Control.getnode("");

Specification: gui.md§3.

guitreeviewctrl.getnodeat(arg1: number, arg2: number) -> guitreeviewnode

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

Returns the tree node shown under a point in screen coordinates.

Control.getnodeat(0, 0);

Specification: gui.md§3.

guitreeviewctrl.getnodebypath(arg1: string, arg2: string) -> guitreeviewnode

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

Returns the node at the end of a path of names.

Control.getnodebypath("", "");

Specification: gui.md§3.

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

guitreeviewctrl.getselectednode() -> guitreeviewnode

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

Returns the selected tree node.

Control.getselectednode();

Specification: gui.md§3.

guitreeviewctrl.getselectedpath() -> string

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

The path of the selected node of a tree.

echo(Tree.getSelectedPath());

Specification: gui.md§3.

guitreeviewctrl.groupsortorder: string

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

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

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

Specification: gui.md§3.

guitreeviewctrl.iconheight: number

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

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

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

Specification: gui.md§3.

guitreeviewctrl.iconwidth: number

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

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

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

Specification: gui.md§3.

guitreeviewctrl.nodes: string

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

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

new GuiTreeViewCtrl("MyControl") { nodes = 1; }

Specification: gui.md§3.

guitreeviewctrl.onExpand(node: object, path: string, dotpath: string)

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

Raised when a node opens.

function MyControl.onExpand(node, path) {
echo("onExpand");
}

Specification: gui.md§3.5.

guitreeviewctrl.onFold(node: object, path: string, dotpath: string)

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

Raised when a node closes.

function MyControl.onFold(node, path) {
echo("onFold");
}

Specification: gui.md§3.5.

guitreeviewctrl.onSelect(node: object, path: string, dotpath: string)

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

Raised when a node is selected, with the node and its path written with / and with dots.

function MyControl.onSelect(node, path) {
echo("onSelect");
}

Specification: gui.md§3.5.

guitreeviewctrl.select() -> number

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

Selects the tree node.

Control.select();

Specification: gui.md§3.

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

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

guitreeviewctrl.sortmode: string

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

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

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

Specification: gui.md§3.

guitreeviewctrl.sortorder: string

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

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

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

Specification: gui.md§3.

guitreeviewctrl.statuswidth: number

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

Property of GuiTreeViewCtrl: indent in pixels per tree level, also the width of the expander cell (default 20).

new GuiTreeViewCtrl("MyControl") { statuswidth = 20; }

Specification: gui-legacy.md§21.

Engine version 0.1.0. Built 2026-11-18.