KaRendererBuilder¶

@SubclassOptInRequired(markerClass = [KaImplementationDetail::class])
interface KaRendererBuilder

A mutable builder for customizing a KaRenderer, available within KaRenderer.copy.

Functions¶

abstract fun <T> get(option: KaRenderingOption<T>): T

Returns the current effective value of option.

abstract fun <T> push(renderer: KaPieceRenderer<T>)

Pushes renderer on top of the stack for its KaPieceRenderer.piece, so it takes precedence over the renderers below it.

fun <T> KaRendererBuilder.push(piece: KaPiece<T>, block: context(KaSession, KaRenderingContext, KaRenderingOutput) (value: T) -> Unit)

Pushes a simple, always-consuming KaPieceRenderer for the given piece, which is created using the provided rendering block.

fun <T> KaRendererBuilder.pushEmpty(piece: KaPiece<T>)

Pushes a no-op, always-consuming KaPieceRenderer for the given piece.

inline fun <T> KaRendererBuilder.reset(option: KaRenderingOption<T>, provider: (T) -> T)

Resets the option to a value returned from the provider using the previous effective value.

abstract fun <T> set(option: KaRenderingOption<T>, value: T)

Overrides the value of option.

abstract fun <T> unset(option: KaRenderingOption<T>)