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

EpubLinkKind

enum class EpubLinkKind : Enum<EpubLinkKind> (source)

What a link is for, read from the link's own markup: its epub:type from the EPUB 3 Structural Semantics Vocabulary, its DPUB-ARIA role, or the rel that EPUB 2 converters write. A reader can open a note in place instead of turning the page. EpubLink.kind carries it.

Entries

LINK

An ordinary link, or one whose markup says nothing more.

NOTE_REFERENCE

A note reference: epub:type="noteref", role="doc-noteref", or rel="footnote".

GLOSSARY_REFERENCE

A glossary reference: epub:type="glossref" or role="doc-glossref".

BIBLIOGRAPHY_REFERENCE

A bibliography reference: epub:type="biblioref" or role="doc-biblioref".

Companion properties

entries

val entries: EnumEntries<EpubLinkKind>

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): EpubLinkKind

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

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