kitepdf-epub/io.github.yuroyami.kitepdf.epub/EpubReadingItem

EpubReadingItem

One stop in a page's reading order: what a screen reader would announce, in the order it would announce it.

for (item in book.readingOrder(page = 3)) {
    when (item.role) {
        EpubRole.HEADING -> speakHeading(item.text, item.headingLevel)
        else -> speak(item.text)
    }
}

Properties

epubType

val epubType: String?

The epub:type the source declared (footnote, noteref, pagebreak, ...), or null. EPUB's own semantic vocabulary, passed through as-is.

headingLevel

val headingLevel: Int

1..6 for a EpubRole.HEADING, 0 for everything else.

role

val role: EpubRole

What this item is.

text

val text: String

The words to announce. Never blank except for an image with no alt.

Functions

toString

open override fun toString(): String