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

View Source

All buffer mutation operations. Consolidates: Operations, Ops, OperationsCached, Writer, Updater, CharEditor, LineOperations, Eraser, Content, Paste functionality.

Summary

Functions

Clears a line.

Clears a line (stub).

Clears a rectangular region.

Clears from cursor to beginning of line.

Clears from cursor to beginning of screen.

Clears from cursor to end of line.

Clears from cursor to end of screen.

Deletes a character at the cursor position, shifting content left.

Deletes characters at cursor position.

Deletes a line at the specified position.

Deletes lines (stub with 2 args).

Deletes lines at position y with count, within a region.

Erases characters (stub with 2 args).

Erases characters at position (stub with 4 args).

Erases display (stub).

Erases line (stub with 2 args).

Erases line at position (stub with 3 args).

Gets scroll region (stub).

Inserts a character at the cursor position, shifting content right.

Inserts a character at the specified position.

Inserts a character at the specified position with style.

Inserts spaces at cursor position, shifting content to the right. Cursor remains at its original position after the operation.

Inserts a blank line at the specified position.

Inserts lines at cursor position (stub with 2 args).

Inserts lines at position y with count.

Inserts lines at position y with count, within a scroll region.

Prepends lines to buffer.

Puts a line of cells at the specified y position. Used by scrolling operations and for backward compatibility.

Scrolls content down (stub).

Scrolls to position (stub).

Scrolls content up (stub).

Sets scroll region (stub).

Shifts region content so that target_line appears at the top of the region.

Writes a character at the specified position.

Writes a sixel graphics character at the specified position with the sixel flag set.

Writes a string starting at the specified position (alias for write_text).

Writes a string starting at the specified position with style.

Writes a string starting at the specified position.

Functions

clear_line(buffer, y)

Clears a line.

clear_line(buffer, y, mode)

Clears a line (stub).

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

Clears a rectangular region.

clear_to_beginning_of_line(buffer)

Clears from cursor to beginning of line.

clear_to_beginning_of_screen(buffer)

@spec clear_to_beginning_of_screen(Raxol.Terminal.ScreenBuffer.Core.t()) ::
  Raxol.Terminal.ScreenBuffer.Core.t()

Clears from cursor to beginning of screen.

clear_to_end_of_line(buffer)

Clears from cursor to end of line.

clear_to_end_of_screen(buffer)

Clears from cursor 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, shifting content left.

delete_chars(buffer, count)

Deletes characters at cursor position.

delete_line(buffer, y)

Deletes a line at the specified position.

delete_lines(buffer, count)

Deletes lines (stub with 2 args).

delete_lines(buffer, y, count, style, arg)

Deletes lines at position y with count, within a region.

erase_chars(buffer, count)

Erases characters (stub with 2 args).

erase_chars(buffer, x, y, count)

Erases characters at position (stub with 4 args).

erase_display(buffer, mode)

Erases display (stub).

erase_line(buffer, mode)

Erases line (stub with 2 args).

erase_line(buffer, y, mode)

Erases line at position (stub with 3 args).

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

Fills a region with a character.

get_region(arg1)

@spec get_region(Raxol.Terminal.ScreenBuffer.Core.t()) :: {integer(), integer()} | nil

Gets scroll region (stub).

insert_char(buffer, char, style \\ nil)

Inserts a character at the cursor position, shifting content right.

insert_char(buffer, x, y, char)

Inserts a character at the specified position.

insert_char(buffer, x, y, char, style)

Inserts a character at the specified position with style.

insert_chars(buffer, count)

Inserts spaces at cursor position, shifting content to the right. Cursor remains at its original position after the operation.

insert_line(buffer, y)

Inserts a blank line at the specified position.

insert_lines(buffer, count)

Inserts lines at cursor position (stub with 2 args).

insert_lines(buffer, y, count, style)

Inserts lines at position y with count.

insert_lines(buffer, y, count, style, arg)

Inserts lines at position y with count, within a scroll region.

prepend_lines(buffer, count)

Prepends lines to buffer.

put_line(buffer, y, line)

Puts a line of cells at the specified y position. Used by scrolling operations and for backward compatibility.

scroll_down(buffer, count)

Scrolls content down (stub).

scroll_to(buffer, x, y, opts)

Scrolls to position (stub).

scroll_up(buffer, count)

Scrolls content up (stub).

set_region(buffer, top, bottom)

Sets scroll region (stub).

shift_region_to_line(buffer, arg, target_line)

Shifts region content so that target_line appears at the top of the region.

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

Writes a character at the specified position.

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

Writes a sixel graphics character at the specified position with the sixel flag set.

write_string(buffer, x, y, string)

Writes a string starting at the specified position (alias for write_text).

write_string(buffer, x, y, string, style)

Writes a string starting at the specified position with style.

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

Writes a string starting at the specified position.