pdfkmp/com.conamobile.pdfkmp.dsl/TextScope

TextScope

Mutable receiver passed to the text("...") { ... } configuration block.

Every property starts at the value of the inherited TextStyle from the enclosing scope; assigning to a property overrides it for this text only. The block returns a resolved TextStyle via build.

Two convenience flags — bold and italic — are provided for the common case; underneath they delegate to fontWeight and fontStyle.

Properties

align

var align: TextAlign

Horizontal alignment of wrapped lines within the paragraph box.

bold

var bold: Boolean

Convenience flag that toggles between FontWeight.Bold and FontWeight.Normal. Reading this returns true when fontWeight is exactly FontWeight.Bold.

color

var color: PdfColor

Glyph color. Default: inherited.

direction

var direction: TextDirection

Base paragraph direction; Auto detects RTL scripts from content.

font

var font: PdfFont

Resolvable font; defaults to the platform sans-serif unless overridden in a parent scope.

fontSize

var fontSize: Sp

Font size in scale-independent pixels. Default: inherited from the parent scope.

fontStyle

var fontStyle: FontStyle

Italic vs normal. Default: inherited.

fontWeight

var fontWeight: FontWeight

Weight on the 100..900 axis. Default: inherited.

hyphenation

var hyphenation: HyphenationPatterns?

Automatic hyphenation dictionary; null disables it (the default). See com.conamobile.pdfkmp.layout.Hyphenators for bundled languages.

italic

var italic: Boolean

Convenience flag that toggles between FontStyle.Italic and FontStyle.Normal.

kashidaJustify

var kashidaJustify: Boolean

Kashida (tatweel) justification for cursive RTL text. Only effective when the line is justified and resolves to right-to-left. false by default.

letterSpacing

var letterSpacing: Sp

Extra horizontal space inserted between glyphs. Default: inherited.

lineHeight

var lineHeight: Sp

Distance between baselines of consecutive lines. 0.sp means use the font's natural value.

maxLines

var maxLines: Int?

Maximum number of wrapped lines; null keeps them all. Lines beyond the limit are dropped according to overflow.

minLinesAfterBreak

var minLinesAfterBreak: Int

Widow control under the Slice strategy: minimum lines continuing on the next page after a break. 1 allows any split.

minLinesBeforeBreak

var minLinesBeforeBreak: Int

Orphan control under the Slice strategy: minimum lines kept together at the bottom of a page before a break. 1 allows any split.

overflow

var overflow: TextOverflow

What to do with lines dropped by maxLines.

script

var script: TextScript

Superscript / subscript positioning. Only meaningful on spans inside richText { } — plain paragraphs ignore it.

strikethrough

var strikethrough: Boolean

Whether the text is struck through. Defaults to inherited.

underline

var underline: Boolean

Whether the text is underlined. Defaults to inherited.