TextDecoration

public class TextDecoration internal constructor(public val mask: Int)

Defines text decorations such as underline or line-through.

Functions

plus

public operator fun plus(decoration: TextDecoration): TextDecoration

Combines this decoration with decoration.

contains

public operator fun contains(other: TextDecoration): Boolean

Checks if this decoration contains other.

Parameters

Members

Companion

public companion object

Properties

None

@Stable public val None: TextDecoration = TextDecoration(0x0)

Underline

@Stable public val Underline: TextDecoration = TextDecoration(0x1)

Draws a horizontal line below the text.

LineThrough

@Stable public val LineThrough: TextDecoration = TextDecoration(0x2)

Draws a horizontal line over the text.

Functions

combine

public fun combine(decorations: List<TextDecoration>): TextDecoration

Combines multiple TextDecorations into a single decoration.

Parameters

valueOf

public fun valueOf(mask: Int): TextDecoration

Creates a TextDecoration from a mask.

Attempts to avoid allocations for well-known decorations.

Parameters

Throws: IllegalArgumentException

if mask is invalid.