View Source Mudbrick.TextBlock (mudbrick v0.9.0)

Summary

Types

alignment()

@type alignment() :: :left | :right

option()

@type option() ::
  {:align, alignment()}
  | {:auto_kern, boolean()}
  | {:colour, Mudbrick.colour()}
  | {:font, atom()}
  | {:font_size, number()}
  | {:leading, number()}
  | {:position, Mudbrick.coords()}

options()

@type options() :: [option()]

part_option()

@type part_option() ::
  {:colour, Mudbrick.colour()}
  | {:font, atom()}
  | {:font_size, number()}
  | {:leading, number()}
  | {:underline, underline_options()}

part_options()

@type part_options() :: [part_option()]

t()

@type t() :: %Mudbrick.TextBlock{
  align: alignment(),
  auto_kern: term(),
  colour: Mudbrick.colour(),
  font: Mudbrick.Font.t(),
  font_size: number(),
  leading: number(),
  lines: list(),
  position: Mudbrick.coords()
}

underline_option()

@type underline_option() :: {:width, number()} | {:colour, Mudbrick.colour()}

underline_options()

@type underline_options() :: [underline_option()]

write()

@type write() :: write_part() | [write_part()]

write_part()

@type write_part() :: String.t() | write_tuple()

write_tuple()

@type write_tuple() :: {String.t(), part_options()}