TextBox¶

A multi-line text display widget with optional word wrap.

When word wrap is enabled, text breaks at word boundaries (spaces) to fit within the widget's width. When disabled, lines are hard-truncated at the width. Lines beyond the widget's height are not displayed.

actor tag TextBox is
  Widget tag

Implements¶

Widget tag

Constructors¶

create¶

[Source]

new tag create(
  p: WidgetParent tag,
  text: String val = "",
  fg: (Default val | Black val | Red val | 
    Green val | Yellow val | Blue val | 
    Magenta val | Cyan val | White val | 
    BrightBlack val | BrightRed val | BrightGreen val | 
    BrightYellow val | BrightBlue val | BrightMagenta val | 
    BrightCyan val | BrightWhite val | Rainbow val) = reference,
  bg: (Default val | Black val | Red val | 
    Green val | Yellow val | Blue val | 
    Magenta val | Cyan val | White val | 
    BrightBlack val | BrightRed val | BrightGreen val | 
    BrightYellow val | BrightBlue val | BrightMagenta val | 
    BrightCyan val | BrightWhite val | Rainbow val) = reference,
  wrap: Bool val = true)
: TextBox tag^

Parameters¶

p: WidgetParent tag
text: String val = ""
fg: (Default val | Black val | Red val | Green val | Yellow val | Blue val | Magenta val | Cyan val | White val | BrightBlack val | BrightRed val | BrightGreen val | BrightYellow val | BrightBlue val | BrightMagenta val | BrightCyan val | BrightWhite val | Rainbow val) = reference
bg: (Default val | Black val | Red val | Green val | Yellow val | Blue val | Magenta val | Cyan val | White val | BrightBlack val | BrightRed val | BrightGreen val | BrightYellow val | BrightBlue val | BrightMagenta val | BrightCyan val | BrightWhite val | Rainbow val) = reference
wrap: Bool val = true

Returns¶

TextBox tag^

Public Behaviours¶

set_text¶

[Source]

Update the text content and re-render.

be set_text(
  text: String val)

Parameters¶

text: String val

set_color¶

[Source]

Update the text colors and re-render.

be set_color(
  fg: (Default val | Black val | Red val | 
    Green val | Yellow val | Blue val | 
    Magenta val | Cyan val | White val | 
    BrightBlack val | BrightRed val | BrightGreen val | 
    BrightYellow val | BrightBlue val | BrightMagenta val | 
    BrightCyan val | BrightWhite val | Rainbow val),
  bg: (Default val | Black val | Red val | 
    Green val | Yellow val | Blue val | 
    Magenta val | Cyan val | White val | 
    BrightBlack val | BrightRed val | BrightGreen val | 
    BrightYellow val | BrightBlue val | BrightMagenta val | 
    BrightCyan val | BrightWhite val | Rainbow val) = reference)

Parameters¶

fg: (Default val | Black val | Red val | Green val | Yellow val | Blue val | Magenta val | Cyan val | White val | BrightBlack val | BrightRed val | BrightGreen val | BrightYellow val | BrightBlue val | BrightMagenta val | BrightCyan val | BrightWhite val | Rainbow val)
bg: (Default val | Black val | Red val | Green val | Yellow val | Blue val | Magenta val | Cyan val | White val | BrightBlack val | BrightRed val | BrightGreen val | BrightYellow val | BrightBlue val | BrightMagenta val | BrightCyan val | BrightWhite val | Rainbow val) = reference

set_wrap¶

[Source]

Enable or disable word wrapping and re-render.

be set_wrap(
  wrap: Bool val)

Parameters¶

wrap: Bool val

resize¶

[Source]

be resize(
  w: USize val,
  h: USize val)

Parameters¶

w: USize val
h: USize val

trigger_render¶

[Source]

be trigger_render()

receive_key¶

[Source]

be receive_key(
  key: KeyEvent val)

Parameters¶

key: KeyEvent val

receive_focus¶

[Source]

be receive_focus()

receive_blur¶

[Source]

be receive_blur()

set_debug_bg¶

[Source]

be set_debug_bg(
  color: (Default val | Black val | Red val | 
    Green val | Yellow val | Blue val | 
    Magenta val | Cyan val | White val | 
    BrightBlack val | BrightRed val | BrightGreen val | 
    BrightYellow val | BrightBlue val | BrightMagenta val | 
    BrightCyan val | BrightWhite val | Rainbow val))