epub4kmp-core/io.documentnode.epub4kmp.domain/Guide

Guide

class Guide(source)

The guide is a selection of special pages of the book. Examples of these are the cover, list of illustrations, etc.

It is an optional part of an epub, and support for the various types of references varies by reader.

The only part of this that is heavily used is the cover page.

Author

paul

Constructors

constructor()

Types

object Companion

Properties

var coverPage: Resource?

val coverReference: GuideReference?

Functions

fun addReference(reference: GuideReference): ResourceReference

getGuideReferencesByType

fun getGuideReferencesByType(referenceTypeName: String): List<GuideReference>

A list of all GuideReferences that have the given referenceTypeName (ignoring case).

fun getReferences(): List<GuideReference>

setCoverReference

fun setCoverReference(guideReference: GuideReference): Int

fun setReferences(references: MutableList<GuideReference>)