epub4kmp-core/io.documentnode.epub4kmp.browsersupport/NavigationHistory

NavigationHistory

class NavigationHistory(navigator: Navigator) : NavigationEventListener(source)

A history of the user's locations with the epub.

Author

paul.siegmann

Constructors

NavigationHistory

constructor(navigator: Navigator)

Types

object Companion

class Location(var href: String)

Properties

val currentHref: String?

var currentPos: Int

var currentSize: Int

historyWaitTime

var historyWaitTime: Long

If the time between a navigation event is less than the historyWaitTime then the new location is not added to the history.

var maxHistorySize: Int

Functions

fun addLocation(location: NavigationHistory.Location)

Adds the location after the current position. If the currentposition is not the end of the list then the elements between the current element and the end of the list will be discarded.

fun addLocation(resource: Resource)

fun addLocation(href: String)

fun initBook(book: Book)

fun move(delta: Int): Boolean

Moves the current positions delta positions.

navigationPerformed

open override fun navigationPerformed(navigationEvent: NavigationEvent)

If this is not the source of the navigationEvent then the addLocation will be called with the href of the currentResource in the navigationEvent.