Raxol.Terminal.Buffer.Operations (Raxol v2.0.1)

Compatibility adapter for consolidated buffer operations. Forwards calls to Raxol.Terminal.ScreenBuffer.Operations.

Summary

Functions

clear_line(buffer, y)

Clears a line.

clear_region(buffer, x, y, width, height)

Clears a rectangular region.

clear_to_beginning_of_line(buffer)

Clears to beginning of line.

clear_to_beginning_of_screen(buffer)

Clears to beginning of screen.

clear_to_end_of_line(buffer)

Clears to end of line.

clear_to_end_of_screen(buffer)

Clears to end of screen.

copy_region(buffer, src_x, src_y, width, height, dest_x, dest_y)

Copies a region to another location.

delete_char(buffer)

Deletes a character at the cursor position.

delete_line(buffer, y)

Deletes a line.

delete_lines(buffer, y, count, style \\ nil)

Deletes multiple lines (compatibility function).

delete_lines(buffer, lines, y, top, bottom)

fill_region(buffer, x, y, width, height, char, style \\ nil)

Fills a region with a character.

insert_char(buffer, char, style \\ nil)

Inserts a character at the cursor position.

insert_line(buffer, y)

Inserts a blank line.

insert_lines(buffer, y, count, style \\ nil)

Inserts multiple lines (compatibility function).

insert_lines(buffer, lines, y, top, bottom)

write_char(buffer, x, y, char, style \\ nil)

Writes a character at the specified position.

write_text(buffer, x, y, text, style \\ nil)

Writes text starting at the specified position.

Functions

clear_line(buffer, y)

@spec clear_line(term(), non_neg_integer()) :: term()

Clears a line.

clear_region(buffer, x, y, width, height)

@spec clear_region(
  term(),
  non_neg_integer(),
  non_neg_integer(),
  non_neg_integer(),
  non_neg_integer()
) :: term()

Clears a rectangular region.

clear_to_beginning_of_line(buffer)

@spec clear_to_beginning_of_line(term()) :: term()

Clears to beginning of line.

clear_to_beginning_of_screen(buffer)

@spec clear_to_beginning_of_screen(term()) :: term()

Clears to beginning of screen.

clear_to_end_of_line(buffer)

@spec clear_to_end_of_line(term()) :: term()

Clears to end of line.

clear_to_end_of_screen(buffer)

@spec clear_to_end_of_screen(term()) :: term()

Clears to end of screen.

copy_region(buffer, src_x, src_y, width, height, dest_x, dest_y)

@spec copy_region(
  term(),
  non_neg_integer(),
  non_neg_integer(),
  non_neg_integer(),
  non_neg_integer(),
  non_neg_integer(),
  non_neg_integer()
) :: term()

Copies a region to another location.

delete_char(buffer)

@spec delete_char(term()) :: term()

Deletes a character at the cursor position.

delete_line(buffer, y)

@spec delete_line(term(), non_neg_integer()) :: term()

Deletes a line.

delete_lines(buffer, y, count, style \\ nil)

Deletes multiple lines (compatibility function).

delete_lines(buffer, lines, y, top, bottom)

fill_region(buffer, x, y, width, height, char, style \\ nil)

@spec fill_region(
  term(),
  non_neg_integer(),
  non_neg_integer(),
  non_neg_integer(),
  non_neg_integer(),
  String.t(),
  map() | nil
) :: term()

Fills a region with a character.

insert_char(buffer, char, style \\ nil)

@spec insert_char(term(), String.t(), map() | nil) :: term()

Inserts a character at the cursor position.

insert_line(buffer, y)

@spec insert_line(term(), non_neg_integer()) :: term()

Inserts a blank line.

insert_lines(buffer, y, count, style \\ nil)

Inserts multiple lines (compatibility function).

insert_lines(buffer, lines, y, top, bottom)

write_char(buffer, x, y, char, style \\ nil)

@spec write_char(
  term(),
  non_neg_integer(),
  non_neg_integer(),
  String.t(),
  map() | nil
) :: term()

Writes a character at the specified position.

write_text(buffer, x, y, text, style \\ nil)

@spec write_text(
  term(),
  non_neg_integer(),
  non_neg_integer(),
  String.t(),
  map() | nil
) :: term()

Writes text starting at the specified position.