Raxol.Terminal.ScreenBuffer.Operations (Raxol v2.0.1)
View SourceAll 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.
Copies a region to another location.
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).
Fills a region with a character.
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
@spec clear_line(Raxol.Terminal.ScreenBuffer.Core.t(), non_neg_integer()) :: Raxol.Terminal.ScreenBuffer.Core.t()
Clears a line.
@spec clear_line(Raxol.Terminal.ScreenBuffer.Core.t(), non_neg_integer(), atom()) :: Raxol.Terminal.ScreenBuffer.Core.t()
Clears a line (stub).
@spec clear_region( Raxol.Terminal.ScreenBuffer.Core.t(), non_neg_integer(), non_neg_integer(), non_neg_integer(), non_neg_integer() ) :: Raxol.Terminal.ScreenBuffer.Core.t()
Clears a rectangular region.
@spec clear_to_beginning_of_line(Raxol.Terminal.ScreenBuffer.Core.t()) :: Raxol.Terminal.ScreenBuffer.Core.t()
Clears from cursor to beginning of line.
@spec clear_to_beginning_of_screen(Raxol.Terminal.ScreenBuffer.Core.t()) :: Raxol.Terminal.ScreenBuffer.Core.t()
Clears from cursor to beginning of screen.
@spec clear_to_end_of_line(Raxol.Terminal.ScreenBuffer.Core.t()) :: Raxol.Terminal.ScreenBuffer.Core.t()
Clears from cursor to end of line.
@spec clear_to_end_of_screen(Raxol.Terminal.ScreenBuffer.Core.t()) :: Raxol.Terminal.ScreenBuffer.Core.t()
Clears from cursor to end of screen.
@spec copy_region( Raxol.Terminal.ScreenBuffer.Core.t(), non_neg_integer(), non_neg_integer(), non_neg_integer(), non_neg_integer(), non_neg_integer(), non_neg_integer() ) :: Raxol.Terminal.ScreenBuffer.Core.t()
Copies a region to another location.
@spec delete_char(Raxol.Terminal.ScreenBuffer.Core.t()) :: Raxol.Terminal.ScreenBuffer.Core.t()
Deletes a character at the cursor position, shifting content left.
@spec delete_chars(Raxol.Terminal.ScreenBuffer.Core.t(), non_neg_integer()) :: Raxol.Terminal.ScreenBuffer.Core.t()
Deletes characters at cursor position.
@spec delete_line(Raxol.Terminal.ScreenBuffer.Core.t(), non_neg_integer()) :: Raxol.Terminal.ScreenBuffer.Core.t()
Deletes a line at the specified position.
@spec delete_lines(Raxol.Terminal.ScreenBuffer.Core.t(), non_neg_integer()) :: Raxol.Terminal.ScreenBuffer.Core.t()
Deletes lines (stub with 2 args).
@spec delete_lines( Raxol.Terminal.ScreenBuffer.Core.t(), integer(), integer(), map(), {integer(), integer()} ) :: Raxol.Terminal.ScreenBuffer.Core.t()
Deletes lines at position y with count, within a region.
@spec erase_chars(Raxol.Terminal.ScreenBuffer.Core.t(), non_neg_integer()) :: Raxol.Terminal.ScreenBuffer.Core.t()
Erases characters (stub with 2 args).
@spec erase_chars( Raxol.Terminal.ScreenBuffer.Core.t(), integer(), integer(), non_neg_integer() ) :: Raxol.Terminal.ScreenBuffer.Core.t()
Erases characters at position (stub with 4 args).
@spec erase_display(Raxol.Terminal.ScreenBuffer.Core.t(), atom()) :: Raxol.Terminal.ScreenBuffer.Core.t()
Erases display (stub).
@spec erase_line(Raxol.Terminal.ScreenBuffer.Core.t(), atom()) :: Raxol.Terminal.ScreenBuffer.Core.t()
Erases line (stub with 2 args).
@spec erase_line(Raxol.Terminal.ScreenBuffer.Core.t(), non_neg_integer(), atom()) :: Raxol.Terminal.ScreenBuffer.Core.t()
Erases line at position (stub with 3 args).
@spec fill_region( Raxol.Terminal.ScreenBuffer.Core.t(), non_neg_integer(), non_neg_integer(), non_neg_integer(), non_neg_integer(), String.t(), map() | nil ) :: Raxol.Terminal.ScreenBuffer.Core.t()
Fills a region with a character.
@spec get_region(Raxol.Terminal.ScreenBuffer.Core.t()) :: {integer(), integer()} | nil
Gets scroll region (stub).
@spec insert_char(Raxol.Terminal.ScreenBuffer.Core.t(), String.t(), map() | nil) :: Raxol.Terminal.ScreenBuffer.Core.t()
Inserts a character at the cursor position, shifting content right.
@spec insert_char( Raxol.Terminal.ScreenBuffer.Core.t(), non_neg_integer(), non_neg_integer(), String.t() ) :: Raxol.Terminal.ScreenBuffer.Core.t()
Inserts a character at the specified position.
@spec insert_char( Raxol.Terminal.ScreenBuffer.Core.t(), non_neg_integer(), non_neg_integer(), String.t(), map() | nil ) :: Raxol.Terminal.ScreenBuffer.Core.t()
Inserts a character at the specified position with style.
@spec insert_chars(Raxol.Terminal.ScreenBuffer.Core.t(), non_neg_integer()) :: Raxol.Terminal.ScreenBuffer.Core.t()
Inserts spaces at cursor position, shifting content to the right. Cursor remains at its original position after the operation.
@spec insert_line(Raxol.Terminal.ScreenBuffer.Core.t(), non_neg_integer()) :: Raxol.Terminal.ScreenBuffer.Core.t()
Inserts a blank line at the specified position.
@spec insert_lines(Raxol.Terminal.ScreenBuffer.Core.t(), non_neg_integer()) :: Raxol.Terminal.ScreenBuffer.Core.t()
Inserts lines at cursor position (stub with 2 args).
@spec insert_lines( Raxol.Terminal.ScreenBuffer.Core.t(), integer(), integer(), non_neg_integer() ) :: Raxol.Terminal.ScreenBuffer.Core.t()
Inserts lines at position y with count.
@spec insert_lines( Raxol.Terminal.ScreenBuffer.Core.t(), integer(), integer(), map(), {integer(), integer()} ) :: Raxol.Terminal.ScreenBuffer.Core.t()
Inserts lines at position y with count, within a scroll region.
@spec prepend_lines(Raxol.Terminal.ScreenBuffer.Core.t(), integer()) :: Raxol.Terminal.ScreenBuffer.Core.t()
@spec prepend_lines(Raxol.Terminal.ScreenBuffer.Core.t(), list()) :: Raxol.Terminal.ScreenBuffer.Core.t()
Prepends lines to buffer.
@spec put_line(Raxol.Terminal.ScreenBuffer.Core.t(), non_neg_integer(), [ Raxol.Terminal.Cell.t() ]) :: Raxol.Terminal.ScreenBuffer.Core.t()
Puts a line of cells at the specified y position. Used by scrolling operations and for backward compatibility.
@spec scroll_down(Raxol.Terminal.ScreenBuffer.Core.t(), non_neg_integer()) :: Raxol.Terminal.ScreenBuffer.Core.t()
Scrolls content down (stub).
@spec scroll_to(Raxol.Terminal.ScreenBuffer.Core.t(), integer(), integer(), map()) :: Raxol.Terminal.ScreenBuffer.Core.t()
Scrolls to position (stub).
@spec scroll_up(Raxol.Terminal.ScreenBuffer.Core.t(), non_neg_integer()) :: Raxol.Terminal.ScreenBuffer.Core.t()
Scrolls content up (stub).
@spec set_region(Raxol.Terminal.ScreenBuffer.Core.t(), integer(), integer()) :: Raxol.Terminal.ScreenBuffer.Core.t()
Sets scroll region (stub).
@spec shift_region_to_line( Raxol.Terminal.ScreenBuffer.Core.t(), {integer(), integer()}, integer() ) :: Raxol.Terminal.ScreenBuffer.Core.t()
Shifts region content so that target_line appears at the top of the region.
@spec write_char( Raxol.Terminal.ScreenBuffer.Core.t(), non_neg_integer(), non_neg_integer(), String.t(), map() | nil ) :: Raxol.Terminal.ScreenBuffer.Core.t()
Writes a character at the specified position.
@spec write_sixel_char( Raxol.Terminal.ScreenBuffer.Core.t(), non_neg_integer(), non_neg_integer(), String.t(), map() | nil ) :: Raxol.Terminal.ScreenBuffer.Core.t()
Writes a sixel graphics character at the specified position with the sixel flag set.
@spec write_string( Raxol.Terminal.ScreenBuffer.Core.t(), non_neg_integer(), non_neg_integer(), String.t() ) :: Raxol.Terminal.ScreenBuffer.Core.t()
Writes a string starting at the specified position (alias for write_text).
@spec write_string( Raxol.Terminal.ScreenBuffer.Core.t(), non_neg_integer(), non_neg_integer(), String.t(), map() ) :: Raxol.Terminal.ScreenBuffer.Core.t()
Writes a string starting at the specified position with style.
@spec write_text( Raxol.Terminal.ScreenBuffer.Core.t(), non_neg_integer(), non_neg_integer(), String.t(), map() | nil ) :: Raxol.Terminal.ScreenBuffer.Core.t()
Writes a string starting at the specified position.