TextDecoration

Artifact: androidx.compose.ui:ui-text

View Source

Added in 1.0.0

Common/AllAndroid/JVM

• Cmn

  class TextDecoration

---

Defines text decorations such as underline or line-through.

Summary

Public companion functions
TextDecoration	combine(decorations: List<TextDecoration>) Combines multiple TextDecorations into a single decoration.	Cmn
TextDecoration	valueOf(mask: Int) Creates a TextDecoration from a 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) Checks if this decoration contains other.	Cmn
open operator Boolean	equals(other: Any?)	Cmn
open Int	hashCode()	Cmn
operator TextDecoration	plus(decoration: TextDecoration) Combines this decoration with decoration.	Cmn
open String	toString()	Cmn

Public properties
Int	mask bitmask representing the combined decorations.	Cmn

Public companion functions

combine

Cmn

Added in 1.0.0

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

Combines multiple TextDecorations into a single decoration.

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

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

Parameters
decorations: List<TextDecoration>	decorations to combine.

valueOf

Cmn

Added in 1.10.0

fun valueOf(mask: Int): TextDecoration

Creates a TextDecoration from a mask.

Attempts to avoid allocations for well-known decorations.

Parameters
mask: Int	bitmask of the decoration.

Throws
IllegalArgumentException	if mask is invalid.

See also
mask

Public companion properties

LineThrough

Cmn

Added in 1.0.0

val LineThrough: TextDecoration

Draws a horizontal line over the text.

import androidx.compose.material3.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.material3.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

Checks if this decoration contains other.

Parameters
other: TextDecoration	decoration to check.

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

Combines this decoration with decoration.

import androidx.compose.material3.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

bitmask representing the combined decorations.