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

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

Summary

Functions

clear(buffer)

Clears the entire buffer.

clear_all(buffer)

Clears all buffer content (alias for clear).

clear_line(buffer, row, style \\ nil)

Clears an entire line.

clear_line_from(buffer, row, col, style \\ nil)

Clears a line from a position.

clear_line_to(buffer, row, col, style \\ nil)

Clears a line to a position.

clear_region(buffer, x, y, width, height, style \\ nil)

Clears a rectangular region.

clear_screen(buffer, style \\ nil)

Clears the screen with a style.

clear_screen_from(buffer, row, col, style \\ nil)

Clears screen from a position.

clear_screen_to(buffer, row, col, style \\ nil)

Clears screen to a position.

clear_scrollback(buffer)

Clears scrollback buffer.

erase_chars(buffer, count)

Erases characters at cursor position.

erase_chars(buffer, row, col, count)

Erases a number of characters at a position.

erase_from_cursor_to_end(buffer)

Erases from cursor to end of line.

erase_from_start_of_line_to_cursor(buffer)

Erases from start of line to cursor.

erase_from_start_to_cursor(buffer)

Erases from start of line to cursor.

erase_in_display(buffer, mode)

Erases in display with mode.

erase_in_line(buffer, y, mode)

Erases in line with mode at position.

erase_line(buffer, y)

Erases a line.

erase_line_segment(buffer, x, y)

Erases a line segment.

Functions

clear(buffer)

@spec clear(term()) :: term()

Clears the entire buffer.

clear_all(buffer)

@spec clear_all(term()) :: term()

Clears all buffer content (alias for clear).

clear_line(buffer, row, style \\ nil)

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

Clears an entire line.

clear_line_from(buffer, row, col, style \\ nil)

@spec clear_line_from(
  term(),
  non_neg_integer(),
  non_neg_integer(),
  map() | nil
) :: term()

Clears a line from a position.

clear_line_to(buffer, row, col, style \\ nil)

@spec clear_line_to(term(), non_neg_integer(), non_neg_integer(), map() | nil) ::
  term()

Clears a line to a position.

clear_region(buffer, x, y, width, height, style \\ nil)

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

Clears a rectangular region.

clear_screen(buffer, style \\ nil)

@spec clear_screen(term(), map() | nil) :: term()

Clears the screen with a style.

clear_screen_from(buffer, row, col, style \\ nil)

@spec clear_screen_from(
  term(),
  non_neg_integer(),
  non_neg_integer(),
  map() | nil
) :: term()

Clears screen from a position.

clear_screen_to(buffer, row, col, style \\ nil)

@spec clear_screen_to(
  term(),
  non_neg_integer(),
  non_neg_integer(),
  map() | nil
) :: term()

Clears screen to a position.

clear_scrollback(buffer)

@spec clear_scrollback(term()) :: term()

Clears scrollback buffer.

erase_chars(buffer, count)

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

Erases characters at cursor position.

erase_chars(buffer, row, col, count)

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

Erases a number of characters at a position.

erase_from_cursor_to_end(buffer)

@spec erase_from_cursor_to_end(term()) :: term()

Erases from cursor to end of line.

erase_from_start_of_line_to_cursor(buffer)

@spec erase_from_start_of_line_to_cursor(term()) :: term()

Erases from start of line to cursor.

erase_from_start_to_cursor(buffer)

@spec erase_from_start_to_cursor(term()) :: term()

Erases from start of line to cursor.

erase_in_display(buffer, mode)

@spec erase_in_display(term(), atom()) :: term()

Erases in display with mode.

erase_in_line(buffer, y, mode)

@spec erase_in_line(term(), non_neg_integer(), atom()) :: term()

Erases in line with mode at position.

erase_line(buffer, y)

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

Erases a line.

erase_line_segment(buffer, x, y)

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

Erases a line segment.