richtext/dev.mkeeda.arranger.richtext/RichString

RichString

data class RichString(val text: String, val spans: List<RichSpan> = emptyList())

An immutable rich text representation that pairs plain text with type-safe attributes applied to specific character ranges.

All mutating operations return a new RichString instance, preserving the original unchanged.

Constructors

RichString

constructor(text: String, initialAttributes: AttributeContainer)

Creates a new RichString having the given initialAttributes applied to the entire text.

constructor(text: String, spans: List<RichSpan> = emptyList())

Types

Companion

object Companion

Properties

spans

val spans: List<RichSpan>

A list of all RichSpans currently held by this RichString.

text

val text: String

The plain text content.

Functions

edit

fun edit(block: RichStringScope.() -> Unit): RichString

Executes the given block on a RichStringScope scoped to this RichString, and returns a completely new RichString carrying the modifications.

export

fun <T> RichString.export(exporter: RichTextExporter<T>): T

Exports this RichString using the specified exporter.

extractListItems

fun RichString.extractListItems(): List<ListItem>

Extracts a list of semantic ListItems from the given RichString.

runs

fun <T : Any> runs(key: AttributeKey<T>): <Error class: unknown class><RichRun<T>>

Retrieves all contiguous runs of the requested attribute key, merging internally split spans. Adjacent internal spans that possess the EXACT SAME attribute value for key will be combined into a single RichRun, ignoring differences in other attributes.

fun runs(predicate: (AttributeContainer) -> Boolean): <Error class: unknown class><RichRun<AttributeContainer>>

Retrieves all contiguous runs that satisfy the given predicate, merging internally split spans. Adjacent internal spans that satisfy the predicate and possess EXACTLY THE SAME attributes will be combined into a single RichRun.