Raxol.Terminal.ScreenBuffer.Attributes (Raxol v2.0.1)
View SourceManages buffer attributes including formatting, charset, and cursor state. Consolidates: Formatting, TextFormatting, Charset, Cursor functionality.
Summary
Functions
Applies single shift (stub).
Checks if attribute is set (stub).
Clears all tab stops.
Clears selection (stub).
Clears a tab stop at the current cursor position.
Creates a text style from SGR parameters.
Checks if cursor is blinking (stub).
Checks if cursor is visible (stub).
Designates charset (stub).
Gets the currently active charset.
Gets background color (stub).
Gets the active charset for a slot.
Gets current G set (stub).
Gets the cursor position.
Gets cursor style (stub).
Gets the default text style.
Gets designated charset (stub).
Gets foreground color (stub).
Gets selection (stub).
Gets selection boundaries (stub).
Gets selection end (stub).
Gets selection start (stub).
Gets set attributes (stub).
Gets single shift state (stub).
Gets text style (stub).
Gets text in region.
Checks if position is in selection (stub).
Invokes G set (stub).
Merges two styles, with the second taking precedence.
Moves the cursor relative to its current position.
Finds the next tab stop position from the current cursor.
Resets all attributes to defaults (stub).
Resets specific attribute (stub).
Resets charset state (stub).
Resets tab stops to default (every 8 columns).
Restores the saved cursor position.
Saves the current cursor position.
Selects which charset slot is active.
Checks if selection is active (stub).
Switches between main and alternate screen buffers.
Sets specific attribute (stub).
Sets background color (stub).
Sets the active charset (G0, G1, G2, G3).
Sets cursor blink state.
Sets the cursor position.
Sets cursor style.
Sets cursor visibility (stub).
Sets cursor visibility.
Sets the default text style for the buffer.
Sets foreground color (stub).
Sets a tab stop at the current cursor position.
Starts selection (stub).
Translates a character according to the active charset.
Updates selection (stub).
Updates text style (stub).
Checks if using alternate screen.
Functions
@spec apply_single_shift(Raxol.Terminal.ScreenBuffer.Core.t(), integer()) :: Raxol.Terminal.ScreenBuffer.Core.t()
Applies single shift (stub).
@spec attribute_set?(Raxol.Terminal.ScreenBuffer.Core.t(), atom()) :: boolean()
Checks if attribute is set (stub).
@spec clear_all_tab_stops(Raxol.Terminal.ScreenBuffer.Core.t()) :: Raxol.Terminal.ScreenBuffer.Core.t()
Clears all tab stops.
@spec clear_selection(Raxol.Terminal.ScreenBuffer.Core.t()) :: Raxol.Terminal.ScreenBuffer.Core.t()
Clears selection (stub).
@spec clear_tab_stop(Raxol.Terminal.ScreenBuffer.Core.t()) :: Raxol.Terminal.ScreenBuffer.Core.t()
Clears a tab stop at the current cursor position.
Creates a text style from SGR parameters.
@spec cursor_blinking?(Raxol.Terminal.ScreenBuffer.Core.t()) :: boolean()
Checks if cursor is blinking (stub).
@spec cursor_visible?(Raxol.Terminal.ScreenBuffer.Core.t()) :: boolean()
Checks if cursor is visible (stub).
@spec designate_charset(Raxol.Terminal.ScreenBuffer.Core.t(), integer(), atom()) :: Raxol.Terminal.ScreenBuffer.Core.t()
Designates charset (stub).
@spec get_active_charset(Raxol.Terminal.ScreenBuffer.Core.t()) :: atom()
Gets the currently active charset.
@spec get_background(Raxol.Terminal.ScreenBuffer.Core.t()) :: atom() | tuple()
Gets background color (stub).
@spec get_charset(Raxol.Terminal.ScreenBuffer.Core.t(), atom()) :: atom()
Gets the active charset for a slot.
@spec get_current_g_set(Raxol.Terminal.ScreenBuffer.Core.t()) :: integer()
Gets current G set (stub).
@spec get_cursor_position(Raxol.Terminal.ScreenBuffer.Core.t()) :: {non_neg_integer(), non_neg_integer()}
Gets the cursor position.
@spec get_cursor_style(Raxol.Terminal.ScreenBuffer.Core.t()) :: atom()
Gets cursor style (stub).
@spec get_default_style(Raxol.Terminal.ScreenBuffer.Core.t()) :: map()
Gets the default text style.
@spec get_designated_charset(Raxol.Terminal.ScreenBuffer.Core.t(), integer()) :: atom()
Gets designated charset (stub).
@spec get_foreground(Raxol.Terminal.ScreenBuffer.Core.t()) :: atom() | tuple()
Gets foreground color (stub).
@spec get_selection(Raxol.Terminal.ScreenBuffer.Core.t()) :: {integer(), integer(), integer(), integer()} | nil
Gets selection (stub).
@spec get_selection_boundaries(Raxol.Terminal.ScreenBuffer.Core.t()) :: {integer(), integer(), integer(), integer()} | nil
Gets selection boundaries (stub).
@spec get_selection_end(Raxol.Terminal.ScreenBuffer.Core.t()) :: {integer(), integer()} | nil
Gets selection end (stub).
@spec get_selection_start(Raxol.Terminal.ScreenBuffer.Core.t()) :: {integer(), integer()} | nil
Gets selection start (stub).
@spec get_set_attributes(Raxol.Terminal.ScreenBuffer.Core.t()) :: [atom()]
Gets set attributes (stub).
@spec get_single_shift(Raxol.Terminal.ScreenBuffer.Core.t()) :: integer() | nil
Gets single shift state (stub).
@spec get_style(Raxol.Terminal.ScreenBuffer.Core.t()) :: Raxol.Terminal.ANSI.TextFormatting.text_style()
Gets text style (stub).
@spec get_text_in_region( Raxol.Terminal.ScreenBuffer.Core.t(), integer(), integer(), integer(), integer() ) :: String.t()
Gets text in region.
@spec in_selection?( Raxol.Terminal.ScreenBuffer.Core.t(), non_neg_integer(), non_neg_integer() ) :: boolean()
Checks if position is in selection (stub).
@spec invoke_g_set(Raxol.Terminal.ScreenBuffer.Core.t(), integer()) :: Raxol.Terminal.ScreenBuffer.Core.t()
Invokes G set (stub).
Merges two styles, with the second taking precedence.
@spec move_cursor(Raxol.Terminal.ScreenBuffer.Core.t(), integer(), integer()) :: Raxol.Terminal.ScreenBuffer.Core.t()
Moves the cursor relative to its current position.
@spec next_tab_stop(Raxol.Terminal.ScreenBuffer.Core.t()) :: non_neg_integer()
Finds the next tab stop position from the current cursor.
@spec reset_all_attributes(Raxol.Terminal.ScreenBuffer.Core.t()) :: Raxol.Terminal.ScreenBuffer.Core.t()
Resets all attributes to defaults (stub).
@spec reset_attribute(Raxol.Terminal.ScreenBuffer.Core.t(), atom()) :: Raxol.Terminal.ScreenBuffer.Core.t()
Resets specific attribute (stub).
@spec reset_charset_state(Raxol.Terminal.ScreenBuffer.Core.t()) :: Raxol.Terminal.ScreenBuffer.Core.t()
Resets charset state (stub).
@spec reset_tab_stops(Raxol.Terminal.ScreenBuffer.Core.t()) :: Raxol.Terminal.ScreenBuffer.Core.t()
Resets tab stops to default (every 8 columns).
@spec restore_cursor(Raxol.Terminal.ScreenBuffer.Core.t()) :: Raxol.Terminal.ScreenBuffer.Core.t()
Restores the saved cursor position.
@spec save_cursor(Raxol.Terminal.ScreenBuffer.Core.t()) :: Raxol.Terminal.ScreenBuffer.Core.t()
Saves the current cursor position.
@spec select_charset(Raxol.Terminal.ScreenBuffer.Core.t(), atom()) :: Raxol.Terminal.ScreenBuffer.Core.t()
Selects which charset slot is active.
@spec selection_active?(Raxol.Terminal.ScreenBuffer.Core.t()) :: boolean()
Checks if selection is active (stub).
@spec set_alternate_screen(Raxol.Terminal.ScreenBuffer.Core.t(), boolean()) :: Raxol.Terminal.ScreenBuffer.Core.t()
Switches between main and alternate screen buffers.
@spec set_attribute(Raxol.Terminal.ScreenBuffer.Core.t(), atom()) :: Raxol.Terminal.ScreenBuffer.Core.t()
Sets specific attribute (stub).
@spec set_background(Raxol.Terminal.ScreenBuffer.Core.t(), atom() | tuple()) :: Raxol.Terminal.ScreenBuffer.Core.t()
Sets background color (stub).
@spec set_charset(Raxol.Terminal.ScreenBuffer.Core.t(), atom(), atom()) :: Raxol.Terminal.ScreenBuffer.Core.t()
Sets the active charset (G0, G1, G2, G3).
@spec set_cursor_blink(Raxol.Terminal.ScreenBuffer.Core.t(), boolean()) :: Raxol.Terminal.ScreenBuffer.Core.t()
Sets cursor blink state.
@spec set_cursor_position( Raxol.Terminal.ScreenBuffer.Core.t(), non_neg_integer(), non_neg_integer() ) :: Raxol.Terminal.ScreenBuffer.Core.t()
Sets the cursor position.
@spec set_cursor_style(Raxol.Terminal.ScreenBuffer.Core.t(), atom()) :: Raxol.Terminal.ScreenBuffer.Core.t()
Sets cursor style.
@spec set_cursor_visibility(Raxol.Terminal.ScreenBuffer.Core.t(), boolean()) :: Raxol.Terminal.ScreenBuffer.Core.t()
Sets cursor visibility (stub).
@spec set_cursor_visible(Raxol.Terminal.ScreenBuffer.Core.t(), boolean()) :: Raxol.Terminal.ScreenBuffer.Core.t()
Sets cursor visibility.
@spec set_default_style(Raxol.Terminal.ScreenBuffer.Core.t(), map()) :: Raxol.Terminal.ScreenBuffer.Core.t()
Sets the default text style for the buffer.
@spec set_foreground(Raxol.Terminal.ScreenBuffer.Core.t(), atom() | tuple()) :: Raxol.Terminal.ScreenBuffer.Core.t()
Sets foreground color (stub).
@spec set_tab_stop(Raxol.Terminal.ScreenBuffer.Core.t()) :: Raxol.Terminal.ScreenBuffer.Core.t()
Sets a tab stop at the current cursor position.
@spec start_selection( Raxol.Terminal.ScreenBuffer.Core.t(), non_neg_integer(), non_neg_integer() ) :: Raxol.Terminal.ScreenBuffer.Core.t()
Starts selection (stub).
@spec translate_char(Raxol.Terminal.ScreenBuffer.Core.t(), String.t()) :: String.t()
Translates a character according to the active charset.
@spec update_selection( Raxol.Terminal.ScreenBuffer.Core.t(), non_neg_integer(), non_neg_integer() ) :: Raxol.Terminal.ScreenBuffer.Core.t()
Updates selection (stub).
@spec update_style( Raxol.Terminal.ScreenBuffer.Core.t(), Raxol.Terminal.ANSI.TextFormatting.text_style() ) :: Raxol.Terminal.ScreenBuffer.Core.t()
Updates text style (stub).
@spec using_alternate_screen?(Raxol.Terminal.ScreenBuffer.Core.t()) :: boolean()
Checks if using alternate screen.