Term¶

These strings can be embedded in text when writing to a StdStream to create a text-based UI.

primitive val Term is
  TerminalEscapeCodes ref

Implements¶

TerminalEscapeCodes ref

Constructors¶

create¶

[Source]

new val create()
: Term val^

Returns¶

Term val^

Public Functions¶

up¶

[Source]

fun box up(
  n: U32 val = 0)
: String val

Parameters¶

n: U32 val = 0

Returns¶

String val

down¶

[Source]

fun box down(
  n: U32 val = 0)
: String val

Parameters¶

n: U32 val = 0

Returns¶

String val

right¶

[Source]

fun box right(
  n: U32 val = 0)
: String val

Parameters¶

n: U32 val = 0

Returns¶

String val

left¶

[Source]

fun box left(
  n: U32 val = 0)
: String val

Parameters¶

n: U32 val = 0

Returns¶

String val

cursor¶

[Source]

fun box cursor(
  x: U32 val = 0,
  y: U32 val = 0)
: String val

Parameters¶

x: U32 val = 0
y: U32 val = 0

Returns¶

String val

clear¶

[Source]

fun box clear(
  how_much: (EraseBefore val | EraseAfter val | EraseAll val) = reference)
: String val

Parameters¶

how_much: (EraseBefore val | EraseAfter val | EraseAll val) = reference

Returns¶

String val

erase¶

[Source]

fun box erase(
  how_much: (EraseBefore val | EraseAfter val | EraseAll val) = reference)
: String val

Parameters¶

how_much: (EraseBefore val | EraseAfter val | EraseAll val) = reference

Returns¶

String val

reset¶

[Source]

fun box reset()
: String val

Returns¶

String val

bold¶

[Source]

fun box bold(
  state: Bool val = true)
: String val

Parameters¶

state: Bool val = true

Returns¶

String val

underline¶

[Source]

fun box underline(
  state: Bool val = true)
: String val

Parameters¶

state: Bool val = true

Returns¶

String val

blink¶

[Source]

fun box blink(
  state: Bool val = true)
: String val

Parameters¶

state: Bool val = true

Returns¶

String val

reverse¶

[Source]

fun box reverse(
  state: Bool val = true)
: String val

Parameters¶

state: Bool val = true

Returns¶

String val

black¶

[Source]

fun box black()
: String val

Returns¶

String val

red¶

[Source]

fun box red()
: String val

Returns¶

String val

green¶

[Source]

fun box green()
: String val

Returns¶

String val

yellow¶

[Source]

fun box yellow()
: String val

Returns¶

String val

blue¶

[Source]

fun box blue()
: String val

Returns¶

String val

magenta¶

[Source]

fun box magenta()
: String val

Returns¶

String val

cyan¶

[Source]

fun box cyan()
: String val

Returns¶

String val

grey¶

[Source]

fun box grey()
: String val

Returns¶

String val

white¶

[Source]

fun box white()
: String val

Returns¶

String val

bright_red¶

[Source]

fun box bright_red()
: String val

Returns¶

String val

bright_green¶

[Source]

fun box bright_green()
: String val

Returns¶

String val

bright_yellow¶

[Source]

fun box bright_yellow()
: String val

Returns¶

String val

bright_blue¶

[Source]

fun box bright_blue()
: String val

Returns¶

String val

bright_magenta¶

[Source]

fun box bright_magenta()
: String val

Returns¶

String val

bright_cyan¶

[Source]

fun box bright_cyan()
: String val

Returns¶

String val

bright_grey¶

[Source]

fun box bright_grey()
: String val

Returns¶

String val

black_bg¶

[Source]

fun box black_bg()
: String val

Returns¶

String val

red_bg¶

[Source]

fun box red_bg()
: String val

Returns¶

String val

green_bg¶

[Source]

fun box green_bg()
: String val

Returns¶

String val

yellow_bg¶

[Source]

fun box yellow_bg()
: String val

Returns¶

String val

blue_bg¶

[Source]

fun box blue_bg()
: String val

Returns¶

String val

magenta_bg¶

[Source]

fun box magenta_bg()
: String val

Returns¶

String val

cyan_bg¶

[Source]

fun box cyan_bg()
: String val

Returns¶

String val

grey_bg¶

[Source]

fun box grey_bg()
: String val

Returns¶

String val

white_bg¶

[Source]

fun box white_bg()
: String val

Returns¶

String val

bright_red_bg¶

[Source]

fun box bright_red_bg()
: String val

Returns¶

String val

bright_green_bg¶

[Source]

fun box bright_green_bg()
: String val

Returns¶

String val

bright_yellow_bg¶

[Source]

fun box bright_yellow_bg()
: String val

Returns¶

String val

bright_blue_bg¶

[Source]

fun box bright_blue_bg()
: String val

Returns¶

String val

bright_magenta_bg¶

[Source]

fun box bright_magenta_bg()
: String val

Returns¶

String val

bright_cyan_bg¶

[Source]

fun box bright_cyan_bg()
: String val

Returns¶

String val

bright_grey_bg¶

[Source]

fun box bright_grey_bg()
: String val

Returns¶

String val

cursor_save¶

[Source]

fun box cursor_save()
: String val

Returns¶

String val

cursor_restore¶

[Source]

fun box cursor_restore()
: String val

Returns¶

String val

cursor_hide¶

[Source]

fun box cursor_hide()
: String val

Returns¶

String val

cursor_show¶

[Source]

fun box cursor_show()
: String val

Returns¶

String val

switch_to_alt_screen¶

[Source]

fun box switch_to_alt_screen()
: String val

Returns¶

String val

switch_to_normal_screen¶

[Source]

fun box switch_to_normal_screen()
: String val

Returns¶

String val

mouse_enable¶

[Source]

fun box mouse_enable()
: String val

Returns¶

String val

mouse_disable¶

[Source]

fun box mouse_disable()
: String val

Returns¶

String val

reset_color¶

[Source]

fun box reset_color()
: String val

Returns¶

String val

reset_color_bg¶

[Source]

fun box reset_color_bg()
: String val

Returns¶

String val

color¶

[Source]

fun box color(
  fg: U8 val)
: String val

Parameters¶

fg: U8 val

Returns¶

String val

color_bg¶

[Source]

fun box color_bg(
  bg: U8 val)
: String val

Parameters¶

bg: U8 val

Returns¶

String val

faint¶

[Source]

fun box faint(
  state: Bool val = true)
: String val

Parameters¶

state: Bool val = true

Returns¶

String val

italics¶

[Source]

fun box italics(
  state: Bool val = true)
: String val

Parameters¶

state: Bool val = true

Returns¶

String val

invert¶

[Source]

fun box invert(
  state: Bool val = true)
: String val

Parameters¶

state: Bool val = true

Returns¶

String val

conceal¶

[Source]

fun box conceal(
  state: Bool val = true)
: String val

Parameters¶

state: Bool val = true

Returns¶

String val

strikeout¶

[Source]

fun box strikeout(
  state: Bool val = true)
: String val

Parameters¶

state: Bool val = true

Returns¶

String val

repeat_char¶

[Source]

fun box repeat_char(
  char: String val,
  times: U32 val)
: String val

Parameters¶

char: String val
times: U32 val

Returns¶

String val

eq¶

[Source]

fun box eq(
  that: Term val)
: Bool val

Parameters¶

that: Term val

Returns¶

Bool val

ne¶

[Source]

fun box ne(
  that: Term val)
: Bool val

Parameters¶

that: Term val

Returns¶

Bool val