TextDecoration

Added in 1.0.0

Cmn
```
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.	Cmn
`TextDecoration`	`valueOf(mask: Int)` Construct a TextDecoration instance from the underlying `TextDecoration.mask`.	Cmn

Public companion properties
`TextDecoration`	`LineThrough` Draws a horizontal line over the text.	Cmn
`TextDecoration`	`None`	Cmn
`TextDecoration`	`Underline` Draws a horizontal line below the text.	Cmn

Public functions
`operator Boolean`	`contains(other: TextDecoration)` Check whether this `TextDecoration` contains the given decoration.	Cmn
`open operator Boolean`	`equals(other: Any?)`	Cmn
`open Int`	`hashCode()`	Cmn
`operator TextDecoration`	`plus(decoration: TextDecoration)` Creates a decoration that includes both of the TextDecorations.	Cmn
`open String`	`toString()`	Cmn

Public properties
`Int`	`mask`	Cmn

Public companion functions

combine

Cmn

Added in 1.0.0

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

Creates a decoration that includes all the given decorations.

import androidx.compose.material.Text
import androidx.compose.ui.text.style.TextDecoration

Text(text = "Demo Text", textDecoration = TextDecoration.Underline + TextDecoration.LineThrough)

Parameters
`decorations: List<TextDecoration>`	The decorations to be added

valueOf

Cmn

Added in 1.10.0-alpha01

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.

Public companion properties

LineThrough

Cmn

Added in 1.0.0

val LineThrough: TextDecoration

Draws a horizontal line over the text.

import androidx.compose.material.Text
import androidx.compose.ui.text.style.TextDecoration

Text(text = "Demo Text", textDecoration = TextDecoration.LineThrough)

None

Cmn

Added in 1.0.0

val None: TextDecoration

Underline

Cmn

Added in 1.0.0

val Underline: TextDecoration

Draws a horizontal line below the text.

import androidx.compose.material.Text
import androidx.compose.ui.text.style.TextDecoration

Text(text = "Demo Text", textDecoration = TextDecoration.Underline)

Public functions

contains

Cmn

Added in 1.0.0

operator fun contains(other: TextDecoration): Boolean

Check whether this TextDecoration contains the given decoration.

Parameters
`other: TextDecoration`	The `TextDecoration` to be checked.

equals

Cmn

Added in 1.0.0

open operator fun equals(other: Any?): Boolean

hashCode

Cmn

open fun hashCode(): Int

plus

Cmn

Added in 1.0.0

operator fun plus(decoration: TextDecoration): TextDecoration

Creates a decoration that includes both of the TextDecorations.

import androidx.compose.material.Text
import androidx.compose.ui.text.style.TextDecoration

Text(text = "Demo Text", textDecoration = TextDecoration.Underline + TextDecoration.LineThrough)

toString

Cmn

open fun toString(): String

Public properties

mask

Cmn

Added in 1.0.0

val mask: Int