Android API Reference (Dokka)

The full Kotlin API reference is generated by Dokka from the KDoc source comments.

Generate Locally

cd android
./gradlew :pretext-core:dokkaHtml
open pretext-core/build/dokka/html/index.html

Function	Description
`Pretext.setSegmenter(segmenter)`	Register word segmenter (required)
`Pretext.prepare(text, measurer, options?)`	One-time text analysis + measurement
`Pretext.layout(prepared, maxWidth, lineHeight)`	Pure-arithmetic height computation
`Pretext.prepareWithSegments(text, measurer, options?)`	Rich variant with segment data
`Pretext.layoutWithLines(prepared, maxWidth, lineHeight)`	All lines with text + width
`Pretext.walkLineRanges(prepared, maxWidth, onLine)`	Line widths without text strings
`Pretext.layoutNextLine(prepared, start, maxWidth)`	Variable-width line iterator
`Pretext.clearCache()`	Reset measurement caches
`Pretext.setLocale(locale?)`	Change word segmenter locale

Module	Package	Purpose
`pretext-core`	`com.pretext`	Types, algorithms, public API
`pretext-android`	`com.pretext.android`	`PaintTextMeasurer`, `IcuTextSegmenter`
`pretext-compose`	`com.pretext.compose`	`PretextText` composable