GPUI.Text.Decoration (gpui v0.2.0)

Copy Markdown View Source

A neutral visual annotation attached to a logical text range.

Decorations carry rendering facts only. background and underline are six-digit RGB integers; consumers retain diagnostic, language, severity, and command policy outside the renderer primitive.

Summary

Types

rgb()
t()
underline_style()

Functions

new(range, opts \\ [])

Creates a validated visual decoration for a logical text range.

validate!(decoration)

Validates a decoration's colors and underline style.

Types

rgb()

@type rgb() :: 0..16_777_215

t()

@type t() :: %GPUI.Text.Decoration{
  background: rgb() | nil,
  range: GPUI.Text.Range.t(),
  underline: rgb() | nil,
  underline_style: underline_style()
}

underline_style()

@type underline_style() :: :solid | :dashed | :wavy

Functions

new(range, opts \\ [])

@spec new(
  GPUI.Text.Range.t(),
  keyword()
) :: t()

Creates a validated visual decoration for a logical text range.

validate!(decoration)

@spec validate!(t()) :: t()

Validates a decoration's colors and underline style.