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

EpubRole

What a piece of content IS, for readers that speak rather than draw. Taken from the source element, so <h2> is a heading whatever CSS does to it and a styled <div> that only looks like one is not.

Entries

TEXT

Running text: <p>, a bare text block, anything with no better name.

HEADING

<h1>..<h6>; the depth is in EpubReadingItem.headingLevel.

One <li>.

<blockquote>.

<pre> or <code>.

<td> / <th>.

<figcaption>.

An image; the text is its alt (or aria-label), empty when it has none.

PAGE_BREAK

epub:type="pagebreak": the print edition's page number, not content.

Properties

entries

val entries: EnumEntries<EpubRole>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

name

expect val name: String

ordinal

expect val ordinal: Int

Functions

valueOf

fun valueOf(value: String): EpubRole

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

values

fun values(): Array<EpubRole>

Returns an array containing the constants of this enum type, in the order they're declared.