printing/com.zachklipp.richtext.ui.printing

Package-level declarations

Types

class ComposePrintAdapter(activity: ComponentActivity, documentName: String, pageModifier: Modifier = Modifier, pageDpi: Int = DefaultPageDpi, printBreakpoints: Boolean = false, mainContext: CoroutineContext = Dispatchers.Main, ioDispatcher: CoroutineDispatcher = Dispatchers.IO, content: @Composable () -> Unit) : CoroutinePrintDocumentAdapter

A PrintDocumentAdapter that prints a composable function. The composable content is paginated as best-effort to avoid cutting off composables in the middle (see Paged).

CoroutinePrintDocumentAdapter

abstract class CoroutinePrintDocumentAdapter(context: CoroutineContext) : PrintDocumentAdapter

A PrintDocumentAdapter that exposes onLayout and onWrite functions as suspend functions that will automatically invoke the correct callback methods.

PageBreakpoint

@Immutable

data class PageBreakpoint(val xAnchorPx: Pair<Int, Int>, val yPx: Int, val forceBreak: Boolean)

Represents a point in a composition where it is safe to break the page.

PageLayoutResult

@Immutable

interface PageLayoutResult

After the first frame of a Paged is committed, the breakpoints and page offsets are calculated and passed to a callback via an instance of this interface.

PrintableController

abstract class PrintableController

Provides the print method to trigger printing Printable composables. Create one by calling rememberPrintableController.

Functions

hideWhenPrinting

fun Modifier.hideWhenPrinting(): Modifier

Returns a Modifier that will hide the composable it's applied to when printing.

keepOnPageWithNext

fun Modifier.keepOnPageWithNext(): Modifier

Returns a Modifier that will prevent Paged from putting a page break between this composable and the next.

Paged

@Composable

fun Paged(modifier: Modifier = Modifier, pageIndex: Int = 0, pageModifier: Modifier = Modifier, clipLastBreakpoint: Boolean = true, drawBreakpoints: Boolean = false, onPageLayout: (pageCount: Int) -> Unit? = null, content: @Composable () -> Unit)

Divides a composable into discreet pages. The content is measured with unbounded height, and then displayed using the current constraints, starting at pageIndex (the content is translated up). The bottom of the content is clipped, but a best-effort attempt is made to not cut any individual composables off in the middle. When the initial "pagination" measurement is complete, onPageLayout is invoked with the total page count.

Printable

@Composable

fun Printable(controller: PrintableController, modifier: Modifier = Modifier, pageDpi: Int = DefaultPageDpi, printBreakpoints: Boolean = false, content: @Composable () -> Unit)

Renders content as-is, and will allow the content to be printed with PrintableController. To start a print job, call PrintableController.print.

rememberPrintableController

@Composable

fun rememberPrintableController(): PrintableController

Creates and remembers a PrintableController that can be passed to Printable to start print jobs.

responsivePadding

fun Modifier.responsivePadding(vararg minDimensionsToPadding: Pair<Dp, Dp>): Modifier

A Modifier that adds different padding depending on the minimum dimension of the max constraints.

Properties

DefaultPageDpi

const val DefaultPageDpi: Int = 100

isBeingPrinted

@get:Composable

val isBeingPrinted: Boolean

Returns true if a Printable is being used to print the composition somewhere up in the tree.