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

TableOfContents

class TableOfContents(tocReferences: MutableList<TOCReference> = mutableListOf())(source)

The table of contents of the book. The TableOfContents is a tree structure at the root it is a list of TOCReferences, each if which may have as children another list of TOCReferences.

The table of contents is used by epub as a quick index to chapters and sections within chapters. It may contain duplicate entries, may decide to point not to certain chapters, etc.

See the spine for the complete list of sections in the order in which they should be read.

Author

paul

See also

Constructors

TableOfContents

constructor(tocReferences: MutableList<TOCReference> = mutableListOf())

Types

object Companion

Properties

allUniqueResources

val allUniqueResources: List<Resource>

Functions

fun addSection(resource: Resource, pathElements: List<String>): TOCReference?

fun addSection(resource: Resource, pathElements: IntArray, sectionTitlePrefix: String, sectionNumberSeparator: String): TOCReference?

Adds the given Resources to the TableOfContents at the location specified by the pathElements.

fun addSection(resource: Resource, path: String, pathSeparator: String = DEFAULT_PATH_SEPARATOR): TOCReference?

Calls addTOCReferenceAtLocation after splitting the path using the DEFAULT_PATH_SEPARATOR.

addTOCReference

fun addTOCReference(tocReference: TOCReference): TOCReference

fun calculateDepth(): Int

The maximum depth of the reference tree

getTocReferences

fun getTocReferences(): List<TOCReference>

setTocReferences

fun setTocReferences(tocReferences: MutableList<TOCReference>)

fun size(): Int

The total number of references in this table of contents.