button_react_util¶
Quelle: base/tealdef/gui/main/button_react_util.d.tl
Hinweise
Kurzfunktionen, die Knoten vom Typ builtin.Button und builtin.ToggleButton mit einem Text, einem
Icon oder beidem als Inhalt bauen. Du lädst das Modul mit
ug_require "/gui/main/button_react_util.tl".
ButtonReactUtil¶
record global base/tealdef/gui/main/button_react_util.d.tl:3
global record ButtonReactUtil
Laden: local button_react_util = ug_require "::/gui/main/button_react_util.tl" as ButtonReactUtil
Hinweise
Funktionen, die fertige Button-Knoten zurückgeben (Text, Icon, Icon mit Text, Icon-Toggle).
Details
Jede Funktion gibt eine TreeNodeId zurück, die du wie jeden anderen Knoten in ein Layout setzt.
Wenn nichts anderes angegeben ist, ist der Button aktiv, sein Inhalt bleibt im Fokuswechsel
(disableFocusableRecursive = false) und Text hat die Style-Klasse font-scale-body.
Funktionen
makeTextButton(className : string, text : string, onClick : function(), tooltip : string, disabled? : boolean, textClass? : string, disableFocusableRecursive? : boolean) : TreeNodeId base/tealdef/gui/main/button_react_util.d.tl:4
Aufruf: button_react_util.makeTextButton(…)
Hinweise
Baut einen builtin.Button, dessen Inhalt ein einzelner builtin.TextView ist.
| Parameter | Typ | Beschreibung |
|---|---|---|
className |
string |
Style-Klasse des Buttons. |
text |
string |
Text des Buttons. |
onClick |
function() |
Wird aufgerufen, wenn der Button angeklickt wird. |
tooltip |
string |
Tooltip des Buttons. |
disabled? |
boolean |
Bei true ist der Button deaktiviert. Dieser Parameter ist also umgekehrt zum Parameter enabled der Icon-Buttons. |
textClass? |
string |
Style-Klasse der Textansicht (Standard font-scale-body). |
disableFocusableRecursive? |
boolean |
Geht an meta.disableFocusableRecursive des Buttons (Standard false). |
Rückgabe TreeNodeId: Der Button-Knoten.
makeIconToggleButton(className : string, path : string, onClick : function(v : boolean), tooltip : string, enabled? : boolean, tag? : string, disableFocusableRecursive? : boolean, value? : boolean) : TreeNodeId base/tealdef/gui/main/button_react_util.d.tl:13
Aufruf: button_react_util.makeIconToggleButton(…)
Hinweise
Baut einen builtin.ToggleButton mit einem Icon als Inhalt und einem Callback mit Wahrheitswert.
| Parameter | Typ | Beschreibung |
|---|---|---|
className |
string |
Style-Klasse des Toggle-Buttons. |
path |
string |
Bildpfad des Icons. |
onClick |
function(v : boolean) |
Wird mit dem neuen Zustand aufgerufen (true = gedrückt), wenn der Spieler den Button umschaltet. |
tooltip |
string |
Tooltip des Buttons. |
enabled? |
boolean |
Bei false ist der Button deaktiviert (Standard true). |
tag? |
string |
Wert für meta.tag des Buttons. |
disableFocusableRecursive? |
boolean |
Geht an meta.disableFocusableRecursive des Buttons (Standard false). |
value? |
boolean |
Aktueller Zustand des Toggle-Buttons (nil zählt als false). |
Rückgabe TreeNodeId: Der Knoten des Toggle-Buttons.
Details
Der zugrunde liegende Toggle-Button arbeitet mit Ganzzahlen (0/1). Dieser Helfer rechnet um:
value wird bei true als 1 übergeben, sonst als 0, und onClick bekommt true, wenn der
neue Wert des Buttons 1 ist.
makeIconButton(className : string, path : string, onClick : function(), tooltip : string, enabled? : boolean, tag? : string, disableFocusableRecursive? : boolean) : TreeNodeId base/tealdef/gui/main/button_react_util.d.tl:23
Aufruf: button_react_util.makeIconButton(…)
Hinweise
Baut einen builtin.Button, dessen Inhalt ein mit AutoFit skalierter builtin.ImageView ist.
| Parameter | Typ | Beschreibung |
|---|---|---|
className |
string |
Style-Klasse des Buttons. |
path |
string |
Bildpfad des Icons, z. B. "::/gui/main/icons/...". |
onClick |
function() |
Wird aufgerufen, wenn der Button angeklickt wird. |
tooltip |
string |
Tooltip des Buttons. |
enabled? |
boolean |
Bei false ist der Button deaktiviert (Standard true). |
tag? |
string |
Wert für meta.tag des Buttons. |
disableFocusableRecursive? |
boolean |
Geht an meta.disableFocusableRecursive des Buttons (Standard false). |
Rückgabe TreeNodeId: Der Button-Knoten.
Im Basisspiel verwendet: 13-mal in 4 Dateien
base/content/gui/gui/entity_window/entity_window_util.tl:1729
base/content/gui/gui/line_vehicle_mgmt/manager_window.tl:4984
base/content/gui/gui/line_vehicle_mgmt/vehicle_store_window.tl:3282
base/content/gui/gui/menu/main_page.tl:522
makeIconTextButton(className : string, path : string, text : string, onClick : function(), tooltip : string, enabled? : boolean, tag? : string, textClass? : string, disableFocusableRecursive? : boolean) : TreeNodeId base/tealdef/gui/main/button_react_util.d.tl:32
Aufruf: button_react_util.makeIconTextButton(…)
Hinweise
Baut einen builtin.Button mit einem Icon und einem Text dahinter in einer horizontalen Box.
| Parameter | Typ | Beschreibung |
|---|---|---|
className |
string |
Style-Klasse des Buttons. |
path |
string |
Bildpfad des Icons. |
text |
string |
Text rechts neben dem Icon. |
onClick |
function() |
Wird aufgerufen, wenn der Button angeklickt wird. |
tooltip |
string |
Tooltip des Buttons. |
enabled? |
boolean |
Bei false ist der Button deaktiviert (Standard true). |
tag? |
string |
Wert für meta.tag des Buttons. |
textClass? |
string |
Style-Klasse der Textansicht (Standard font-scale-body). |
disableFocusableRecursive? |
boolean |
Geht an meta.disableFocusableRecursive des Buttons (Standard false). |
Rückgabe TreeNodeId: Der Button-Knoten.