TextDirection

Class

Common
value class TextDirection internal constructor(val value: Int)

Defines the algorithm to be used while determining the text direction.

Properties

Common
val isSpecified: Boolean

Returns true if this baseline shift is not TextDirection.Unspecified.

Companion Object

Properties

Common
val Ltr = TextDirection(1)

Always sets the text direction to be Left to Right.

Common
val Rtl = TextDirection(2)

Always sets the text direction to be Right to Left.

Common
val Content = TextDirection(3)

This value indicates that the text direction depends on the first strong directional character in the text according to the Unicode Bidirectional Algorithm. If no strong directional character is present, then androidx.compose.ui.unit.LayoutDirection is used to resolve the final TextDirection.

  • if used while creating a Paragraph object, androidx.compose.ui.text.intl.LocaleList will be used to resolve the direction as a fallback instead of androidx.compose.ui.unit.LayoutDirection.
Common
val ContentOrLtr = TextDirection(4)

This value indicates that the text direction depends on the first strong directional character in the text according to the Unicode Bidirectional Algorithm. If no strong directional character is present, then Left to Right will be used as the default direction.

Common
val ContentOrRtl = TextDirection(5)

This value indicates that the text direction depends on the first strong directional character in the text according to the Unicode Bidirectional Algorithm. If no strong directional character is present, then Right to Left will be used as the default direction.

Common
val Unspecified = TextDirection(0)

This represents an unset value, a usual replacement for "null" when a primitive value is desired.

Methods

Common
fun valueOf(value: Int): TextDirection

Creates a TextDirection from the given integer value. This can be useful if you need to serialize/deserialize TextDirection values.

Parameters

valueThe integer representation of the TextDirection.