kitepdf-core/io.github.yuroyami.kitepdf.core/KiteRole

KiteRole

enum class KiteRole : Enum<KiteRole> (source)

What a piece of content is, for a reader that speaks rather than draws. It comes from the structure of the source, not from how the content looks: an EPUB <h2> or a tagged PDF /H2 is a heading whatever its style, and a large bold paragraph is not.

Entries

TEXT

Running text, and anything with no better name.

HEADING

A heading; the depth is in KiteReadingItem.headingLevel.

One item of a list.

A block quotation.

Computer code.

One cell of a table.

The caption of a figure or a table.

IMAGE

An image; the text is its alternative text, empty when it has none.

PAGE_BREAK

The page number of a print edition, not content.

Companion properties

entries

val entries: EnumEntries<KiteRole>

Returns an immutable kotlin.enums.EnumEntries list containing the constants of this enum type, in the order they're declared.

Companion functions

valueOf

fun valueOf(value: String): KiteRole

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<KiteRole>

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

Properties

name

val name: String

ordinal

val ordinal: Int