core/com.orange.ouds.core.component.common.text/OudsAnnotatedString/StrikethroughBuilder

StrikethroughBuilder

interface StrikethroughBuilder : OudsAnnotatedString.BaseBuilder

Interface for builders that support strikethrough text annotations.

Implementations can add strikethrough formatting either by specifying ranges with addStrikethrough, or by using the push/pop pattern with pushStrikethrough and pop. For most use cases, prefer using the withStrikethrough DSL helper.

Inheritors

Builder

Functions

addStrikethrough

abstract fun addStrikethrough(start: Int, end: Int)

Adds strikethrough formatting to a specific range of text.

pop

abstract fun pop()

Ends the style or annotation that was added via a push operation before.

abstract fun pop(index: Int)

Ends the styles or annotation up to and including the StrongBuilder.pushStrong or LinkBuilder.pushLink that returned the given index.

pushStrikethrough

abstract fun pushStrikethrough(): Int

Applies strikethrough style to any appended text until a corresponding pop is called.

withStrikethrough

inline fun <R : Any> OudsAnnotatedString.StrikethroughBuilder.withStrikethrough(block: OudsAnnotatedString.StrikethroughBuilder.() -> R): R

DSL helper for applying strikethrough formatting to a block of text.