TextDecoration

Defines a horizontal line to be drawn on the text.

TextDecoration

Class

Common
class TextDecoration internal constructor(val mask: Int)

Defines a horizontal line to be drawn on the text.

Functions

operator fun plus(decoration: TextDecoration): TextDecoration

Creates a decoration that includes both of the TextDecorations.

operator fun contains(other: TextDecoration): Boolean

Check whether this TextDecoration contains the given decoration.

Parameters

otherThe TextDecoration to be checked.

Companion Object

Properties

Common
val None: TextDecoration
Common
val Underline: TextDecoration

Draws a horizontal line below the text.

Common
val LineThrough: TextDecoration

Draws a horizontal line over the text.

Methods

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

Creates a decoration that includes all the given decorations.

Parameters

decorationsThe decorations to be added
Common
fun valueOf(mask: Int): TextDecoration

Construct a TextDecoration instance from the underlying TextDecoration.mask. This method will attempt to avoid allocations in cases of well known decorations, but is not guaranteed to not allocate.

Parameters

maskThe integer representation of the TextDecoration.