TextDecoration

value class TextDecoration


Defines a horizontal line to be drawn on the text.

Summary

Public companion functions

TextDecoration
combine(decorations: List<TextDecoration>)

Creates a decoration that includes all the given decorations.

Public companion properties

TextDecoration

Draws a horizontal line over the text.

TextDecoration
TextDecoration

Draws a horizontal line below the text.

Public functions

operator Boolean

Check whether this TextDecoration contains the given decoration.

operator TextDecoration
plus(decoration: TextDecoration)

Creates a decoration that includes both of the TextDecorations.

open String

Public companion functions

combine

Added in 1.0.0
fun combine(decorations: List<TextDecoration>): TextDecoration

Creates a decoration that includes all the given decorations.

Parameters
decorations: List<TextDecoration>

The decorations to be added

Public companion properties

LineThrough

Added in 1.0.0
val LineThroughTextDecoration

Draws a horizontal line over the text.

Note: This will have no effect if used on Wear Tiles.

None

Added in 1.0.0
val NoneTextDecoration

Underline

Added in 1.0.0
val UnderlineTextDecoration

Draws a horizontal line below the text.

Public functions

contains

operator fun contains(other: TextDecoration): Boolean

Check whether this TextDecoration contains the given decoration.

plus

operator fun plus(decoration: TextDecoration): TextDecoration

Creates a decoration that includes both of the TextDecorations.

toString

open fun toString(): String