Raxol.Terminal.Emulator.Style (Raxol v0.3.0)

View Source

Handles text styling and formatting for the terminal emulator. Provides functions for managing character attributes, colors, and text formatting.

Summary

Functions

Gets the current text style. Returns the current style.

Resets all text attributes to default. Returns {:ok, updated_emulator}.

Sets the text style attributes. Returns {:ok, updated_emulator} or {:error, reason}.

Sets the background color. Returns {:ok, updated_emulator} or {:error, reason}.

Sets the text blink mode. Returns {:ok, updated_emulator} or {:error, reason}.

Sets the text decoration (underline, strikethrough, etc.). Returns {:ok, updated_emulator} or {:error, reason}.

Sets the foreground color. Returns {:ok, updated_emulator} or {:error, reason}.

Sets the text intensity (bold, faint). Returns {:ok, updated_emulator} or {:error, reason}.

Sets the text inverse mode. Returns {:ok, updated_emulator} or {:error, reason}.

Sets the text visibility. Returns {:ok, updated_emulator} or {:error, reason}.

Functions

get_style(emulator)

Gets the current text style. Returns the current style.

reset_attributes(emulator)

@spec reset_attributes(Raxol.Terminal.Core.t()) :: {:ok, Raxol.Terminal.Core.t()}

Resets all text attributes to default. Returns {:ok, updated_emulator}.

set_attributes(emulator, attributes)

@spec set_attributes(Raxol.Terminal.Core.t(), list()) ::
  {:ok, Raxol.Terminal.Core.t()} | {:error, String.t()}

Sets the text style attributes. Returns {:ok, updated_emulator} or {:error, reason}.

set_background(emulator, color)

@spec set_background(
  Raxol.Terminal.Core.t(),
  Raxol.Terminal.ANSI.TextFormatting.color()
) ::
  {:ok, Raxol.Terminal.Core.t()} | {:error, String.t()}

Sets the background color. Returns {:ok, updated_emulator} or {:error, reason}.

set_blink(emulator, blink)

@spec set_blink(Raxol.Terminal.Core.t(), :none | :slow | :rapid) ::
  {:ok, Raxol.Terminal.Core.t()} | {:error, String.t()}

Sets the text blink mode. Returns {:ok, updated_emulator} or {:error, reason}.

set_decoration(emulator, decoration)

@spec set_decoration(
  Raxol.Terminal.Core.t(),
  Raxol.Terminal.ANSI.TextFormatting.decoration()
) ::
  {:ok, Raxol.Terminal.Core.t()} | {:error, String.t()}

Sets the text decoration (underline, strikethrough, etc.). Returns {:ok, updated_emulator} or {:error, reason}.

set_foreground(emulator, color)

@spec set_foreground(
  Raxol.Terminal.Core.t(),
  Raxol.Terminal.ANSI.TextFormatting.color()
) ::
  {:ok, Raxol.Terminal.Core.t()} | {:error, String.t()}

Sets the foreground color. Returns {:ok, updated_emulator} or {:error, reason}.

set_intensity(emulator, intensity)

@spec set_intensity(Raxol.Terminal.Core.t(), :normal | :bold | :faint) ::
  {:ok, Raxol.Terminal.Core.t()} | {:error, String.t()}

Sets the text intensity (bold, faint). Returns {:ok, updated_emulator} or {:error, reason}.

set_inverse(emulator, inverse)

@spec set_inverse(Raxol.Terminal.Core.t(), boolean()) ::
  {:ok, Raxol.Terminal.Core.t()} | {:error, String.t()}

Sets the text inverse mode. Returns {:ok, updated_emulator} or {:error, reason}.

set_visibility(emulator, visibility)

@spec set_visibility(Raxol.Terminal.Core.t(), :visible | :hidden) ::
  {:ok, Raxol.Terminal.Core.t()} | {:error, String.t()}

Sets the text visibility. Returns {:ok, updated_emulator} or {:error, reason}.